org.apache.jackrabbit.core.config

Class LoginModuleConfig

java.lang.Object

org.apache.jackrabbit.core.config.BeanConfig

org.apache.jackrabbit.core.config.LoginModuleConfig

public class LoginModuleConfig
extends BeanConfig

LoginModule configuration. This bean configuration class is used to create login module objects.

Login module is an optional configuration that allows to use JackRabbit in a non-JAAS environment.

See Also:

RepositoryConfig.getLoginModuleConfig()

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPAT_PRINCIPAL_PROVIDER_CLASS Same as PARAM_PRINCIPAL_PROVIDER_CLASS.
static String	COMPAT_PRINCIPAL_PROVIDER_NAME Property-Key if the PrincipalProvider configured with PARAM_PRINCIPAL_PROVIDER_CLASS be registered using the specified name instead of the class name which is used by default if the name parameter is missing.
static String	PARAM_ADMIN_ID UserId of the administrator.
static String	PARAM_ANONYMOUS_ID UserId of the anonymous user.
static String	PARAM_PRINCIPAL_PROVIDER_CLASS Property-Key for the fully qualified class name of the implementation of PrincipalProvider to be used with the LoginModule.

Constructor Summary

Constructors

Constructor and Description
LoginModuleConfig(BeanConfig config) Creates an access manager configuration object from the given bean configuration.

Method Summary

Modifier and Type	Method and Description
LoginModule	getLoginModule()

Methods inherited from class org.apache.jackrabbit.core.config.BeanConfig

getClassLoader, getClassName, getDefaultClassLoader, getParameters, newInstance, setClassLoader, setConnectionFactory, setDefaultClassLoader, setInstanceFactory, setValidate

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_ANONYMOUS_ID

public static final String PARAM_ANONYMOUS_ID

UserId of the anonymous user. Optional parameter in the LoginModule configuration.

See Also:

Constant Field Values

PARAM_ADMIN_ID

public static final String PARAM_ADMIN_ID

UserId of the administrator. Optional parameter in the LoginModule configuration.

See Also:

Constant Field Values

PARAM_PRINCIPAL_PROVIDER_CLASS

public static final String PARAM_PRINCIPAL_PROVIDER_CLASS

Property-Key for the fully qualified class name of the implementation of PrincipalProvider to be used with the LoginModule.

See Also:

Constant Field Values

COMPAT_PRINCIPAL_PROVIDER_CLASS

public static final String COMPAT_PRINCIPAL_PROVIDER_CLASS

Same as PARAM_PRINCIPAL_PROVIDER_CLASS. Introduced for compatibility reasons.

See Also:

JCR-2629, Constant Field Values

COMPAT_PRINCIPAL_PROVIDER_NAME

public static final String COMPAT_PRINCIPAL_PROVIDER_NAME

Property-Key if the PrincipalProvider configured with PARAM_PRINCIPAL_PROVIDER_CLASS be registered using the specified name instead of the class name which is used by default if the name parameter is missing.

See Also:

JCR-2629, Constant Field Values

Constructor Detail

LoginModuleConfig

public LoginModuleConfig(BeanConfig config)

Creates an access manager configuration object from the given bean configuration.

Parameters:

config - bean configuration

Method Detail

getLoginModule

public LoginModule getLoginModule()
                           throws ConfigurationException

Throws:

ConfigurationException