org.picketlink.idm.config

Class FeatureSet

java.lang.Object

org.picketlink.idm.config.FeatureSet

public class FeatureSet
extends Object

Defines the feature set for an IdentityStore implementation

Author:

Shane Bryzak

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FeatureSet.FeatureGroup
static class	FeatureSet.FeatureOperation

Constructor Summary

Constructors

Constructor and Description
FeatureSet()

Method Summary

Methods

Modifier and Type	Method and Description
void	addFeature(FeatureSet.FeatureGroup feature, FeatureSet.FeatureOperation operation) Adds the given FeatureSet.FeatureOperation for the provided FeatureSet.FeatureGroup.
static void	addFeatureSupport(FeatureSet featureSet, FeatureSet.FeatureGroup... groups) Adds the given FeatureSet.FeatureGroup values to the provided FeatureSet.
void	addRelationshipFeature(Class<? extends Relationship> relationshipClass, FeatureSet.FeatureOperation operation) Configures the given FeatureSet.FeatureOperation for the provided Relationship type.
static void	addRelationshipSupport(FeatureSet featureSet, Class<? extends Relationship>... relationshipClass) Adds the given Relationship types to the provided FeatureSet.
protected static List<Class<? extends Relationship>>	getDefaultRelationshipClasses()
Map<FeatureSet.FeatureGroup,Set<FeatureSet.FeatureOperation>>	getSupportedFeatures()
Map<Class<? extends Relationship>,Set<FeatureSet.FeatureOperation>>	getSupportedRelationships()
protected void	lock()
void	removeFeature(FeatureSet.FeatureGroup feature) Removes the given FeatureSet.FeatureGroup and all supported FeatureSet.FeatureOperation from the features set.
void	removeFeature(FeatureSet.FeatureGroup feature, FeatureSet.FeatureOperation operation) Removes the given FeatureSet.FeatureOperation for the provided FeatureSet.FeatureGroup from the features set.
void	removeRelationshipFeature(Class<? extends Relationship> relationshipClass, FeatureSet.FeatureOperation operation) Removes the given FeatureSet.FeatureOperation related to the provided Relationship type from the feature set.
static void	removeRelationshipSupport(FeatureSet featureSet, Class<? extends Relationship>... relationshipClasses) Removes the given Relationship types from the provided FeatureSet.
void	setSupportsCustomRelationships(boolean value)
void	setSupportsMultiRealm(boolean value)
boolean	supports(FeatureSet.FeatureGroup feature) Check if the FeatureSet.FeatureGroup is supported.
boolean	supports(FeatureSet.FeatureGroup feature, FeatureSet.FeatureOperation operation) Check if the FeatureSet.FeatureGroup and the given FeatureSet.FeatureOperation are supported.
boolean	supportsMultiRealm() Indicates if multi realms are supported or not.
boolean	supportsRelationship(Class<? extends Relationship> relationshipClass) Check if the given Relationship type is supported.
boolean	supportsRelationshipFeature(Class<? extends Relationship> relationshipClass, FeatureSet.FeatureOperation operation) Check if the given FeatureSet.FeatureOperation is supported for the provided Relationship type.

Methods inherited from class java.lang.Object

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

Constructor Detail

FeatureSet

public FeatureSet()

Method Detail

addFeature

public void addFeature(FeatureSet.FeatureGroup feature,
              FeatureSet.FeatureOperation operation)
                throws SecurityConfigurationException

Adds the given FeatureSet.FeatureOperation for the provided FeatureSet.FeatureGroup.

Parameters:

feature -

operation -

Throws:

SecurityConfigurationException - If this instance is locked and changes are no more allowed.

removeFeature

public void removeFeature(FeatureSet.FeatureGroup feature,
                 FeatureSet.FeatureOperation operation)
                   throws SecurityConfigurationException

Removes the given FeatureSet.FeatureOperation for the provided FeatureSet.FeatureGroup from the features set.

Parameters:

feature -

operation -

Throws:

SecurityConfigurationException - If this instance is locked and changes are no more allowed.

removeFeature

public void removeFeature(FeatureSet.FeatureGroup feature)
                   throws SecurityConfigurationException

Removes the given FeatureSet.FeatureGroup and all supported FeatureSet.FeatureOperation from the features set.

Parameters:

feature -

Throws:

SecurityConfigurationException - If this instance is locked and changes are no more allowed.

supports

public boolean supports(FeatureSet.FeatureGroup feature,
               FeatureSet.FeatureOperation operation)

Check if the FeatureSet.FeatureGroup and the given FeatureSet.FeatureOperation are supported.

Parameters:

feature -

operation -

Returns:

supports

public boolean supports(FeatureSet.FeatureGroup feature)

Check if the FeatureSet.FeatureGroup is supported.

Parameters:

feature -

operation -

Returns:

addRelationshipFeature

public void addRelationshipFeature(Class<? extends Relationship> relationshipClass,
                          FeatureSet.FeatureOperation operation)

Configures the given FeatureSet.FeatureOperation for the provided Relationship type.

Parameters:

feature -

operation -

Throws:

SecurityConfigurationException - If this instance is locked and changes are no more allowed.

removeRelationshipFeature

public void removeRelationshipFeature(Class<? extends Relationship> relationshipClass,
                             FeatureSet.FeatureOperation operation)

Removes the given FeatureSet.FeatureOperation related to the provided Relationship type from the feature set.

Parameters:

feature -

operation -

Throws:

SecurityConfigurationException - If this instance is locked and changes are no more allowed.

supportsRelationshipFeature

public boolean supportsRelationshipFeature(Class<? extends Relationship> relationshipClass,
                                  FeatureSet.FeatureOperation operation)

Check if the given FeatureSet.FeatureOperation is supported for the provided Relationship type.

Parameters:

feature -

operation -

Returns:

supportsRelationship

public boolean supportsRelationship(Class<? extends Relationship> relationshipClass)

Check if the given Relationship type is supported.

Parameters:

feature -

Returns:

supportsMultiRealm

public boolean supportsMultiRealm()

Indicates if multi realms are supported or not.

Returns:

setSupportsCustomRelationships

public void setSupportsCustomRelationships(boolean value)

setSupportsMultiRealm

public void setSupportsMultiRealm(boolean value)

getSupportedFeatures

public Map<FeatureSet.FeatureGroup,Set<FeatureSet.FeatureOperation>> getSupportedFeatures()

getSupportedRelationships

public Map<Class<? extends Relationship>,Set<FeatureSet.FeatureOperation>> getSupportedRelationships()

lock

protected void lock()

addFeatureSupport

public static void addFeatureSupport(FeatureSet featureSet,
                     FeatureSet.FeatureGroup... groups)

Adds the given FeatureSet.FeatureGroup values to the provided FeatureSet.

Parameters:

featureSet -

groups -

addRelationshipSupport

public static void addRelationshipSupport(FeatureSet featureSet,
                          Class<? extends Relationship>... relationshipClass)

Adds the given Relationship types to the provided FeatureSet. If you do not provide any class only the default ones will be added.

Parameters:

featureSet -

relationshipClass -

removeRelationshipSupport

public static void removeRelationshipSupport(FeatureSet featureSet,
                             Class<? extends Relationship>... relationshipClasses)

Removes the given Relationship types from the provided FeatureSet.

Parameters:

featureSet -

relationshipClass -

getDefaultRelationshipClasses

protected static List<Class<? extends Relationship>> getDefaultRelationshipClasses()