org.picketlink.idm.internal

Class DefaultPartitionManager

java.lang.Object

org.picketlink.idm.internal.AbstractAttributedTypeManager<Partition>

org.picketlink.idm.internal.DefaultPartitionManager

All Implemented Interfaces:

Serializable, AttributedTypeManager<Partition>, PartitionManager

public class DefaultPartitionManager
extends AbstractAttributedTypeManager<Partition>
implements PartitionManager

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

Modifier and Type	Method and Description
void	add(Partition attributedType)
void	add(Partition partition, String configurationName) Adds a new partition with a reference to the given configurationName.
protected void	checkIfExists(Partition partition)
protected void	checkUniqueness(Partition attributedType)
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.
protected void	doAdd(Partition attributedType)
protected void	doRemove(Partition attributedType)
protected void	doUpdate(Partition attributedType)
protected void	fireAttributedTypeAddedEvent(Partition attributedType)
protected void	fireAttributedTypeRemovedEvent(Partition attributedType)
protected void	fireAttributedTypeUpdatedEvent(Partition attributedType)
Collection<IdentityConfiguration>	getConfigurations() Retrieves the configuration used to build this PartitionManager.
IdentityContext	getIdentityContext()
<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.

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

addAttributes, createIdentityContext, fireEvent, getConfiguration, getEventBridge, getIdGenerator, getStoreSelector, remove, removeAllAttributes, removeAttributes, update

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.AttributedTypeManager

remove, update

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 AttributedTypeManager<Partition>

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:

If no AttributedType is found with the given identifier this method returns null.

fireAttributedTypeAddedEvent

protected void fireAttributedTypeAddedEvent(Partition attributedType)

Specified by:

fireAttributedTypeAddedEvent in class AbstractAttributedTypeManager<Partition>

doAdd

protected void doAdd(Partition attributedType)

Specified by:

doAdd in class AbstractAttributedTypeManager<Partition>

add

public void add(Partition attributedType)
         throws IdentityManagementException

Specified by:

add in interface AttributedTypeManager<Partition>

Overrides:

add in class AbstractAttributedTypeManager<Partition>

Throws:

IdentityManagementException

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.

fireAttributedTypeUpdatedEvent

protected void fireAttributedTypeUpdatedEvent(Partition attributedType)

Specified by:

fireAttributedTypeUpdatedEvent in class AbstractAttributedTypeManager<Partition>

doUpdate

protected void doUpdate(Partition attributedType)

Specified by:

doUpdate in class AbstractAttributedTypeManager<Partition>

fireAttributedTypeRemovedEvent

protected void fireAttributedTypeRemovedEvent(Partition attributedType)

Specified by:

fireAttributedTypeRemovedEvent in class AbstractAttributedTypeManager<Partition>

doRemove

protected void doRemove(Partition attributedType)

Specified by:

doRemove in class AbstractAttributedTypeManager<Partition>

checkUniqueness

protected void checkUniqueness(Partition attributedType)
                        throws IdentityManagementException

Specified by:

checkUniqueness in class AbstractAttributedTypeManager<Partition>

Throws:

IdentityManagementException

checkIfExists

protected void checkIfExists(Partition partition)
                      throws IdentityManagementException

Specified by:

checkIfExists in class AbstractAttributedTypeManager<Partition>

Throws:

IdentityManagementException

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.

getIdentityContext

public IdentityContext getIdentityContext()

Overrides:

getIdentityContext in class AbstractAttributedTypeManager<Partition>