org.picketlink.idm.spi

Interface IdentityStore<T extends IdentityStoreConfiguration>

All Known Subinterfaces:

AttributeStore<T>, CredentialStore<T>, PartitionStore<T>

All Known Implementing Classes:

AbstractIdentityStore, FileIdentityStore, JDBCIdentityStore, JPAIdentityStore, LDAPIdentityStore, TokenIdentityStore

public interface IdentityStore<T extends IdentityStoreConfiguration>

IdentityStore representation providing minimal SPI

Author:

Boleslaw Dawidowicz, Shane Bryzak

Method Summary

Methods

Modifier and Type	Method and Description
void	add(IdentityContext context, AttributedType value) Persists the specified IdentityType
<V extends IdentityType> int	countQueryResults(IdentityContext context, IdentityQuery<V> identityQuery)
<V extends Relationship> int	countQueryResults(IdentityContext context, RelationshipQuery<V> query)
<V extends IdentityType> List<V>	fetchQueryResults(IdentityContext context, IdentityQuery<V> identityQuery)
<V extends Relationship> List<V>	fetchQueryResults(IdentityContext context, RelationshipQuery<V> query)
T	getConfig() Returns the configuration for this IdentityStore instance
void	remove(IdentityContext context, AttributedType value) Removes the specified IdentityType
void	setup(T config) Sets the configuration and context in which the IdentityStore will execute its operations
void	update(IdentityContext context, AttributedType value) Updates the specified IdentityType
void	updateCredential(IdentityContext context, Account account, Object credential, Date effectiveDate, Date expiryDate) Updates the specified credential value for the specified Agent.
void	validateCredentials(IdentityContext context, Credentials credentials) Validates the specified credentials.

Method Detail

setup

void setup(T config)

Sets the configuration and context in which the IdentityStore will execute its operations

Parameters:

config -

context -

getConfig

T getConfig()

Returns the configuration for this IdentityStore instance

Returns:

add

void add(IdentityContext context,
       AttributedType value)

Persists the specified IdentityType

Parameters:

identityType -

update

void update(IdentityContext context,
          AttributedType value)

Updates the specified IdentityType

Parameters:

identityType -

remove

void remove(IdentityContext context,
          AttributedType value)

Removes the specified IdentityType

Parameters:

identityType -

fetchQueryResults

<V extends IdentityType> List<V> fetchQueryResults(IdentityContext context,
                                                 IdentityQuery<V> identityQuery)

countQueryResults

<V extends IdentityType> int countQueryResults(IdentityContext context,
                                             IdentityQuery<V> identityQuery)

fetchQueryResults

<V extends Relationship> List<V> fetchQueryResults(IdentityContext context,
                                                 RelationshipQuery<V> query)

countQueryResults

<V extends Relationship> int countQueryResults(IdentityContext context,
                                             RelationshipQuery<V> query)

validateCredentials

void validateCredentials(IdentityContext context,
                       Credentials credentials)

Validates the specified credentials. Each IdentityStore implementation typically supports a concrete set of Credentials types, and will generally obtain a CredentialHandler instance from the IdentityStoreInvocationContext to process credential validation.

Parameters:

credentials -

updateCredential

void updateCredential(IdentityContext context,
                    Account account,
                    Object credential,
                    Date effectiveDate,
                    Date expiryDate)

Updates the specified credential value for the specified Agent.

Parameters:

agent -

credential -