
	Version 9.7	SEARCH CONTENTS \| PDF BOOKS \| HOME UP PREV NEXT

— LoginModules Guide —

Configuration Parameters

These configuration parameters are the parameters in the SagAbstractLoginModule and are global for all LoginModules.

They are referred to as "global parameters" because they apply to all types of LoginModules.

LoginModules are configured in two ways:

By means of Flags that influence the whole process of authentication
By means of the module-specific parameters that are customized for the module and influence the behavior of the module only

For details on the Flags, see Preparing JAAS Configuration Files

For a list of the module-specific parameters, see the description of the respective login module.

The following table outlines the global configuration parameters.

Parameter Description

Parameter	Description
`create_user_principal`	Optional. You use it to define whether the `commit ()` method creates a `SagUserPrincipal` using the `SagCredentials` available in the `sharedState Map`. Valid values are: true - The `commit ()` method creates a `SagUserPrincipal`. false - Default value. The `commit ()` method does not create a `SagUserPrincipal`. The login modules that do not create `SagUserPrincipal` in their own `commit ()` method must call the `super.commit ()` method. Note: The `SagUserPrincipal` is created only once. Once set to "true", this flag cannot be changed.
`store_credentials`	Optional. You use it to define whether to store `SagCredentials` in `Subject.privateCredentials`. The servlet context and header field of `SagCredentials` are not stored. Valid values are: true - Default value. `SagCredentials` is stored in `Subject.privateCredentials`. false - `SagCredentials` is not stored in `Subject.privateCredentials`.
`keep_password`	Optional. You use it to define whether to keep the password (if present in `SagCredentials`) in the credentials that are stored in `Subject.privateCredentials`. Valid values are: true - Default value. The password (if present in the `SagCredentials`) is kept in the credentials that are stored in the `Subject.privateCredentials`. false - The password (if present in the `SagCredentials`) is not kept in the credentials that are stored in the `Subject.privateCredentials`. Note: This parameter requires the `store_credentials` parameter to be set to "true".

create_user_principal

Optional.

You use it to define whether the commit () method creates a SagUserPrincipal using the SagCredentials available in the sharedState Map.

Valid values are:

true - The commit () method creates a SagUserPrincipal.

false - Default value. The commit () method does not create a SagUserPrincipal.

The login modules that do not create SagUserPrincipal in their own commit () method must call the super.commit () method.

Note:
The SagUserPrincipal is created only once. Once set to "true", this flag cannot be changed.

store_credentials

Optional.

You use it to define whether to store SagCredentials in Subject.privateCredentials. The servlet context and header field of SagCredentials are not stored.

Valid values are:

true - Default value. SagCredentials is stored in Subject.privateCredentials.
false - SagCredentials is not stored in Subject.privateCredentials.

keep_password

Optional.

You use it to define whether to keep the password (if present in SagCredentials) in the credentials that are stored in Subject.privateCredentials.

Valid values are:

true - Default value. The password (if present in the SagCredentials) is kept in the credentials that are stored in the Subject.privateCredentials.
false - The password (if present in the SagCredentials) is not kept in the credentials that are stored in the Subject.privateCredentials.

Note:
This parameter requires the store_credentials parameter to be set to "true".

Important:
See Predefined Login Modules for guidelines on the module-specific parameters.

SEARCH CONTENTS | PDF BOOKS | HOME UP PREV NEXT