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

java.lang.Object
  extended by org.jboss.security.auth.container.modules.AbstractServerAuthModule
All Implemented Interfaces:
javax.security.auth.message.module.ServerAuthModule, javax.security.auth.message.ServerAuth
Direct Known Subclasses:
AllFailureServerAuthModule, AllSuccessServerAuthModule, DelegatingServerAuthModule, SimpleServerAuthModule

public abstract class AbstractServerAuthModule
extends Object
implements javax.security.auth.message.module.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: 86122 $
Author:
Anil Saldhana

Field Summary
protected  CallbackHandler callbackHandler
          Call back handler
protected  org.jboss.logging.Logger log
           
protected  Map options
           
protected  javax.security.auth.message.MessagePolicy requestPolicy
           
protected  javax.security.auth.message.MessagePolicy responsePolicy
           
protected  ArrayList<Class> supportedTypes
           
 
Constructor Summary
AbstractServerAuthModule()
           
 
Method Summary
 void cleanSubject(javax.security.auth.message.MessageInfo messageInfo, Subject subject)
           
 CallbackHandler getCallbackHandler()
           
 Class[] getSupportedMessageTypes()
           
 void initialize(javax.security.auth.message.MessagePolicy requestPolicy, javax.security.auth.message.MessagePolicy responsePolicy, CallbackHandler handler, Map options)
           
 void setCallbackHandler(CallbackHandler callbackHandler)
           
protected abstract  boolean validate(Subject clientSubject, javax.security.auth.message.MessageInfo messageInfo)
          Subclasses have to implement this method to actually validate the subject
 javax.security.auth.message.AuthStatus validateRequest(javax.security.auth.message.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 javax.security.auth.message.MessagePolicy requestPolicy

responsePolicy

protected javax.security.auth.message.MessagePolicy responsePolicy

options

protected Map options

supportedTypes

protected ArrayList<Class> supportedTypes

log

protected org.jboss.logging.Logger log
Constructor Detail

AbstractServerAuthModule

public AbstractServerAuthModule()
Method Detail

initialize

public void initialize(javax.security.auth.message.MessagePolicy requestPolicy,
                       javax.security.auth.message.MessagePolicy responsePolicy,
                       CallbackHandler handler,
                       Map options)
                throws javax.security.auth.message.AuthException
Specified by:
initialize in interface javax.security.auth.message.module.ServerAuthModule
Throws:
javax.security.auth.message.AuthException
See Also:
ServerAuthModule#initialize(MessagePolicy, MessagePolicy, CallbackHandler, Map, boolean)

cleanSubject

public void cleanSubject(javax.security.auth.message.MessageInfo messageInfo,
                         Subject subject)
                  throws javax.security.auth.message.AuthException
Specified by:
cleanSubject in interface javax.security.auth.message.ServerAuth
Throws:
javax.security.auth.message.AuthException

validateRequest

public javax.security.auth.message.AuthStatus validateRequest(javax.security.auth.message.MessageInfo messageInfo,
                                                              Subject clientSubject,
                                                              Subject serviceSubject)
                                                       throws javax.security.auth.message.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 javax.security.auth.message.ServerAuth
Throws:
javax.security.auth.message.AuthException

getSupportedMessageTypes

public Class[] getSupportedMessageTypes()
Specified by:
getSupportedMessageTypes in interface javax.security.auth.message.module.ServerAuthModule
See Also:
ServerAuthModule.getSupportedMessageTypes()

getCallbackHandler

public CallbackHandler getCallbackHandler()

setCallbackHandler

public void setCallbackHandler(CallbackHandler callbackHandler)

validate

protected abstract boolean validate(Subject clientSubject,
                                    javax.security.auth.message.MessageInfo messageInfo)
                             throws javax.security.auth.message.AuthException
Subclasses have to implement this method to actually validate the subject

Returns:
Throws:
javax.security.auth.message.AuthException


Copyright © 2009 JBoss Inc.. All Rights Reserved.