org.picketlink.idm.spi

Interface StoreSelector

public interface StoreSelector

Returns the correct IdentityStore instances for certain operation types, for a given Partition

Author:

Shane Bryzak

Method Summary

Methods

Modifier and Type	Method and Description
<T extends AttributeStore<?>> T	getStoreForAttributeOperation(IdentityContext context) Returns the AttributeStore that manages attributes.
<T extends CredentialStore<?>> T	getStoreForCredentialOperation(IdentityContext context, Class<?> credentialClass)
<T extends IdentityStore<?>> T	getStoreForIdentityOperation(IdentityContext context, Class<T> storeType, Class<? extends AttributedType> type, IdentityStoreConfiguration.IdentityOperation operation)
<T extends PartitionStore<?>> T	getStoreForPartitionOperation(IdentityContext context, Class<? extends Partition> partitionClass) Returns the PartitionStore that manages partitions.
PermissionStore	getStoreForPermissionOperation(IdentityContext context) Returns a PermissionStore instance
IdentityStore<?>	getStoreForRelationshipOperation(IdentityContext context, Class<? extends Relationship> relationshipClass, Relationship relationship, IdentityStoreConfiguration.IdentityOperation operation) Returns the IdentityStore that manages relationships of the specified type, for the specified partition/s.
Set<CredentialStore<?>>	getStoresForCredentialStorage(IdentityContext context, Class<? extends CredentialStorage> storageClass) Returns all available CredentialStore instances that support the given CredentialStorage type.
Set<IdentityStore<?>>	getStoresForIdentityQuery(IdentityContext context, Class<? extends IdentityType> identityType) Returns all available IdentityStore instances that support the given IdentityType.
Set<IdentityStore<?>>	getStoresForRelationshipQuery(IdentityContext context, Class<? extends Relationship> relationshipClass, Set<Partition> partitions) Returns all available IdentityStore instances that support the given IdentityType.

Method Detail

getStoreForIdentityOperation

<T extends IdentityStore<?>> T getStoreForIdentityOperation(IdentityContext context,
                                                          Class<T> storeType,
                                                          Class<? extends AttributedType> type,
                                                          IdentityStoreConfiguration.IdentityOperation operation)

Parameters:

context -

feature -

operation -

Returns:

getStoreForCredentialOperation

<T extends CredentialStore<?>> T getStoreForCredentialOperation(IdentityContext context,
                                                              Class<?> credentialClass)

Parameters:

context -

Returns:

getStoreForRelationshipOperation

IdentityStore<?> getStoreForRelationshipOperation(IdentityContext context,
                                                Class<? extends Relationship> relationshipClass,
                                                Relationship relationship,
                                                IdentityStoreConfiguration.IdentityOperation operation)

Returns the IdentityStore that manages relationships of the specified type, for the specified partition/s.

Parameters:

relationship -

Returns:

getStoresForRelationshipQuery

Set<IdentityStore<?>> getStoresForRelationshipQuery(IdentityContext context,
                                                  Class<? extends Relationship> relationshipClass,
                                                  Set<Partition> partitions)
                                                    throws IdentityManagementException

Returns all available IdentityStore instances that support the given IdentityType.

Parameters:

context - The current context.

relationshipClass - The type used to restrict which stores should be selected and returned. If the value is IdentityType all stores that support any subtype of this interface will be returned.

partitions - A set with the partitions that should be used to restrict which stores should be selected. If empty only the type will be considered.

Returns:

A list of stores that support the given type.

Throws:

IdentityManagementException - If no store was found.

getStoreForPermissionOperation

PermissionStore getStoreForPermissionOperation(IdentityContext context)

Returns a PermissionStore instance

Parameters:

context -

Returns:

getStoreForPartitionOperation

<T extends PartitionStore<?>> T getStoreForPartitionOperation(IdentityContext context,
                                                            Class<? extends Partition> partitionClass)

Returns the PartitionStore that manages partitions.

Returns:

getStoreForAttributeOperation

<T extends AttributeStore<?>> T getStoreForAttributeOperation(IdentityContext context)

Returns the AttributeStore that manages attributes.

Returns:

getStoresForCredentialStorage

Set<CredentialStore<?>> getStoresForCredentialStorage(IdentityContext context,
                                                    Class<? extends CredentialStorage> storageClass)

Returns all available CredentialStore instances that support the given CredentialStorage type.

Parameters:

context -

Returns:

getStoresForIdentityQuery

Set<IdentityStore<?>> getStoresForIdentityQuery(IdentityContext context,
                                              Class<? extends IdentityType> identityType)
                                                throws IdentityManagementException

Returns all available IdentityStore instances that support the given IdentityType.

Parameters:

context - The current context.

identityType - The type used to restrict which stores should be selected and returned. If the value is IdentityType all stores that support any subtype of this interface will be returned.

Returns:

A list of stores that support the given type.

Throws:

IdentityManagementException - If no store was found.