org.apache.jackrabbit.oak.spi.security.authentication.external.impl

Class ExternalLoginModule

java.lang.Object

org.apache.jackrabbit.oak.spi.security.authentication.AbstractLoginModule

org.apache.jackrabbit.oak.spi.security.authentication.external.impl.ExternalLoginModule

All Implemented Interfaces:

LoginModule

public class ExternalLoginModule
extends AbstractLoginModule

ExternalLoginModule implements a LoginModule that uses an ExternalIdentityProvider for authentication.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_IDP_NAME Name of the parameter that configures the name of the external identity provider.
static String	PARAM_SYNC_HANDLER_NAME Name of the parameter that configures the name of the synchronization handler.

Fields inherited from class org.apache.jackrabbit.oak.spi.security.authentication.AbstractLoginModule

callbackHandler, options, SHARED_KEY_ATTRIBUTES, SHARED_KEY_CREDENTIALS, SHARED_KEY_LOGIN_NAME, SHARED_KEY_PRE_AUTH_LOGIN, sharedState, subject

Constructor Summary

Constructors

Constructor and Description
ExternalLoginModule() Default constructor for the OSGIi LoginModuleFactory case and the default non-OSGi JAAS case.
ExternalLoginModule(ConfigurationParameters osgiConfig) Creates a new ExternalLoginModule with the given OSGi config.

Method Summary

Modifier and Type	Method and Description
boolean	abort()
protected void	clearState() Clear state information that has been created during LoginModule.login().
boolean	commit()
protected @NotNull Set<Class>	getSupportedCredentials()
void	initialize(Subject subject, CallbackHandler callbackHandler, Map<String,?> sharedState, Map<String,?> opts)
boolean	login()
void	setIdpManager(@NotNull ExternalIdentityProviderManager idpManager)
void	setSyncManager(@NotNull SyncManager syncManager)

Methods inherited from class org.apache.jackrabbit.oak.spi.security.authentication.AbstractLoginModule

getCredentials, getLoginModuleMonitor, getPrincipalProvider, getPrincipals, getPrincipals, getRoot, getSecurityProvider, getSharedCredentials, getSharedLoginName, getSharedPreAuthLogin, getUserManager, getWhiteboard, logout, onError, setAuthInfo

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_IDP_NAME

public static final String PARAM_IDP_NAME

Name of the parameter that configures the name of the external identity provider.

See Also:

Constant Field Values

PARAM_SYNC_HANDLER_NAME

public static final String PARAM_SYNC_HANDLER_NAME

Name of the parameter that configures the name of the synchronization handler.

See Also:

Constant Field Values

Constructor Detail

ExternalLoginModule

public ExternalLoginModule()

Default constructor for the OSGIi LoginModuleFactory case and the default non-OSGi JAAS case.

ExternalLoginModule

public ExternalLoginModule(ConfigurationParameters osgiConfig)

Creates a new ExternalLoginModule with the given OSGi config.

Parameters:

osgiConfig - the config

Method Detail

initialize

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

Specified by:

initialize in interface LoginModule

Overrides:

initialize in class AbstractLoginModule

login

public boolean login()
              throws LoginException

Throws:

LoginException

commit

public boolean commit()

abort

public boolean abort()

Specified by:

abort in interface LoginModule

Overrides:

abort in class AbstractLoginModule

clearState

protected void clearState()

Description copied from class: AbstractLoginModule

Clear state information that has been created during LoginModule.login().

Overrides:

clearState in class AbstractLoginModule

getSupportedCredentials

@NotNull
protected @NotNull Set<Class> getSupportedCredentials()

Specified by:

getSupportedCredentials in class AbstractLoginModule

Returns:

the set of credentials classes as exposed by the configured CredentialsSupport implementation.

setSyncManager

public void setSyncManager(@NotNull
                           @NotNull SyncManager syncManager)

setIdpManager

public void setIdpManager(@NotNull
                          @NotNull ExternalIdentityProviderManager idpManager)