org.nuxeo.ecm.core.api.local

Class ClientLoginModule

java.lang.Object

org.nuxeo.ecm.core.api.local.ClientLoginModule

All Implemented Interfaces:

LoginModule

public class ClientLoginModule
extends Object
implements LoginModule

A login module that is propagating the login information into the core login stack.

This login module doesn't make any authentication - it is called only after the authentication is successfully done by a previous login module.

The static method of this class can also be used to manage the current login stack.

Author:

[email protected]

Field Summary

Fields

Modifier and Type	Field and Description
protected static LoginStack	globalInstance The global login stack
protected static ThreadLocal<LoginStack>	threadInstance The thread local login stack - for per thread logins

Constructor Summary

Constructors

Constructor and Description
ClientLoginModule()

Method Summary

Modifier and Type	Method and Description
boolean	abort()
static void	clearThreadLocalLogin()
boolean	commit()
static LoginStack.Entry	getCurrentLogin()
static NuxeoPrincipal	getCurrentPrincipal() Returns the current logged NuxeoPrincipal from the login stack
static LoginStack	getThreadLocalLogin()
void	initialize(Subject subject, CallbackHandler callbackHandler, Map sharedState, Map options) Initialize this LoginModule.
boolean	login()
boolean	logout()

Methods inherited from class java.lang.Object

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

Field Detail

globalInstance

protected static final LoginStack globalInstance

The global login stack

threadInstance

protected static final ThreadLocal<LoginStack> threadInstance

The thread local login stack - for per thread logins

Constructor Detail

ClientLoginModule

public ClientLoginModule()

Method Detail

clearThreadLocalLogin

public static void clearThreadLocalLogin()

Since:

5.7

getThreadLocalLogin

public static LoginStack getThreadLocalLogin()

getCurrentLogin

public static LoginStack.Entry getCurrentLogin()

getCurrentPrincipal

public static NuxeoPrincipal getCurrentPrincipal()

Returns the current logged NuxeoPrincipal from the login stack

Since:

5.6

initialize

public void initialize(Subject subject,
                       CallbackHandler callbackHandler,
                       Map sharedState,
                       Map options)

Initialize this LoginModule.

Specified by:

initialize in interface LoginModule

login

public boolean login()
              throws LoginException

Specified by:

login in interface LoginModule

Throws:

LoginException

commit

public boolean commit()
               throws LoginException

Specified by:

commit in interface LoginModule

Throws:

LoginException

abort

public boolean abort()
              throws LoginException

Specified by:

abort in interface LoginModule

Throws:

LoginException

logout

public boolean logout()
               throws LoginException

Specified by:

logout in interface LoginModule

Throws:

LoginException