org.picketlink.idm.spi

Interface IdentityStore<T extends IdentityStoreConfiguration>

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(AttributedType value) Persists the specified IdentityType
<V extends IdentityType> int	countQueryResults(IdentityQuery<V> identityQuery)
<V extends Relationship> int	countQueryResults(RelationshipQuery<V> query)
<V extends IdentityType> List<V>	fetchQueryResults(IdentityQuery<V> identityQuery)
<V extends Relationship> List<V>	fetchQueryResults(RelationshipQuery<V> query)
Agent	getAgent(String id)
<V extends Serializable> Attribute<V>	getAttribute(IdentityType identityType, String attributeName) Returns the Attribute value with the specified name, for the specified IdentityType
T	getConfig() Returns the configuration for this IdentityStore instance
IdentityStoreInvocationContext	getContext() Returns the current context for this IdentityStore instance
Group	getGroup(String groupPath) Returns the Group with the specified path.
Group	getGroup(String name, Group parent) Returns the Group with the specified name and parent group
Role	getRole(String name) Returns the specified role
User	getUser(String id) Returns the User with the specified id value.
void	remove(AttributedType value) Removes the specified IdentityType
void	removeAttribute(IdentityType identityType, String attributeName) Removes the specified Attribute value, for the specified IdentityType
void	setAttribute(IdentityType identityType, Attribute<? extends Serializable> attribute) Sets the specified Attribute value for the specified IdentityType
void	setup(T config, IdentityStoreInvocationContext context) Sets the configuration and context in which the IdentityStore will execute its operations
void	update(AttributedType value) Updates the specified IdentityType
void	updateCredential(Agent agent, Object credential, Date effectiveDate, Date expiryDate) Updates the specified credential value for the specified Agent.
void	validateCredentials(Credentials credentials) Validates the specified credentials.

Method Detail

setup

void setup(T config,
         IdentityStoreInvocationContext context)

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:

getContext

IdentityStoreInvocationContext getContext()

Returns the current context for this IdentityStore instance

Returns:

add

void add(AttributedType value)

Persists the specified IdentityType

Parameters:

identityType -

update

void update(AttributedType value)

Updates the specified IdentityType

Parameters:

identityType -

remove

void remove(AttributedType value)

Removes the specified IdentityType

Parameters:

identityType -

getAgent

Agent getAgent(String id)

getUser

User getUser(String id)

Returns the User with the specified id value.

Parameters:

ctx -

id -

Returns:

getGroup

Group getGroup(String groupPath)

Returns the Group with the specified path. Eg.: /groupA/groupB/groupC.

Parameters:

ctx -

groupPath -

Returns:

getGroup

Group getGroup(String name,
             Group parent)

Returns the Group with the specified name and parent group

Parameters:

ctx -

name - The name of the Group to return

Returns:

getRole

Role getRole(String name)

Returns the specified role

Parameters:

ctx -

name - The name of the Role to return

Returns:

A Role instance, or null if the Role with the specified name wasn't found

fetchQueryResults

<V extends IdentityType> List<V> fetchQueryResults(IdentityQuery<V> identityQuery)

countQueryResults

<V extends IdentityType> int countQueryResults(IdentityQuery<V> identityQuery)

fetchQueryResults

<V extends Relationship> List<V> fetchQueryResults(RelationshipQuery<V> query)

countQueryResults

<V extends Relationship> int countQueryResults(RelationshipQuery<V> query)

setAttribute

void setAttribute(IdentityType identityType,
                Attribute<? extends Serializable> attribute)

Sets the specified Attribute value for the specified IdentityType

Parameters:

ctx -

identityType -

attribute -

getAttribute

<V extends Serializable> Attribute<V> getAttribute(IdentityType identityType,
                                                 String attributeName)

Returns the Attribute value with the specified name, for the specified IdentityType

Parameters:

ctx -

identityType -

attributeName -

Returns:

removeAttribute

void removeAttribute(IdentityType identityType,
                   String attributeName)

Removes the specified Attribute value, for the specified IdentityType

Parameters:

ctx -

identityType -

attributeName -

validateCredentials

void validateCredentials(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(Agent agent,
                    Object credential,
                    Date effectiveDate,
                    Date expiryDate)

Updates the specified credential value for the specified Agent.

Parameters:

agent -

credential -