|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Auth2Scheme
Classes that implement this interface provide Qwicap with its authentication & authorization
(Auth2) functionality. Every hit is passed to the
qwicapAuth2SchemeHit
method for approval. Approved hits are passed along to your
Qwicap web application, while unapproved hits do nothing. Implementations will probably want to indicate
disapproval to users by one of the following means:
HttpServletResponse.SC_UNAUTHORIZED
), and an
informative error message, by using the HttpServletResponse.sendError(int, String)
method.
PrintWriter
, or
ServletOutputStream
, object available from the methods ServletResponse.getWriter()
and ServletResponse.getOutputStream()
, respectively. The HTTP connection is all yours in this
case, so don't forget to begin by invoking ServletResponse.setContentType(String)
to identify the
MIME type of the content that you will be
transmitting to the client.
HttpServletResponse.sendRedirect(String)
method. Note that if those static pages are part of this web application, then the
Auth2SchemeReply.qwicapCanSendStaticFiles()
method must return true
, or Qwicap will refuse
the user access to those pages.
Instances of Auth2Scheme
are provided to Qwicap by an instance of a class implementing the
Auth2SchemeFactory
interface. Qwicap discovers that factory class through an entry in the web application
deployment descriptor ("web.xml" file). See the Auth2SchemeFactory
documentation for complete details.
Auth2SchemeFactory
,
Auth2SchemeReply
Method Summary | |
---|---|
Auth2SchemeReply |
qwicapAuth2SchemeHit(Servlet Serv,
HttpServletRequest Req,
HttpServletResponse Resp,
FormDataSet FDS)
Implements an authentication & authorization scheme that determines how Qwicap will respond to each hit. |
boolean |
qwicapShouldRetainThisAuth2SchemeInstance()
Returns true to inform the servlet that this Auth2Scheme instance should be retained as
part of the current user's session state, and should be used to evaluate the next hit received from this user. |
Method Detail |
---|
Auth2SchemeReply qwicapAuth2SchemeHit(Servlet Serv, HttpServletRequest Req, HttpServletResponse Resp, FormDataSet FDS) throws Exception
Serv
- The active servlet.Req
- The current request.Resp
- The current response.FDS
- The FormDataSet
instance describing the form data set, or URI attributes, that were
sent with, or otherwise associated with, the latest hit. Note: Modification of the contents of
this FormDataSet
instance is possible, but strongly discouraged, because, in
general, a FormDataSetFilter
should be used for that purpose.
Auth2SchemeReply
interface.
Exception
- Thrown if anything goes wrong. The hit is discarded in such cases.boolean qwicapShouldRetainThisAuth2SchemeInstance()
true
to inform the servlet that this Auth2Scheme
instance should be retained as
part of the current user's session state, and should be used to evaluate the next hit received from this user.
Returns false
to indicate that this Auth2Scheme
instance should be discarded, in which
case a new instance will be created to evaluate the next hit.
true
, if this instance should be stored and reused by this session, false
if it
should be discarded.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |