org.picketlink.idm

Interface PartitionManager

All Superinterfaces:

Serializable

All Known Implementing Classes:

DefaultPartitionManager

public interface PartitionManager
extends Serializable

Provides partition management operations and serves as a start point for managing identity data (eg.: users, roles, credentials, etc) by providing factory methods for creating IdentityManager and RelationshipManager instances, respectively.

Partition management is only enabled if one of the provided configurations supports the Partition type or any of its sub-types. Otherwise, all operations will behave in the context of the default partition. Only a single configuration can support partitions.

Each partition is linked to a single configuration name, what means that all operations on that partition will be done using the stores for this specific configuration.

Eg.: Partition A is using a file-store configuration and Partition B is using a jpa-store configuration. See the Configuration API for more details about providing multiple configurations.

Implementations of this interface should be thread-safe.

Author:

Shane Bryzak

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 Partition> T	lookupById(Class<T> partitionClass, String id) Return the partition specified by the partition class and identifier.
void	remove(Partition partition) Removes the specified partition.
void	update(Partition partition) Updates the attributes of the specified partition.

Method Detail

createIdentityManager

IdentityManager createIdentityManager()
                                      throws IdentityManagementException

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.

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

IdentityManager createIdentityManager(Partition partition)
                                      throws IdentityManagementException

Creates an IdentityManager for the specified partition.

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

PermissionManager createPermissionManager()
                                          throws IdentityManagementException

Creates a PermissionManager for the default partition.

Returns:

Throws:

IdentityManagementException - If any error occurs during the creation of the instance.

createPermissionManager

PermissionManager createPermissionManager(Partition partition)
                                          throws IdentityManagementException

Creates a PermissionManager for the specified partition.

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

RelationshipManager createRelationshipManager()
                                              throws IdentityManagementException

Creates an RelationshipManager.

Throws:

IdentityManagementException - if any error occurs during the creation of the instance.

getPartition

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

Return the partition specified by the partition class and name.

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:

Throws:

IdentityManagementException - if any error occurs during the retrieval.

getPartitions

<T extends Partition> List<T> getPartitions(Class<T> partitionClass)
                                        throws IdentityManagementException

Return all Partition instances for a given partitionClass.

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:

Throws:

IdentityManagementException - if any error occurs during the retrieval.

lookupById

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

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.

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:

Throws:

IdentityManagementException - if any error occurs during the retrieval.

add

void add(Partition partition)
         throws IdentityManagementException

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.

Parameters:

partition -

Throws:

IdentityManagementException - if any error occurs during the creation.

add

void add(Partition partition,
       String configurationName)
         throws IdentityManagementException

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

Parameters:

partition -

configurationName -

Throws:

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

update

void update(Partition partition)
            throws IdentityManagementException

Updates the attributes of the specified partition.

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

void remove(Partition partition)
            throws IdentityManagementException

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.

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

Collection<IdentityConfiguration> getConfigurations()

Retrieves the configuration used to build this PartitionManager.

Returns:

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