javax.security.identitystore.annotation

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

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	callerQuery SQL query to validate the {caller, password} pair.
String	groupsQuery SQL query to retrieve the groups associated with the caller when authentication succeeds.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	dataSourceLookup Full JNDI name of the data source that provides access to the data base where the caller identities are stored.
String	hashAlgorithm Hash algorithm applied to plain text password for comparison with password returned from groupsQuery().
String	hashEncoding Encoding used for hash.
int	priority Determines the order in case multiple IdentityStores are found.
IdentityStore.ValidationType[]	useFor Determines what the identity store is used for

Element Detail

callerQuery

public abstract String callerQuery

SQL query to validate the {caller, password} pair.

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 caller where name = ?
 
 

Returns:

SQL query to validate

groupsQuery

public abstract String groupsQuery

SQL query to retrieve the groups associated with the caller when authentication succeeds.

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

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"

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:

""

hashEncoding

public abstract String hashEncoding

Encoding used for hash. TODO

Returns:

Encoding used for hash

Default:

""

priority

public abstract int priority

Determines the order in case multiple IdentityStores are found.

Returns:

the priority.

Default:

70

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.identitystore.IdentityStore.ValidationType.VALIDATE, javax.security.identitystore.IdentityStore.ValidationType.PROVIDE_GROUPS}