org.jboss.security.auth.container.modules

Class HttpServletServerAuthModule

java.lang.Object

org.jboss.security.auth.container.modules.AbstractServerAuthModule

org.jboss.security.auth.container.modules.DelegatingServerAuthModule

org.jboss.security.auth.container.modules.HttpServletServerAuthModule

All Implemented Interfaces:

ServerAuthModule, ServerAuth

public class HttpServletServerAuthModule
extends DelegatingServerAuthModule

Server Auth Module capable of handling Http Servlet Authentication

Since:

Jul 30, 2007

Version:

$Revision$

Author:

Anil.Saldhana@redhat.com

Field Summary

Fields inherited from class org.jboss.security.auth.container.modules.AbstractServerAuthModule

callbackHandler, options, requestPolicy, responsePolicy, supportedTypes

Constructor Summary

Constructors

Constructor and Description
HttpServletServerAuthModule()
HttpServletServerAuthModule(String lmshName)

Method Summary

Modifier and Type	Method and Description
AuthStatus	secureResponse(MessageInfo arg0, Subject arg1) Secure a service response before sending it to the client.
protected boolean	validate(Subject clientSubject, MessageInfo messageInfo) Subclasses have to implement this method to actually validate the subject

Methods inherited from class org.jboss.security.auth.container.modules.DelegatingServerAuthModule

cleanSubject, getSupportedMessageTypes

Methods inherited from class org.jboss.security.auth.container.modules.AbstractServerAuthModule

getCallbackHandler, initialize, setCallbackHandler, validateRequest

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpServletServerAuthModule

public HttpServletServerAuthModule()

HttpServletServerAuthModule

public HttpServletServerAuthModule(String lmshName)

Method Detail

validate

protected boolean validate(Subject clientSubject,
                           MessageInfo messageInfo)
                    throws AuthException

Description copied from class: AbstractServerAuthModule

Subclasses have to implement this method to actually validate the subject

Overrides:

validate in class DelegatingServerAuthModule

Returns:

Throws:

AuthException

secureResponse

public AuthStatus secureResponse(MessageInfo arg0,
                                 Subject arg1)
                          throws AuthException

Description copied from interface: ServerAuth

Secure a service response before sending it to the client. This method is called to transform the response message acquired by calling getResponseMessage (on messageInfo) into the mechanism-specific form to be sent by the runtime.

This method conveys the outcome of its message processing either by returning an AuthStatus value or by throwing an AuthException.

Specified by:

secureResponse in interface ServerAuth

Overrides:

secureResponse in class DelegatingServerAuthModule

Parameters:

arg0 - A contextual object that encapsulates the client request and server response objects, and that may be used to save state across a sequence of calls made to the methods of this interface for the purpose of completing a secure message exchange.

arg1 - A Subject that represents the source of the service response, or null. It may be used by the method implementation to retrieve Principals and credentials necessary to secure the response. If the Subject is not null, the method implementation may add additional Principals or credentials (pertaining to the source of the service response) to the Subject.

Returns:

An AuthStatus object representing the completion status of the processing performed by the method. The AuthStatus values that may be returned by this method are defined as follows:

• AuthStatus.SEND_SUCCESS when the application response message was successfully secured. The secured response message may be obtained by calling getResponseMessage on messageInfo.
• AuthStatus.SEND_CONTINUE to indicate that the application response message (within messageInfo) was replaced with a security message that should elicit a security-specific response (in the form of a request) from the peer. This status value serves to inform the calling runtime that (to successfully complete the message exchange) it will need to be capable of continuing the message dialog by processing at least one additional request/response exchange (after having sent the response message returned in messageInfo). When this status value is returned, the application response must be saved by the authentication module such that it can be recovered when the module's validateRequest message is called to process the elicited response.
• AuthStatus.SEND_FAILURE to indicate that a failure occurred while securing the response message and that an appropriate failure response message is available by calling getResponseMeessage on messageInfo.

Throws:

AuthException - When the message processing failed without establishing a failure response message (in messageInfo).