org.picketlink.idm.file.internal

Class FileIdentityStore

java.lang.Object

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

org.picketlink.idm.internal.AbstractAttributeStore<FileIdentityStoreConfiguration>

org.picketlink.idm.file.internal.FileIdentityStore

All Implemented Interfaces:

PermissionStore, AttributeStore<FileIdentityStoreConfiguration>, CredentialStore<FileIdentityStoreConfiguration>, IdentityStore<FileIdentityStoreConfiguration>, PartitionStore<FileIdentityStoreConfiguration>

@CredentialHandlers(value={PasswordCredentialHandler.class,X509CertificateCredentialHandler.class,DigestCredentialHandler.class,TOTPCredentialHandler.class,TokenCredentialHandler.class})
public class FileIdentityStore
extends AbstractAttributeStore<FileIdentityStoreConfiguration>
implements PartitionStore<FileIdentityStoreConfiguration>, CredentialStore<FileIdentityStoreConfiguration>, AttributeStore<FileIdentityStoreConfiguration>, PermissionStore

File based IdentityStore implementation.

Author:

Pedro Silva

Constructor Summary

Constructors

Constructor and Description
FileIdentityStore()

Method Summary

Modifier and Type	Method and Description
void	add(IdentityContext identityContext, Partition partition, String configurationName)
void	addAttributedType(IdentityContext context, AttributedType attributedType)
void	doSetAttribute(IdentityContext context, AttributedType type, Attribute<? extends Serializable> attribute)
<V extends IdentityType> List<V>	fetchQueryResults(IdentityContext context, IdentityQuery<V> identityQuery)
<T extends Relationship> List<T>	fetchQueryResults(IdentityContext context, RelationshipQuery<T> query)
<P extends Partition> List<P>	get(IdentityContext identityContext, Class<P> partitionClass)
<P extends Partition> P	get(IdentityContext identityContext, Class<P> partitionClass, String name)
protected Collection<Attribute<? extends Serializable>>	getAttributes(IdentityContext context, AttributedType attributedType)
String	getConfigurationName(IdentityContext identityContext, Partition partition)
boolean	grantPermission(IdentityContext context, IdentityType assignee, Object resource, String operation) Grants the specified permission
List<Permission>	listPermissions(IdentityContext context, Class<?> resourceClass, Serializable identifier) Returns a List containing all the permissions for a resource that has not yet been loaded, using the specified resource class and resource identifier value.
List<Permission>	listPermissions(IdentityContext context, Class<?> resourceClass, Serializable identifier, String operation) Returns a List containing all the permissions for a resource that has not yet been loaded, using the specified resource class and resource identifier value, with the specified operation.
List<Permission>	listPermissions(IdentityContext context, IdentityType identityType) Returns a list of all Permission for the given IdentityType.
List<Permission>	listPermissions(IdentityContext context, Object resource) Returns a List value containing all permissions for the specified resource.
List<Permission>	listPermissions(IdentityContext context, Object resource, String operation) Returns a List value containing all permissions for the specified resource, having the specified operation
List<Permission>	listPermissions(IdentityContext context, Set<Object> resources, String operation) Returns a List value containing all permissions for all of the specified resource, having the specified operation
<P extends Partition> P	lookupById(IdentityContext context, Class<P> partitionClass, String id)
void	remove(IdentityContext identityContext, Partition partition)
void	removeAttribute(IdentityContext context, AttributedType type, String attributeName) Removes the specified Attribute value, for the specified IdentityType
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	revokeAllPermissions(IdentityContext context, Object resource) Revokes all permissions for the specified resource
boolean	revokePermission(IdentityContext context, IdentityType assignee, Object resource, String operation) Revokes the specified permission
void	setup(FileIdentityStoreConfiguration configuration) 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)
void	updateAttributedType(IdentityContext context, AttributedType attributedType)

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

getAttribute, loadAttributes, setAttribute

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

add, countQueryResults, countQueryResults, 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.AttributeStore

getAttribute, loadAttributes, setAttribute

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

add, countQueryResults, countQueryResults, getConfig, remove, update, updateCredential, validateCredentials

Constructor Detail

FileIdentityStore

public FileIdentityStore()

Method Detail

setup

public void setup(FileIdentityStoreConfiguration configuration)

Description copied from interface: IdentityStore

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

Specified by:

setup in interface IdentityStore<FileIdentityStoreConfiguration>

Overrides:

setup in class AbstractIdentityStore<FileIdentityStoreConfiguration>

removeFromRelationships

protected void removeFromRelationships(IdentityContext context,
                                       IdentityType identityType)

Specified by:

removeFromRelationships in class AbstractIdentityStore<FileIdentityStoreConfiguration>

removeCredentials

protected void removeCredentials(IdentityContext context,
                                 Account account)

Specified by:

removeCredentials in class AbstractIdentityStore<FileIdentityStoreConfiguration>

addAttributedType

public void addAttributedType(IdentityContext context,
                              AttributedType attributedType)

Overrides:

addAttributedType in class AbstractIdentityStore<FileIdentityStoreConfiguration>

updateAttributedType

public void updateAttributedType(IdentityContext context,
                                 AttributedType attributedType)

Specified by:

updateAttributedType in class AbstractIdentityStore<FileIdentityStoreConfiguration>

removeAttributedType

public void removeAttributedType(IdentityContext context,
                                 AttributedType attributedType)

Specified by:

removeAttributedType in class AbstractIdentityStore<FileIdentityStoreConfiguration>

getConfigurationName

public String getConfigurationName(IdentityContext identityContext,
                                   Partition partition)

Specified by:

getConfigurationName in interface PartitionStore<FileIdentityStoreConfiguration>

get

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

Specified by:

get in interface PartitionStore<FileIdentityStoreConfiguration>

get

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

Specified by:

get in interface PartitionStore<FileIdentityStoreConfiguration>

lookupById

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

Specified by:

lookupById in interface PartitionStore<FileIdentityStoreConfiguration>

add

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

Specified by:

add in interface PartitionStore<FileIdentityStoreConfiguration>

update

public void update(IdentityContext identityContext,
                   Partition partition)

Specified by:

update in interface PartitionStore<FileIdentityStoreConfiguration>

remove

public void remove(IdentityContext identityContext,
                   Partition partition)

Specified by:

remove in interface PartitionStore<FileIdentityStoreConfiguration>

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<FileIdentityStoreConfiguration>

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<FileIdentityStoreConfiguration>

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<FileIdentityStoreConfiguration>

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<FileIdentityStoreConfiguration>

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<FileIdentityStoreConfiguration>

fetchQueryResults

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

Specified by:

fetchQueryResults in interface IdentityStore<FileIdentityStoreConfiguration>

doSetAttribute

public void doSetAttribute(IdentityContext context,
                           AttributedType type,
                           Attribute<? extends Serializable> attribute)

Specified by:

doSetAttribute in class AbstractAttributeStore<FileIdentityStoreConfiguration>

removeAttribute

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

Description copied from interface: AttributeStore

Removes the specified Attribute value, for the specified IdentityType

Specified by:

removeAttribute in interface AttributeStore<FileIdentityStoreConfiguration>

getAttributes

protected Collection<Attribute<? extends Serializable>> getAttributes(IdentityContext context,
                                                                      AttributedType attributedType)

Specified by:

getAttributes in class AbstractAttributeStore<FileIdentityStoreConfiguration>

listPermissions

public List<Permission> listPermissions(IdentityContext context,
                                        Object resource)

Description copied from interface: PermissionStore

Returns a List value containing all permissions for the specified resource.

Specified by:

listPermissions in interface PermissionStore

Returns:

listPermissions

public List<Permission> listPermissions(IdentityContext context,
                                        IdentityType identityType)

Description copied from interface: PermissionStore

Returns a list of all Permission for the given IdentityType.

Specified by:

listPermissions in interface PermissionStore

Returns:

listPermissions

public List<Permission> listPermissions(IdentityContext context,
                                        Object resource,
                                        String operation)

Description copied from interface: PermissionStore

Returns a List value containing all permissions for the specified resource, having the specified operation

Specified by:

listPermissions in interface PermissionStore

Returns:

listPermissions

public List<Permission> listPermissions(IdentityContext context,
                                        Set<Object> resources,
                                        String operation)

Description copied from interface: PermissionStore

Returns a List value containing all permissions for all of the specified resource, having the specified operation

Specified by:

listPermissions in interface PermissionStore

Returns:

listPermissions

public List<Permission> listPermissions(IdentityContext context,
                                        Class<?> resourceClass,
                                        Serializable identifier)

Description copied from interface: PermissionStore

Returns a List containing all the permissions for a resource that has not yet been loaded, using the specified resource class and resource identifier value.

Specified by:

listPermissions in interface PermissionStore

Returns:

listPermissions

public List<Permission> listPermissions(IdentityContext context,
                                        Class<?> resourceClass,
                                        Serializable identifier,
                                        String operation)

Description copied from interface: PermissionStore

Returns a List containing all the permissions for a resource that has not yet been loaded, using the specified resource class and resource identifier value, with the specified operation.

Specified by:

listPermissions in interface PermissionStore

Returns:

grantPermission

public boolean grantPermission(IdentityContext context,
                               IdentityType assignee,
                               Object resource,
                               String operation)

Description copied from interface: PermissionStore

Grants the specified permission

Specified by:

grantPermission in interface PermissionStore

Returns:

revokePermission

public boolean revokePermission(IdentityContext context,
                                IdentityType assignee,
                                Object resource,
                                String operation)

Description copied from interface: PermissionStore

Revokes the specified permission

Specified by:

revokePermission in interface PermissionStore

Returns:

revokeAllPermissions

public void revokeAllPermissions(IdentityContext context,
                                 Object resource)

Description copied from interface: PermissionStore

Revokes all permissions for the specified resource

Specified by:

revokeAllPermissions in interface PermissionStore