edu.utexas.its.eis.tools.qwicap.servlet
Interface Auth2SchemeFactory


public interface Auth2SchemeFactory

Classes that implement this interface provide Qwicap with instances of Auth2Scheme, which supply authentication & authorization (Auth2) functionality. An authentication & authorization scheme is associated with a Qwicap web application by an entry in its "web.xml" file, for example:

<web-app>
    ....
    <servlet>
        ....
        <init-param>
            <param-name>QwicapAuth2SchemeFactoryClassName</param-name>
            <param-value>edu.utexas.its.eis.tools.fatcookie.qwicap.FatCookieAuth2SchemeFactory</param-value>
        </init-param>
        ....
    </servlet>
    ....
</web-app>

In other words, include within the "servlet" element an "init-param" element containing a "param-name" element of "QwicapAuth2SchemeFactoryClassName" and a "param-value" element that specifies the fully-qualified name of the class that implements the Auth2SchemeFactory interface.

If the web application doesn't need to acquire any information about the user from its associated Auth2Scheme, then that's all there is to it; the web app doesn't even need to know that it has an Auth2Scheme.

Author:
Chris W. Johnson
See Also:
Auth2Scheme, Auth2SchemeReply

Method Summary
 Auth2Scheme getAuth2SchemeInstance()
          Invoked whenever Qwicap needs an Auth2Scheme instance in order to authenticate & authorize (auth2) a client request.
 

Method Detail

getAuth2SchemeInstance

Auth2Scheme getAuth2SchemeInstance()
                                   throws Exception
Invoked whenever Qwicap needs an Auth2Scheme instance in order to authenticate & authorize (auth2) a client request.

Returns:
An Auth2Scheme instance.
Throws:
Exception