org.jboss.security.auth.container.modules

Class SimpleServerAuthModule

java.lang.Object

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

org.jboss.security.auth.container.modules.SimpleServerAuthModule

All Implemented Interfaces:

ServerAuthModule, ServerAuth

public class SimpleServerAuthModule
extends AbstractServerAuthModule

A simple implementation of an username/password based server auth module. The principal name and password are passed as options to the module.

Since:

Dec 6, 2005

Author:

Anil Saldhana

Field Summary

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

callbackHandler, options, requestPolicy, responsePolicy, supportedTypes

Constructor Summary

Constructors

Constructor and Description
SimpleServerAuthModule()
SimpleServerAuthModule(Class<?>[] supTypes)

Method Summary

Methods

Modifier and Type	Method and Description
AuthStatus	secureResponse(MessageInfo param, Subject source) Secure a service request message before sending it to the service.
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.AbstractServerAuthModule

cleanSubject, getCallbackHandler, getSupportedMessageTypes, initialize, setCallbackHandler, validateRequest

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleServerAuthModule

public SimpleServerAuthModule()

SimpleServerAuthModule

public SimpleServerAuthModule(Class<?>[] supTypes)

Method Detail

secureResponse

public AuthStatus secureResponse(MessageInfo param,
                        Subject source)
                          throws AuthException

Description copied from interface: ServerAuth

Secure a service request message before sending it to the service.

Sign and encrpt the service request, for example.

Parameters:

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

source - - A Subject that represents the source 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 secure the request. If the Subject is not null, the method implementation may add additional Principals or credentials (pertaining to the source of the service request) to the Subject.

Returns:

an AuthStatus object representing the completion status of the processing performed by the module.

• AuthStatus.PROCEED returned when the application request message was successfully secured. The runtime may proceed to send the request message. returned in AuthParam.
• AuthStatus.RETRY returned when the module replaces the application request message with an mechanism specific message to be sent in advance of the application message. The runtime should throw an exception if it is unable to process the rety. Otherwise, the runtime should send the request message returned in AuthParam (and without calling secureRequest).
• AuthStatus.ERROR returned when the processing by the module failed and indicates that the module has defined an appropriate error request message in the AuthParam. The runtime may send the request message returned in AuthParam (without calling SecureRequest), and must discontinue its processing of the application request.

Throws:

AuthException - when the module wishes to signal a failure in securing the request and without establishing a corresponding error request message. The runtime must discontinue its processing of the message exchange.

See Also:

ServerAuth.secureResponse(javax.security.auth.message.MessageInfo, javax.security.auth.Subject)

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

Specified by:

validate in class AbstractServerAuthModule

Returns:

Throws:

AuthException