org.jboss.security.auth.container.modules

Class AbstractServerAuthModule

java.lang.Object

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

All Implemented Interfaces:

ServerAuthModule, ServerAuth

Direct Known Subclasses:

AllFailureServerAuthModule, AllSuccessServerAuthModule, DelegatingServerAuthModule, SimpleServerAuthModule, UsernameTokenServerAuthModule

public abstract class AbstractServerAuthModule
extends Object
implements ServerAuthModule

Superclass of all ServerAuthModules Can be a container for common functionality and custom methods

The ServerAuthModule can delegate to a login module passed via the module option "login-module-delegate"

Since:

Jan 9, 2006

Version:

$Revision$

Author:

Anil Saldhana

Field Summary

Fields

Modifier and Type	Field and Description
protected CallbackHandler	callbackHandler Call back handler
protected Map	options
protected MessagePolicy	requestPolicy
protected MessagePolicy	responsePolicy
protected ArrayList<Class>	supportedTypes

Constructor Summary

Constructors

Constructor and Description
AbstractServerAuthModule()

Method Summary

Modifier and Type	Method and Description
void	cleanSubject(MessageInfo messageInfo, Subject subject) Remove method specific principals and credentials from the subject.
CallbackHandler	getCallbackHandler()
Class[]	getSupportedMessageTypes() Get the one or more Class objects representing the message types supported by the module.
void	initialize(MessagePolicy requestPolicy, MessagePolicy responsePolicy, CallbackHandler handler, Map options) Initialize this module with request and response message policies to enforce, a CallbackHandler, and any module-specific configuration properties.
void	setCallbackHandler(CallbackHandler callbackHandler)
protected abstract boolean	validate(Subject clientSubject, MessageInfo messageInfo) Subclasses have to implement this method to actually validate the subject
AuthStatus	validateRequest(MessageInfo messageInfo, Subject clientSubject, Subject serviceSubject) This method delegates to a login module if configured in the module options.

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.security.auth.message.ServerAuth

secureResponse

Field Detail

callbackHandler

protected CallbackHandler callbackHandler

Call back handler

requestPolicy

protected MessagePolicy requestPolicy

responsePolicy

protected MessagePolicy responsePolicy

options

protected Map options

supportedTypes

protected ArrayList<Class> supportedTypes

Constructor Detail

AbstractServerAuthModule

public AbstractServerAuthModule()

Method Detail

initialize

public void initialize(MessagePolicy requestPolicy,
                       MessagePolicy responsePolicy,
                       CallbackHandler handler,
                       Map options)
                throws AuthException

Description copied from interface: ServerAuthModule

Initialize this module with request and response message policies to enforce, a CallbackHandler, and any module-specific configuration properties.

The request policy and the response policy must not both be null.

Specified by:

initialize in interface ServerAuthModule

Parameters:

requestPolicy - The request policy this module must enforce, or null.

responsePolicy - The response policy this module must enforce, or null.

handler - CallbackHandler used to request information.

options - A Map of module-specific configuration properties.

Throws:

AuthException - - If module initialization fails, including for the case where the options argument contains elements that are not supported by the module.

See Also:

ServerAuthModule.initialize(javax.security.auth.message.MessagePolicy, javax.security.auth.message.MessagePolicy, javax.security.auth.callback.CallbackHandler, java.util.Map)

cleanSubject

public void cleanSubject(MessageInfo messageInfo,
                         Subject subject)
                  throws AuthException

Description copied from interface: ServerAuth

Remove method specific principals and credentials from the subject.

Specified by:

cleanSubject in interface ServerAuth

Parameters:

messageInfo - - 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.

subject - - The Subject instance from which the Principals and credentials are to be removed.

Throws:

AuthException - if an error occurs during the Subject processing.

validateRequest

public AuthStatus validateRequest(MessageInfo messageInfo,
                                  Subject clientSubject,
                                  Subject serviceSubject)
                           throws AuthException

This method delegates to a login module if configured in the module options. The sub classes will need to validate the request

Specified by:

validateRequest in interface ServerAuth

Parameters:

messageInfo - - 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.

clientSubject - - A Subject that represents the source of the service request. It is used by the method implementation to store Principals and credentials validated in the request.

serviceSubject - - A Subject that represents the recipient of the service request, or null. It may be used by the method implementation as the source of Principals or credentials to be used to validate the request. If the Subject is not null, the method implementation may add additional Principals or credentials (pertaining to the recipient of the service request) 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.SUCCESS when the application request message was successfully validated. The validated request message is available by calling getRequestMessage on messageInfo.
• AuthStatus.SEND_SUCCESS to indicate that validation/processing of the request message successfully produced the secured application response message (in messageInfo). The secured response message is available by calling getResponseMessage on messageInfo.
• AuthStatus.SEND_CONTINUE to indicate that message validation is incomplete, and that a preliminary response was returned as the response message in messageInfo. When this status value is returned to challenge an application request message, the challenged request must be saved by the authentication module such that it can be recovered when the module’s validateRequest message is called to process the request returned for the challenge.
• AuthStatus.SEND_FAILURE to indicate that message validation failed and that an appropriate failure response message is available by calling getResponseMessage on messageInfo.

Throws:

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

getSupportedMessageTypes

public Class[] getSupportedMessageTypes()

Description copied from interface: ServerAuthModule

Get the one or more Class objects representing the message types supported by the module.

Specified by:

getSupportedMessageTypes in interface ServerAuthModule

Returns:

An array of Class objects, with at least one element defining a message type supported by the module.

See Also:

ServerAuthModule.getSupportedMessageTypes()

getCallbackHandler

public CallbackHandler getCallbackHandler()

setCallbackHandler

public void setCallbackHandler(CallbackHandler callbackHandler)

validate

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

Subclasses have to implement this method to actually validate the subject

Returns:

Throws:

AuthException