org.picketlink.idm.jdbc.internal

Class JDBCIdentityStore

java.lang.Object

org.picketlink.idm.internal.AbstractIdentityStore<JDBCIdentityStoreConfiguration>

org.picketlink.idm.jdbc.internal.JDBCIdentityStore

All Implemented Interfaces:

AttributeStore<JDBCIdentityStoreConfiguration>, CredentialStore<JDBCIdentityStoreConfiguration>, IdentityStore<JDBCIdentityStoreConfiguration>, PartitionStore<JDBCIdentityStoreConfiguration>

public class JDBCIdentityStore
extends AbstractIdentityStore<JDBCIdentityStoreConfiguration>
implements CredentialStore<JDBCIdentityStoreConfiguration>, PartitionStore<JDBCIdentityStoreConfiguration>, AttributeStore<JDBCIdentityStoreConfiguration>

Implementation of IdentityStore using JDBC

Since:

September 25, 2013

Author:

Anil Saldhana

Constructor Summary

Constructors

Constructor and Description
JDBCIdentityStore()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(IdentityContext identityContext, Partition partition, String configurationName)
protected void	addAttributedType(IdentityContext context, AttributedType attributedType)
<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)
<P extends Partition> List<P>	get(IdentityContext identityContext, Class<P> partitionClass)
<P extends Partition> P	get(IdentityContext identityContext, Class<P> partitionClass, String name)
<V extends Serializable> Attribute<V>	getAttribute(IdentityContext context, AttributedType attributedType, String attributeName) Returns the Attribute value with the specified name, for the specified IdentityType
String	getConfigurationName(IdentityContext identityContext, Partition partition)
void	loadAttributes(IdentityContext context, AttributedType attributedType) Loads all attributes for the given AttributedType.
<P extends Partition> P	lookupById(IdentityContext context, Class<P> partitionClass, String id)
void	remove(IdentityContext identityContext, Partition partition)
void	removeAttribute(IdentityContext context, AttributedType attributedType, String attributeName) Removes the specified Attribute value, for the specified IdentityType
protected void	removeAttributedType(IdentityContext context, AttributedType attributedType)
void	removeCredential(IdentityContext context, Account account, Class<? extends CredentialStorage> storageClass) Removes all credentials stored by a certain CredentialStorage associated with the given Account.
protected void	removeCredentials(IdentityContext context, Account account)
protected void	removeFromRelationships(IdentityContext context, IdentityType identityType)
<T extends CredentialStorage> List<T>	retrieveCredentials(IdentityContext context, Account account, Class<T> storageClass) Returns a list of all credential state of the specified T, for the specified Account.
<T extends CredentialStorage> T	retrieveCurrentCredential(IdentityContext context, Account account, Class<T> storageClass) Returns the currently active credential state of the specified T, for the specified Account.
void	setAttribute(IdentityContext context, AttributedType attributedType, Attribute<? extends Serializable> attribute) Sets the specified Attribute value for the specified IdentityType
void	setup(JDBCIdentityStoreConfiguration config) Sets the configuration and context in which the IdentityStore will execute its operations
void	storeCredential(IdentityContext context, Account account, CredentialStorage storage) Stores the specified credential state.
void	update(IdentityContext identityContext, Partition partition)
protected void	updateAttributedType(IdentityContext context, AttributedType attributedType)

Methods inherited from class org.picketlink.idm.internal.AbstractIdentityStore

add, getConfig, remove, update, updateCredential, validateCredentials

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.picketlink.idm.spi.IdentityStore

add, getConfig, remove, update, updateCredential, validateCredentials

Constructor Detail

JDBCIdentityStore

public JDBCIdentityStore()

Method Detail

setup

public void setup(JDBCIdentityStoreConfiguration config)

Description copied from interface: IdentityStore

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

Specified by:

setup in interface IdentityStore<JDBCIdentityStoreConfiguration>

Overrides:

setup in class AbstractIdentityStore<JDBCIdentityStoreConfiguration>

removeFromRelationships

protected void removeFromRelationships(IdentityContext context,
                           IdentityType identityType)

Specified by:

removeFromRelationships in class AbstractIdentityStore<JDBCIdentityStoreConfiguration>

removeCredentials

protected void removeCredentials(IdentityContext context,
                     Account account)

Specified by:

removeCredentials in class AbstractIdentityStore<JDBCIdentityStoreConfiguration>

addAttributedType

protected void addAttributedType(IdentityContext context,
                     AttributedType attributedType)

Overrides:

addAttributedType in class AbstractIdentityStore<JDBCIdentityStoreConfiguration>

updateAttributedType

protected void updateAttributedType(IdentityContext context,
                        AttributedType attributedType)

Specified by:

updateAttributedType in class AbstractIdentityStore<JDBCIdentityStoreConfiguration>

removeAttributedType

protected void removeAttributedType(IdentityContext context,
                        AttributedType attributedType)

Specified by:

removeAttributedType in class AbstractIdentityStore<JDBCIdentityStoreConfiguration>

storeCredential

public void storeCredential(IdentityContext context,
                   Account account,
                   CredentialStorage storage)

Description copied from interface: CredentialStore

Stores the specified credential state.

Specified by:

storeCredential in interface CredentialStore<JDBCIdentityStoreConfiguration>

Parameters:

context - The contextual invocation context.

account - The account which credentials should be removed.

storage - The credential storage instance to be stored.

retrieveCurrentCredential

public <T extends CredentialStorage> T retrieveCurrentCredential(IdentityContext context,
                                                        Account account,
                                                        Class<T> storageClass)

Description copied from interface: CredentialStore

Returns the currently active credential state of the specified T, for the specified Account.

Specified by:

retrieveCurrentCredential in interface CredentialStore<JDBCIdentityStoreConfiguration>

Parameters:

context - The contextual invocation context.

account - The account which credentials should be removed.

storageClass - The credential storage type specifying which credential types should be removed.

Returns:

retrieveCredentials

public <T extends CredentialStorage> List<T> retrieveCredentials(IdentityContext context,
                                                        Account account,
                                                        Class<T> storageClass)

Description copied from interface: CredentialStore

Returns a list of all credential state of the specified T, for the specified Account.

Specified by:

retrieveCredentials in interface CredentialStore<JDBCIdentityStoreConfiguration>

Parameters:

context - The contextual invocation context.

account - The account which credentials should be removed.

storageClass - The credential storage type specifying which credential types should be removed.

Returns:

removeCredential

public void removeCredential(IdentityContext context,
                    Account account,
                    Class<? extends CredentialStorage> storageClass)

Description copied from interface: CredentialStore

Removes all credentials stored by a certain CredentialStorage associated with the given Account.

Specified by:

removeCredential in interface CredentialStore<JDBCIdentityStoreConfiguration>

Parameters:

context - The contextual invocation context.

account - The account which credentials should be removed.

storageClass - The credential storage type specifying which credential types should be removed.

fetchQueryResults

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

Specified by:

fetchQueryResults in interface IdentityStore<JDBCIdentityStoreConfiguration>

countQueryResults

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

Specified by:

countQueryResults in interface IdentityStore<JDBCIdentityStoreConfiguration>

Overrides:

countQueryResults in class AbstractIdentityStore<JDBCIdentityStoreConfiguration>

fetchQueryResults

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

Specified by:

fetchQueryResults in interface IdentityStore<JDBCIdentityStoreConfiguration>

countQueryResults

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

Specified by:

countQueryResults in interface IdentityStore<JDBCIdentityStoreConfiguration>

Overrides:

countQueryResults in class AbstractIdentityStore<JDBCIdentityStoreConfiguration>

setAttribute

public void setAttribute(IdentityContext context,
                AttributedType attributedType,
                Attribute<? extends Serializable> attribute)

Description copied from interface: AttributeStore

Sets the specified Attribute value for the specified IdentityType

Specified by:

setAttribute in interface AttributeStore<JDBCIdentityStoreConfiguration>

getAttribute

public <V extends Serializable> Attribute<V> getAttribute(IdentityContext context,
                                                 AttributedType attributedType,
                                                 String attributeName)

Description copied from interface: AttributeStore

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

Specified by:

getAttribute in interface AttributeStore<JDBCIdentityStoreConfiguration>

Returns:

removeAttribute

public void removeAttribute(IdentityContext context,
                   AttributedType attributedType,
                   String attributeName)

Description copied from interface: AttributeStore

Removes the specified Attribute value, for the specified IdentityType

Specified by:

removeAttribute in interface AttributeStore<JDBCIdentityStoreConfiguration>

loadAttributes

public void loadAttributes(IdentityContext context,
                  AttributedType attributedType)

Description copied from interface: AttributeStore

Loads all attributes for the given AttributedType.

Specified by:

loadAttributes in interface AttributeStore<JDBCIdentityStoreConfiguration>

getConfigurationName

public String getConfigurationName(IdentityContext identityContext,
                          Partition partition)

Specified by:

getConfigurationName in interface PartitionStore<JDBCIdentityStoreConfiguration>

get

public <P extends Partition> P get(IdentityContext identityContext,
                          Class<P> partitionClass,
                          String name)

Specified by:

get in interface PartitionStore<JDBCIdentityStoreConfiguration>

get

public <P extends Partition> List<P> get(IdentityContext identityContext,
                                Class<P> partitionClass)

Specified by:

get in interface PartitionStore<JDBCIdentityStoreConfiguration>

lookupById

public <P extends Partition> P lookupById(IdentityContext context,
                                 Class<P> partitionClass,
                                 String id)

Specified by:

lookupById in interface PartitionStore<JDBCIdentityStoreConfiguration>

add

public void add(IdentityContext identityContext,
       Partition partition,
       String configurationName)

Specified by:

add in interface PartitionStore<JDBCIdentityStoreConfiguration>

update

public void update(IdentityContext identityContext,
          Partition partition)

Specified by:

update in interface PartitionStore<JDBCIdentityStoreConfiguration>

remove

public void remove(IdentityContext identityContext,
          Partition partition)

Specified by:

remove in interface PartitionStore<JDBCIdentityStoreConfiguration>