javax.security.enterprise.identitystore

Annotation Type DatabaseIdentityStoreDefinition

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface DatabaseIdentityStoreDefinition

Annotation used to define a container provided IdentityStore that stores caller credentials and identity attributes in a relational database, and make that implementation available as an enabled CDI bean.

Author:

Arjan Tijms

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	callerQuery SQL query to validate the {caller, password} pair.
String	dataSourceLookup Full JNDI name of the data source that provides access to the data base where the caller identities are stored.
String	groupsQuery SQL query to retrieve the groups associated with the caller when authentication succeeds.
String	hashAlgorithm Hash algorithm applied to plain text password for comparison with password returned from groupsQuery().
int	priority Determines the order in case multiple IdentityStores are found.
String	priorityExpression Allow priority to be specified as an EL expression.
IdentityStore.ValidationType[]	useFor Determines what the identity store is used for
String	useForExpression Allow useFor to be specified as an EL expression.

Element Detail

dataSourceLookup

public abstract String dataSourceLookup

Full JNDI name of the data source that provides access to the data base where the caller identities are stored.

Returns:

Full JNDI name of the data source

Default:

"java:comp/DefaultDataSource"

callerQuery

public abstract String callerQuery

SQL query to validate the {caller, password} pair. Only needed when useFor() contains IdentityStore.ValidationType.VALIDATE.

The name of the caller that is to be authenticated has to be set as the one and only placeholder. The (hashed) password should be in the first column of the result.

Example query:

 
 select password from callers where name = ?
 
 

Returns:

SQL query to validate

Default:

""

groupsQuery

public abstract String groupsQuery

SQL query to retrieve the groups associated with the caller when authentication succeeds. Only needed when useFor() contains IdentityStore.ValidationType.PROVIDE_GROUPS.

The name of the caller that has been authenticated has to be set as the one and only placeholder. The group name should be in the first column of the result.

Example query:

 
 select group_name from caller_groups where caller_name = ?
 
 

Returns:

SQL query to retrieve the groups

Default:

""

hashAlgorithm

public abstract String hashAlgorithm

Hash algorithm applied to plain text password for comparison with password returned from groupsQuery().

Returns:

Hash algorithm applied to plain text password

Default:

"PBKDF2"

priority

public abstract int priority

Determines the order in case multiple IdentityStores are found.

Returns:

the priority.

Default:

70

priorityExpression

public abstract String priorityExpression

Allow priority to be specified as an EL expression. If set, overrides any value set with priority.

Returns:

the priority EL expression

Default:

""

useFor

public abstract IdentityStore.ValidationType[] useFor

Determines what the identity store is used for

Returns:

the type the identity store is used for

Default:

{javax.security.enterprise.identitystore.IdentityStore.ValidationType.VALIDATE, javax.security.enterprise.identitystore.IdentityStore.ValidationType.PROVIDE_GROUPS}

useForExpression

public abstract String useForExpression

Allow useFor to be specified as an EL expression. If set, overrides any value set with useFor.

Returns:

the useFor EL expression

Default:

""