org.picketlink.idm.spi

Interface IdentityStore<T extends IdentityStoreConfiguration>

All Known Subinterfaces:

CredentialStore<T>

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

Persists the specified IdentityType

Parameters:

identityType -

update

void update(SecurityContext context,
          AttributedType value)

Updates the specified IdentityType

Parameters:

identityType -

remove

void remove(SecurityContext context,
          AttributedType value)

Removes the specified IdentityType

Parameters:

identityType -

getAgent

Agent getAgent(SecurityContext context,
             String loginName)

Returns the Agent with the specified login name

Parameters:

context -

loginName -

Returns:

getUser

User getUser(SecurityContext context,
           String loginName)

Returns the User with the specified login name.

Parameters:

context -

loginName -

Returns:

getGroup

Group getGroup(SecurityContext context,
             String groupPath)

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

Parameters:

ctx -

groupPath -

Returns:

getGroup

Group getGroup(SecurityContext context,
             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(SecurityContext context,
           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(SecurityContext context,
                                                 IdentityQuery<V> identityQuery)

countQueryResults

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

fetchQueryResults

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

countQueryResults

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

setAttribute

void setAttribute(SecurityContext context,
                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(SecurityContext context,
                                                 IdentityType identityType,
                                                 String attributeName)

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

Parameters:

ctx -

identityType -

attributeName -

Returns:

removeAttribute

void removeAttribute(SecurityContext context,
                   IdentityType identityType,
                   String attributeName)

Removes the specified Attribute value, for the specified IdentityType

Parameters:

ctx -

identityType -

attributeName -

validateCredentials

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

Updates the specified credential value for the specified Agent.

Parameters:

agent -

credential -