org.nuxeo.ecm.platform.login

Class NuxeoAbstractServerLoginModule

java.lang.Object

org.nuxeo.ecm.platform.login.NuxeoAbstractServerLoginModule

All Implemented Interfaces:

LoginModule

Direct Known Subclasses:

NuxeoLoginModule

public abstract class NuxeoAbstractServerLoginModule
extends Object
implements LoginModule

Abstract implementation of the LoginModule SPI from javax.security.auth.spi.

Field Summary

Fields

Modifier and Type	Field and Description
protected CallbackHandler	callbackHandler
protected boolean	loginOk
protected Map	options
protected String	principalClassName An optional custom Principal class implementation
protected Map	sharedState
protected Subject	subject
protected Principal	unauthenticatedIdentity the principal to use when a null username and password are seen
protected boolean	useFirstPass Flag indicating if the shared credential should be used

Constructor Summary

Constructors

Constructor and Description
NuxeoAbstractServerLoginModule()

Method Summary

Modifier and Type	Method and Description
boolean	abort()
boolean	commit()
protected Group	createGroup(String name, Set<Principal> principals) Finds or creates a Group with the given name.
protected abstract Principal	createIdentity(String username)
protected abstract Principal	getIdentity()
protected abstract Group[]	getRoleSets()
void	initialize(Subject subject, CallbackHandler callbackHandler, Map<String,?> sharedState, Map<String,?> options)
boolean	logout()

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.spi.LoginModule

login

Field Detail

subject

protected Subject subject

sharedState

protected Map sharedState

options

protected Map options

loginOk

protected boolean loginOk

principalClassName

protected String principalClassName

An optional custom Principal class implementation

unauthenticatedIdentity

protected Principal unauthenticatedIdentity

the principal to use when a null username and password are seen

callbackHandler

protected CallbackHandler callbackHandler

useFirstPass

protected boolean useFirstPass

Flag indicating if the shared credential should be used

Constructor Detail

NuxeoAbstractServerLoginModule

public NuxeoAbstractServerLoginModule()

Method Detail

getIdentity

protected abstract Principal getIdentity()

getRoleSets

protected abstract Group[] getRoleSets()
                                throws LoginException

Throws:

LoginException

createIdentity

protected abstract Principal createIdentity(String username)
                                     throws LoginException

Throws:

LoginException

abort

public boolean abort()
              throws LoginException

Specified by:

abort in interface LoginModule

Throws:

LoginException

commit

public boolean commit()
               throws LoginException

Specified by:

commit in interface LoginModule

Throws:

LoginException

initialize

public void initialize(Subject subject,
                       CallbackHandler callbackHandler,
                       Map<String,?> sharedState,
                       Map<String,?> options)

Specified by:

initialize in interface LoginModule

logout

public boolean logout()
               throws LoginException

Specified by:

logout in interface LoginModule

Throws:

LoginException

createGroup

protected Group createGroup(String name,
                            Set<Principal> principals)

Finds or creates a Group with the given name. Subclasses should use this method to locate the 'Roles' group or create additional types of groups.

Returns:

A named Group from the principals set.