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.config.FileIdentityStoreConfiguration>, org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.FileIdentityStoreConfiguration>

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

File based IdentityStore implementation.

Author:

Pedro Silva

Constructor Summary

Constructors

Constructor and Description
FileBasedIdentityStore()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.AttributedType attributedType)
protected <T extends org.picketlink.idm.model.Relationship> T	convertToRelationship(org.picketlink.idm.spi.SecurityContext context, FileRelationship fileRelationship)
<T extends org.picketlink.idm.model.IdentityType> int	countQueryResults(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.query.IdentityQuery<T> identityQuery)
<T extends org.picketlink.idm.model.Relationship> int	countQueryResults(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.query.RelationshipQuery<T> query)
<T extends org.picketlink.idm.model.IdentityType> List<T>	fetchQueryResults(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.query.IdentityQuery<T> identityQuery)
<T extends org.picketlink.idm.model.Relationship> List<T>	fetchQueryResults(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.query.RelationshipQuery<T> query)
org.picketlink.idm.model.Agent	getAgent(org.picketlink.idm.spi.SecurityContext context, String loginName)
<T extends Serializable> org.picketlink.idm.model.Attribute<T>	getAttribute(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.IdentityType identityType, String attributeName)
org.picketlink.idm.config.FileIdentityStoreConfiguration	getConfig()
protected FileDataSource	getDataSource()
org.picketlink.idm.model.Group	getGroup(org.picketlink.idm.spi.SecurityContext context, String groupPath)
org.picketlink.idm.model.Group	getGroup(org.picketlink.idm.spi.SecurityContext context, String name, org.picketlink.idm.model.Group parent)
protected Map<String,List<FileRelationship>>	getRelationshipsForCurrentPartition() Returns the stored Relationship instances for the current Partition.
org.picketlink.idm.model.Role	getRole(org.picketlink.idm.spi.SecurityContext context, String roleName)
org.picketlink.idm.model.User	getUser(org.picketlink.idm.spi.SecurityContext context, String loginName)
protected boolean	hasParentGroup(org.picketlink.idm.model.Group childGroup, org.picketlink.idm.model.Group parentGroup)
void	remove(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.AttributedType attributedType)
void	removeAttribute(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.IdentityType identityType, String attributeName)
void	removeCredentials(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.Agent agent) Remove all stored credentials for the given Agent.
<T extends org.picketlink.idm.credential.spi.CredentialStorage> List<T>	retrieveCredentials(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.Agent agent, Class<T> storageTyper)
<T extends org.picketlink.idm.credential.spi.CredentialStorage> T	retrieveCurrentCredential(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.Agent agent, Class<T> storageClass)
void	setAttribute(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.IdentityType identityType, org.picketlink.idm.model.Attribute<? extends Serializable> attribute)
void	setup(org.picketlink.idm.config.FileIdentityStoreConfiguration config)
void	storeCredential(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.Agent agent, org.picketlink.idm.credential.spi.CredentialStorage storage)
void	update(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.AttributedType attributedType)
void	updateCredential(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.Agent agent, Object credential, Date effectiveDate, Date expiryDate)
void	validateCredentials(org.picketlink.idm.spi.SecurityContext context, 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(org.picketlink.idm.config.FileIdentityStoreConfiguration config)

Specified by:

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

getConfig

public org.picketlink.idm.config.FileIdentityStoreConfiguration getConfig()

Specified by:

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

add

public void add(org.picketlink.idm.spi.SecurityContext context,
       org.picketlink.idm.model.AttributedType attributedType)

Specified by:

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

update

public void update(org.picketlink.idm.spi.SecurityContext context,
          org.picketlink.idm.model.AttributedType attributedType)

Specified by:

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

remove

public void remove(org.picketlink.idm.spi.SecurityContext context,
          org.picketlink.idm.model.AttributedType attributedType)

Specified by:

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

getAgent

public org.picketlink.idm.model.Agent getAgent(org.picketlink.idm.spi.SecurityContext context,
                                      String loginName)

Specified by:

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

getUser

public org.picketlink.idm.model.User getUser(org.picketlink.idm.spi.SecurityContext context,
                                    String loginName)

Specified by:

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

getRole

public org.picketlink.idm.model.Role getRole(org.picketlink.idm.spi.SecurityContext context,
                                    String roleName)

Specified by:

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

getGroup

public org.picketlink.idm.model.Group getGroup(org.picketlink.idm.spi.SecurityContext context,
                                      String groupPath)

Specified by:

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

getGroup

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

Specified by:

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

countQueryResults

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

Specified by:

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

getAttribute

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

Specified by:

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

setAttribute

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

Specified by:

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

removeAttribute

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

Specified by:

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

countQueryResults

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

Specified by:

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

fetchQueryResults

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

Specified by:

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

fetchQueryResults

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

Specified by:

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

convertToRelationship

protected <T extends org.picketlink.idm.model.Relationship> T convertToRelationship(org.picketlink.idm.spi.SecurityContext context,
                                                                        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)

getDataSource

protected FileDataSource getDataSource()

validateCredentials

public void validateCredentials(org.picketlink.idm.spi.SecurityContext context,
                       org.picketlink.idm.credential.Credentials credentials)

Specified by:

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

updateCredential

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

Specified by:

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

storeCredential

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

Specified by:

storeCredential in interface org.picketlink.idm.spi.CredentialStore<org.picketlink.idm.config.FileIdentityStoreConfiguration>

retrieveCurrentCredential

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

Specified by:

retrieveCurrentCredential in interface org.picketlink.idm.spi.CredentialStore<org.picketlink.idm.config.FileIdentityStoreConfiguration>

retrieveCredentials

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

Specified by:

retrieveCredentials in interface org.picketlink.idm.spi.CredentialStore<org.picketlink.idm.config.FileIdentityStoreConfiguration>

removeCredentials

public void removeCredentials(org.picketlink.idm.spi.SecurityContext context,
                     org.picketlink.idm.model.Agent agent)

Remove all stored credentials for the given Agent.

Parameters:

agent -