org.picketlink.idm.file.internal

Class FileBasedIdentityStore

java.lang.Object

org.picketlink.idm.file.internal.FileBasedIdentityStore

All Implemented Interfaces:

org.picketlink.idm.spi.CredentialStore, org.picketlink.idm.spi.IdentityStore<FileIdentityStoreConfiguration>, org.picketlink.idm.spi.PartitionStore

@CredentialHandlers(value={PasswordCredentialHandler.class,X509CertificateCredentialHandler.class,DigestCredentialHandler.class})
public class FileBasedIdentityStore
extends Object
implements org.picketlink.idm.spi.IdentityStore<FileIdentityStoreConfiguration>, org.picketlink.idm.spi.CredentialStore, org.picketlink.idm.spi.PartitionStore

File based IdentityStore implementation. By default, each new instance recreate the data files. This behavior can be changed by configuring the alwaysCreateFiles property to false.

Author:

Pedro Silva

Constructor Summary

Constructors

Constructor and Description
FileBasedIdentityStore()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(org.picketlink.idm.model.AttributedType attributedType)
protected <T extends org.picketlink.idm.model.Relationship> T	convertToRelationship(FileRelationship fileRelationship)
<T extends org.picketlink.idm.model.IdentityType> int	countQueryResults(org.picketlink.idm.query.IdentityQuery<T> identityQuery)
<T extends org.picketlink.idm.model.Relationship> int	countQueryResults(org.picketlink.idm.query.RelationshipQuery<T> query)
void	createPartition(org.picketlink.idm.model.Partition partition)
<T extends org.picketlink.idm.model.IdentityType> List<T>	fetchQueryResults(org.picketlink.idm.query.IdentityQuery<T> identityQuery)
<T extends org.picketlink.idm.model.Relationship> List<T>	fetchQueryResults(org.picketlink.idm.query.RelationshipQuery<T> query)
org.picketlink.idm.model.Agent	getAgent(String loginName)
<T extends Serializable> org.picketlink.idm.model.Attribute<T>	getAttribute(org.picketlink.idm.model.IdentityType identityType, String attributeName)
FileIdentityStoreConfiguration	getConfig()
org.picketlink.idm.spi.IdentityStoreInvocationContext	getContext()
org.picketlink.idm.model.Group	getGroup(String groupPath)
org.picketlink.idm.model.Group	getGroup(String name, org.picketlink.idm.model.Group parent)
org.picketlink.idm.model.Realm	getRealm(String realmName)
protected Map<String,List<FileRelationship>>	getRelationshipsForCurrentPartition() Returns the stored Relationship instances for the current Partition.
org.picketlink.idm.model.Role	getRole(String roleName)
org.picketlink.idm.model.Tier	getTier(String tierName)
org.picketlink.idm.model.User	getUser(String loginName)
protected boolean	hasParentGroup(org.picketlink.idm.model.Group childGroup, org.picketlink.idm.model.Group parentGroup)
void	remove(org.picketlink.idm.model.AttributedType attributedType)
void	removeAttribute(org.picketlink.idm.model.IdentityType identityType, String attributeName)
void	removePartition(org.picketlink.idm.model.Partition partition)
<T extends org.picketlink.idm.credential.spi.CredentialStorage> List<T>	retrieveCredentials(org.picketlink.idm.model.Agent agent, Class<T> storageClass)
<T extends org.picketlink.idm.credential.spi.CredentialStorage> T	retrieveCurrentCredential(org.picketlink.idm.model.Agent agent, Class<T> storageClass)
void	setAttribute(org.picketlink.idm.model.IdentityType identityType, org.picketlink.idm.model.Attribute<? extends Serializable> attribute)
void	setup(FileIdentityStoreConfiguration config, org.picketlink.idm.spi.IdentityStoreInvocationContext context)
void	storeCredential(org.picketlink.idm.model.Agent agent, org.picketlink.idm.credential.spi.CredentialStorage storage)
void	update(org.picketlink.idm.model.AttributedType attributedType)
void	updateCredential(org.picketlink.idm.model.Agent agent, Object credential, Date effectiveDate, Date expiryDate)
void	validateCredentials(org.picketlink.idm.credential.Credentials credentials)

Methods inherited from class java.lang.Object

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

Constructor Detail

FileBasedIdentityStore

public FileBasedIdentityStore()

Method Detail

setup

public void setup(FileIdentityStoreConfiguration config,
         org.picketlink.idm.spi.IdentityStoreInvocationContext context)

Specified by:

setup in interface org.picketlink.idm.spi.IdentityStore<FileIdentityStoreConfiguration>

getConfig

public FileIdentityStoreConfiguration getConfig()

Specified by:

getConfig in interface org.picketlink.idm.spi.IdentityStore<FileIdentityStoreConfiguration>

getContext

public org.picketlink.idm.spi.IdentityStoreInvocationContext getContext()

Specified by:

getContext in interface org.picketlink.idm.spi.IdentityStore<FileIdentityStoreConfiguration>

add

public void add(org.picketlink.idm.model.AttributedType attributedType)

Specified by:

add in interface org.picketlink.idm.spi.IdentityStore<FileIdentityStoreConfiguration>

update

public void update(org.picketlink.idm.model.AttributedType attributedType)

Specified by:

update in interface org.picketlink.idm.spi.IdentityStore<FileIdentityStoreConfiguration>

remove

public void remove(org.picketlink.idm.model.AttributedType attributedType)

Specified by:

remove in interface org.picketlink.idm.spi.IdentityStore<FileIdentityStoreConfiguration>

getAgent

public org.picketlink.idm.model.Agent getAgent(String loginName)

Specified by:

getAgent in interface org.picketlink.idm.spi.IdentityStore<FileIdentityStoreConfiguration>

getUser

public org.picketlink.idm.model.User getUser(String loginName)

Specified by:

getUser in interface org.picketlink.idm.spi.IdentityStore<FileIdentityStoreConfiguration>

getRole

public org.picketlink.idm.model.Role getRole(String roleName)

Specified by:

getRole in interface org.picketlink.idm.spi.IdentityStore<FileIdentityStoreConfiguration>

getGroup

public org.picketlink.idm.model.Group getGroup(String groupPath)

Specified by:

getGroup in interface org.picketlink.idm.spi.IdentityStore<FileIdentityStoreConfiguration>

getGroup

public org.picketlink.idm.model.Group getGroup(String name,
                                      org.picketlink.idm.model.Group parent)

Specified by:

getGroup in interface org.picketlink.idm.spi.IdentityStore<FileIdentityStoreConfiguration>

countQueryResults

public <T extends org.picketlink.idm.model.IdentityType> int countQueryResults(org.picketlink.idm.query.IdentityQuery<T> identityQuery)

Specified by:

countQueryResults in interface org.picketlink.idm.spi.IdentityStore<FileIdentityStoreConfiguration>

getAttribute

public <T extends Serializable> org.picketlink.idm.model.Attribute<T> getAttribute(org.picketlink.idm.model.IdentityType identityType,
                                                                          String attributeName)

Specified by:

getAttribute in interface org.picketlink.idm.spi.IdentityStore<FileIdentityStoreConfiguration>

setAttribute

public void setAttribute(org.picketlink.idm.model.IdentityType identityType,
                org.picketlink.idm.model.Attribute<? extends Serializable> attribute)

Specified by:

setAttribute in interface org.picketlink.idm.spi.IdentityStore<FileIdentityStoreConfiguration>

removeAttribute

public void removeAttribute(org.picketlink.idm.model.IdentityType identityType,
                   String attributeName)

Specified by:

removeAttribute in interface org.picketlink.idm.spi.IdentityStore<FileIdentityStoreConfiguration>

fetchQueryResults

public <T extends org.picketlink.idm.model.Relationship> List<T> fetchQueryResults(org.picketlink.idm.query.RelationshipQuery<T> query)

Specified by:

fetchQueryResults in interface org.picketlink.idm.spi.IdentityStore<FileIdentityStoreConfiguration>

countQueryResults

public <T extends org.picketlink.idm.model.Relationship> int countQueryResults(org.picketlink.idm.query.RelationshipQuery<T> query)

Specified by:

countQueryResults in interface org.picketlink.idm.spi.IdentityStore<FileIdentityStoreConfiguration>

fetchQueryResults

public <T extends org.picketlink.idm.model.IdentityType> List<T> fetchQueryResults(org.picketlink.idm.query.IdentityQuery<T> identityQuery)

Specified by:

fetchQueryResults in interface org.picketlink.idm.spi.IdentityStore<FileIdentityStoreConfiguration>

storeCredential

public void storeCredential(org.picketlink.idm.model.Agent agent,
                   org.picketlink.idm.credential.spi.CredentialStorage storage)

Specified by:

storeCredential in interface org.picketlink.idm.spi.CredentialStore

retrieveCredentials

public <T extends org.picketlink.idm.credential.spi.CredentialStorage> List<T> retrieveCredentials(org.picketlink.idm.model.Agent agent,
                                                                                          Class<T> storageClass)

Specified by:

retrieveCredentials in interface org.picketlink.idm.spi.CredentialStore

retrieveCurrentCredential

public <T extends org.picketlink.idm.credential.spi.CredentialStorage> T retrieveCurrentCredential(org.picketlink.idm.model.Agent agent,
                                                                                          Class<T> storageClass)

Specified by:

retrieveCurrentCredential in interface org.picketlink.idm.spi.CredentialStore

updateCredential

public void updateCredential(org.picketlink.idm.model.Agent agent,
                    Object credential,
                    Date effectiveDate,
                    Date expiryDate)

Specified by:

updateCredential in interface org.picketlink.idm.spi.IdentityStore<FileIdentityStoreConfiguration>

validateCredentials

public void validateCredentials(org.picketlink.idm.credential.Credentials credentials)

Specified by:

validateCredentials in interface org.picketlink.idm.spi.IdentityStore<FileIdentityStoreConfiguration>

createPartition

public void createPartition(org.picketlink.idm.model.Partition partition)

Specified by:

createPartition in interface org.picketlink.idm.spi.PartitionStore

getRealm

public org.picketlink.idm.model.Realm getRealm(String realmName)

Specified by:

getRealm in interface org.picketlink.idm.spi.PartitionStore

getTier

public org.picketlink.idm.model.Tier getTier(String tierName)

Specified by:

getTier in interface org.picketlink.idm.spi.PartitionStore

removePartition

public void removePartition(org.picketlink.idm.model.Partition partition)

Specified by:

removePartition in interface org.picketlink.idm.spi.PartitionStore

convertToRelationship

protected <T extends org.picketlink.idm.model.Relationship> T convertToRelationship(FileRelationship fileRelationship)

getRelationshipsForCurrentPartition

protected Map<String,List<FileRelationship>> getRelationshipsForCurrentPartition()

Returns the stored Relationship instances for the current Partition.

Returns:

hasParentGroup

protected boolean hasParentGroup(org.picketlink.idm.model.Group childGroup,
                     org.picketlink.idm.model.Group parentGroup)