org.jboss.as.web.security.jaspi.modules

Class WebServerAuthModule

java.lang.Object

org.jboss.as.web.security.jaspi.modules.WebServerAuthModule

All Implemented Interfaces:

javax.security.auth.message.module.ServerAuthModule, javax.security.auth.message.ServerAuth

Direct Known Subclasses:

HTTPBasicServerAuthModule, HTTPClientCertServerAuthModule, HTTPFormServerAuthModule

public abstract class WebServerAuthModule
extends Object
implements javax.security.auth.message.module.ServerAuthModule

Base class for JBoss Web JSR-196 ServerAuthModules.

Author:

Anil Saldhana, Stefan Guilhen

Field Summary

Fields

Modifier and Type	Field and Description
protected CallbackHandler	callbackHandler
protected Map	options

Constructor Summary

Constructors

Constructor and Description
WebServerAuthModule()

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanSubject(javax.security.auth.message.MessageInfo messageInfo, Subject subject)
Class[]	getSupportedMessageTypes()
void	initialize(javax.security.auth.message.MessagePolicy requestPolicy, javax.security.auth.message.MessagePolicy responsePolicy, CallbackHandler handler, Map options)
protected void	registerWithCallbackHandler(Principal userPrincipal, String username, String password) Register the obtained security attributes with the CallbackHandler.
abstract javax.security.auth.message.AuthStatus	secureResponse(javax.security.auth.message.MessageInfo messageInfo, Subject serviceSubject)
abstract javax.security.auth.message.AuthStatus	validateRequest(javax.security.auth.message.MessageInfo messageInfo, Subject clientSubject, Subject serviceSubject)

Methods inherited from class java.lang.Object

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

Field Detail

callbackHandler

protected CallbackHandler callbackHandler

options

protected Map options

Constructor Detail

WebServerAuthModule

public WebServerAuthModule()

Method Detail

getSupportedMessageTypes

public Class[] getSupportedMessageTypes()

Specified by:

getSupportedMessageTypes in interface javax.security.auth.message.module.ServerAuthModule

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

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

secureResponse

public abstract javax.security.auth.message.AuthStatus secureResponse(javax.security.auth.message.MessageInfo messageInfo,
                                                    Subject serviceSubject)
                                                               throws javax.security.auth.message.AuthException

Specified by:

secureResponse in interface javax.security.auth.message.ServerAuth

Throws:

javax.security.auth.message.AuthException

validateRequest

public abstract javax.security.auth.message.AuthStatus validateRequest(javax.security.auth.message.MessageInfo messageInfo,
                                                     Subject clientSubject,
                                                     Subject serviceSubject)
                                                                throws javax.security.auth.message.AuthException

Specified by:

validateRequest in interface javax.security.auth.message.ServerAuth

Throws:

javax.security.auth.message.AuthException

registerWithCallbackHandler

protected void registerWithCallbackHandler(Principal userPrincipal,
                               String username,
                               String password)

Register the obtained security attributes with the CallbackHandler.

Parameters:

userPrincipal - the user principal.

username - a String representing the username.

password - a String representing the password.