org.picketlink.idm.internal

Class DefaultPartitionManager

java.lang.Object

org.picketlink.idm.internal.DefaultPartitionManager

All Implemented Interfaces:

Serializable, PartitionManager, StoreSelector

public class DefaultPartitionManager
extends Object
implements PartitionManager, StoreSelector

Provides partition management functionality, and partition-specific IdentityManager instances.

Before using this factory you need a valid IdentityConfiguration, usually created using the IdentityConfigurationBuilder.

This class is thread safe, and is intended to be used as an application-scoped component.

Author:

Shane Bryzak

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultPartitionManager(Collection<IdentityConfiguration> configurations)
DefaultPartitionManager(Collection<IdentityConfiguration> configurations, EventBridge eventBridge, Collection<PermissionHandler> permissionHandlers)
DefaultPartitionManager(Collection<IdentityConfiguration> configurations, EventBridge eventBridge, Collection<PermissionHandler> permissionHandlers, IdGenerator idGenerator)
DefaultPartitionManager(IdentityConfiguration configuration)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Partition partition) Adds a partition to the default configuration.
void	add(Partition partition, String configurationName) Adds a new partition with a reference to the given configurationName.
IdentityManager	createIdentityManager() Creates an IdentityManager instance for the default partition.
IdentityManager	createIdentityManager(Partition partition) Creates an IdentityManager for the specified partition.
PermissionManager	createPermissionManager() Creates a PermissionManager for the default partition.
PermissionManager	createPermissionManager(Partition partition) Creates a PermissionManager for the specified partition.
RelationshipManager	createRelationshipManager() Creates an RelationshipManager.
Collection<IdentityConfiguration>	getConfigurations() Retrieves the configuration used to build this PartitionManager.
<T extends Partition> T	getPartition(Class<T> partitionClass, String name) Return the partition specified by the partition class and name.
<T extends Partition> List<T>	getPartitions(Class<T> partitionClass) Return all Partition instances for a given partitionClass.
<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.
<T extends Partition> T	lookupById(Class<T> partitionClass, String id) Return the partition specified by the partition class and identifier.
<T extends IdentityStore<?>> T	lookupStore(IdentityContext context, IdentityConfiguration configuration, Class<? extends AttributedType> type, IdentityStoreConfiguration.IdentityOperation operation)
void	remove(Partition partition) Removes the specified partition.
void	update(Partition partition) Updates the attributes of the specified partition.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPartitionManager

public DefaultPartitionManager(IdentityConfiguration configuration)

DefaultPartitionManager

public DefaultPartitionManager(Collection<IdentityConfiguration> configurations)

DefaultPartitionManager

public DefaultPartitionManager(Collection<IdentityConfiguration> configurations,
                       EventBridge eventBridge,
                       Collection<PermissionHandler> permissionHandlers)

DefaultPartitionManager

public DefaultPartitionManager(Collection<IdentityConfiguration> configurations,
                       EventBridge eventBridge,
                       Collection<PermissionHandler> permissionHandlers,
                       IdGenerator idGenerator)

Method Detail

createIdentityManager

public IdentityManager createIdentityManager()
                                      throws IdentityManagementException

Description copied from interface: PartitionManager

Creates an IdentityManager instance for the default partition.

The default partition is always a Realm type with name Realm.DEFAULT_REALM. This partition must exists before calling this method, otherwise an exception will be thrown.

Specified by:

createIdentityManager in interface PartitionManager

Returns:

A partition-scoped IdentityManager instance for the default realm. The returned instance is not thread-safe.

Throws:

IdentityManagementException - if the default partition does not exists or any error occurs during the creation of the IdentityManager instance.

createIdentityManager

public IdentityManager createIdentityManager(Partition partition)
                                      throws IdentityManagementException

Description copied from interface: PartitionManager

Creates an IdentityManager for the specified partition.

Specified by:

createIdentityManager in interface PartitionManager

Parameters:

partition - The partition instance where identity management operations will be scoped. The given partition must exists before calling this method, otherwise an exception will be thrown.

Returns:

A partition-scoped IdentityManager instance for a given partition. The returned instance is not thread-safe.

Throws:

IdentityManagementException - if the default partition does not exists or any error occurs during the creation of the instance.

createPermissionManager

public PermissionManager createPermissionManager()

Description copied from interface: PartitionManager

Creates a PermissionManager for the default partition.

Specified by:

createPermissionManager in interface PartitionManager

Returns:

createPermissionManager

public PermissionManager createPermissionManager(Partition partition)
                                          throws IdentityManagementException

Description copied from interface: PartitionManager

Creates a PermissionManager for the specified partition.

Specified by:

createPermissionManager in interface PartitionManager

Parameters:

partition - The partition instance where permission operations will be scoped. The given partition must exists before calling this method, otherwise an exception will be thrown.

Returns:

A partition-scoped PermissionManager instance for a given partition.

Throws:

IdentityManagementException - if the default partition does not exists or any error occurs during the creation of the instance.

createRelationshipManager

public RelationshipManager createRelationshipManager()

Description copied from interface: PartitionManager

Creates an RelationshipManager.

Specified by:

createRelationshipManager in interface PartitionManager

getPartition

public <T extends Partition> T getPartition(Class<T> partitionClass,
                                   String name)

Description copied from interface: PartitionManager

Return the partition specified by the partition class and name.

Specified by:

getPartition in interface PartitionManager

Parameters:

partitionClass - It can be any sub-type of Partition. In this case only partitions of a specific sub-type will be considered. If it equals the Partition type this method may return any of its sub-types.

name - The name of the partition. It can not me null.

Returns:

getPartitions

public <T extends Partition> List<T> getPartitions(Class<T> partitionClass)

Description copied from interface: PartitionManager

Return all Partition instances for a given partitionClass.

Specified by:

getPartitions in interface PartitionManager

Parameters:

partitionClass - It can be any sub-type of Partition. In this case only partitions of a specific sub-type will be considered. If it equals the Partition type this method may return any of its sub-types.

Returns:

lookupById

public <T extends Partition> T lookupById(Class<T> partitionClass,
                                 String id)

Description copied from interface: PartitionManager

Return the partition specified by the partition class and identifier.

If partitionClass equals the Partition type this method may return any of its sub-types with the given id.

Specified by:

lookupById in interface PartitionManager

Parameters:

partitionClass - It can be any sub-type of Partition. In this case only partitions of a specific sub-type will be considered. If it equals the Partition type this method may return any of its sub-types.

id - The identifier of the partition. It can not be null.

Returns:

add

public void add(Partition partition)
         throws IdentityManagementException

Description copied from interface: PartitionManager

Adds a partition to the default configuration.

Only a single configuration may support partition. In this case the partition will be always created with a reference to this configuration.

Specified by:

add in interface PartitionManager

Throws:

IdentityManagementException - if any error occurs during the creation.

add

public void add(Partition partition,
       String configurationName)
         throws IdentityManagementException

Description copied from interface: PartitionManager

Adds a new partition with a reference to the given configurationName.

Specified by:

add in interface PartitionManager

Throws:

IdentityManagementException - if the configurationName does not exists or if any error occurs during the creation.

update

public void update(Partition partition)
            throws IdentityManagementException

Description copied from interface: PartitionManager

Updates the attributes of the specified partition.

Specified by:

update in interface PartitionManager

Parameters:

partition - The given partition must exists before calling this method, otherwise an exception will be thrown.

Throws:

IdentityManagementException - if no partition exists or if any error occurs during the update.

remove

public void remove(Partition partition)
            throws IdentityManagementException

Description copied from interface: PartitionManager

Removes the specified partition.

Before calling this method make sure the partition references a valid instance that points to a partition already stored with its identifier.

Specified by:

remove in interface PartitionManager

Parameters:

partition - The given partition must exists before calling this method, otherwise an exception will be thrown.

Throws:

IdentityManagementException - if no partition exists or if any error occurs during the update.

getConfigurations

public Collection<IdentityConfiguration> getConfigurations()

Description copied from interface: PartitionManager

Retrieves the configuration used to build this PartitionManager.

Specified by:

getConfigurations in interface PartitionManager

Returns:

A collection with all the configuration used to build this partition manager.

getStoreForIdentityOperation

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

Specified by:

getStoreForIdentityOperation in interface StoreSelector

Returns:

getStoresForIdentityQuery

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

Description copied from interface: StoreSelector

Returns all available IdentityStore instances that support the given IdentityType.

Specified by:

getStoresForIdentityQuery in interface StoreSelector

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.

lookupStore

public <T extends IdentityStore<?>> T lookupStore(IdentityContext context,
                                         IdentityConfiguration configuration,
                                         Class<? extends AttributedType> type,
                                         IdentityStoreConfiguration.IdentityOperation operation)

getStoreForCredentialOperation

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

Specified by:

getStoreForCredentialOperation in interface StoreSelector

Returns:

getStoreForRelationshipOperation

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

Description copied from interface: StoreSelector

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

Specified by:

getStoreForRelationshipOperation in interface StoreSelector

Returns:

getStoresForRelationshipQuery

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

Description copied from interface: StoreSelector

Returns all available IdentityStore instances that support the given IdentityType.

Specified by:

getStoresForRelationshipQuery in interface StoreSelector

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.

getStoreForPartitionOperation

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

Description copied from interface: StoreSelector

Returns the PartitionStore that manages partitions.

Specified by:

getStoreForPartitionOperation in interface StoreSelector

Returns:

getStoreForAttributeOperation

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

Description copied from interface: StoreSelector

Returns the AttributeStore that manages attributes.

Specified by:

getStoreForAttributeOperation in interface StoreSelector

Returns:

getStoresForCredentialStorage

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

Description copied from interface: StoreSelector

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

Specified by:

getStoresForCredentialStorage in interface StoreSelector

Returns:

getStoreForPermissionOperation

public PermissionStore getStoreForPermissionOperation(IdentityContext context)

Description copied from interface: StoreSelector

Returns a PermissionStore instance

Specified by:

getStoreForPermissionOperation in interface StoreSelector

Returns: