Package com.sun.identity.entitlement.opensso

Class EntitlementService

java.lang.Object

com.sun.identity.entitlement.opensso.EntitlementService

All Implemented Interfaces:

EntitlementConfiguration

public class EntitlementService
extends Object
implements EntitlementConfiguration

Field Summary

Fields

Modifier and Type	Field	Description
static String	APPLICATION_CLASSNAME
static String	ATTR_NAME_META
static String	ATTR_NAME_SUBJECT_ATTR_NAMES
static String	CONFIG_CONDITIONS
static String	CONFIG_ENTITLEMENT_COMBINER
static String	CONFIG_RESOURCE_COMP_IMPL
static String	CONFIG_SAVE_INDEX_IMPL
static String	CONFIG_SEARCH_INDEX_IMPL
static String	CONFIG_SUBJECTS
static String	SERVICE_NAME	Entitlement Service name.

Fields inherited from interface com.sun.identity.entitlement.EntitlementConfiguration

INDEX_CACHE_SIZE, POLICY_CACHE_SIZE, POLICY_EVAL_THREAD_SIZE, POLICY_SEARCH_THREAD_SIZE

Constructor Summary

Constructors

Constructor	Description
EntitlementService(Subject subject, String realm, NotificationBroker broker)	Construct a new instance of EntitlementService.

Method Summary

Modifier and Type	Method	Description
void	addSubjectAttributeNames(String applicationName, Set<String> names)	Returns subject attribute names.
Application	getApplication(String name)	Returns the application with the specified name.
Set<Application>	getApplications()	Returns a set of registered applications.
Set<ApplicationType>	getApplicationTypes()	Returns a set of registered application type.
Set<String>	getConfiguration(String attrName)	Returns set of attribute values of a given attribute name,
static int	getConfiguration(String attrName, int defaultValue)
int	getPolicyWindowSize()	Informs us of the size of the policy window set in the configurable options.
Set<String>	getSubjectAttributeNames(String application)	Returns subject attribute names.
Map<String,Set<String>>	getSubjectAttributesCollectorConfiguration(String name)	Returns subject attributes collector configuration.
boolean	hasEntitlementDITs()	Returns true if OpenAM policy data is migrated to a form that entitlements service can operates on them.
boolean	isMonitoringRunning()	Whether the overall monitoring framework is enabled and running.
boolean	networkMonitorEnabled()	Returns true if the network monitoring for entitlements is enabled
void	reindexApplications()	Reindex Applications.
void	removeApplication(String name)	Removes application.
void	removeApplicationType(String name)	Removes application type.
Set<Application>	searchApplications(Subject subject, org.forgerock.util.query.QueryFilter<String> queryFilter)	Returns a set of applications for the given search criteria.
void	setNetworkMonitorEnabled(boolean enabled)	Allows the network monitoring to be enabled/disabled
void	setSubjectAttributesCollectorConfiguration(String name, Map<String,Set<String>> attrMap)	Sets subject attributes collector configuration.
void	storeApplication(Application appl)	Stores the application to data store.
void	storeApplicationType(ApplicationType applicationType)	Stores the application type to data store.
boolean	xacmlPrivilegeEnabled()	Returns true if the system stores privileges in XACML format and supports exporting privileges in XACML format

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_NAME

public static final String SERVICE_NAME

Entitlement Service name.

See Also:

Constant Field Values

ATTR_NAME_SUBJECT_ATTR_NAMES

public static final String ATTR_NAME_SUBJECT_ATTR_NAMES

See Also:

Constant Field Values

ATTR_NAME_META

public static final String ATTR_NAME_META

See Also:

Constant Field Values

CONFIG_CONDITIONS

public static final String CONFIG_CONDITIONS

See Also:

Constant Field Values

CONFIG_SUBJECTS

public static final String CONFIG_SUBJECTS

See Also:

Constant Field Values

CONFIG_ENTITLEMENT_COMBINER

public static final String CONFIG_ENTITLEMENT_COMBINER

See Also:

Constant Field Values

CONFIG_SEARCH_INDEX_IMPL

public static final String CONFIG_SEARCH_INDEX_IMPL

See Also:

Constant Field Values

CONFIG_SAVE_INDEX_IMPL

public static final String CONFIG_SAVE_INDEX_IMPL

See Also:

Constant Field Values

CONFIG_RESOURCE_COMP_IMPL

public static final String CONFIG_RESOURCE_COMP_IMPL

See Also:

Constant Field Values

APPLICATION_CLASSNAME

public static final String APPLICATION_CLASSNAME

See Also:

Constant Field Values

Constructor Detail

EntitlementService

@Inject
public EntitlementService(Subject subject,
                          String realm,
                          NotificationBroker broker)

Construct a new instance of EntitlementService.

Parameters:

subject - the calling subject

realm - the realm

broker - the notification broker for notifying the policyset changes

Method Detail

getConfiguration

public Set<String> getConfiguration(String attrName)

Returns set of attribute values of a given attribute name,

Specified by:

getConfiguration in interface EntitlementConfiguration

Parameters:

attrName - attribute name.

Returns:

set of attribute values of a given attribute name,

getConfiguration

public static int getConfiguration(String attrName,
                                   int defaultValue)

getApplicationTypes

public Set<ApplicationType> getApplicationTypes()

Returns a set of registered application type.

Specified by:

getApplicationTypes in interface EntitlementConfiguration

Returns:

A set of registered application type.

searchApplications

public Set<Application> searchApplications(Subject subject,
                                           org.forgerock.util.query.QueryFilter<String> queryFilter)
                                    throws EntitlementException

Description copied from interface: EntitlementConfiguration

Returns a set of applications for the given search criteria.

Specified by:

searchApplications in interface EntitlementConfiguration

Parameters:

subject - Admin Subject

queryFilter - Query filter.

Returns:

a set of applications for the given search criteria.

Throws:

EntitlementException - if search failed.

getApplication

public Application getApplication(String name)

Description copied from interface: EntitlementConfiguration

Returns the application with the specified name.

Specified by:

getApplication in interface EntitlementConfiguration

Returns:

The application or null if the application could not be found.

getApplications

public Set<Application> getApplications()

Returns a set of registered applications.

Specified by:

getApplications in interface EntitlementConfiguration

Returns:

a set of registered applications.

addSubjectAttributeNames

public void addSubjectAttributeNames(String applicationName,
                                     Set<String> names)
                              throws EntitlementException

Returns subject attribute names.

Specified by:

addSubjectAttributeNames in interface EntitlementConfiguration

Parameters:

applicationName - Application name.

names - subject attribute names.

Throws:

EntitlementException - if subject attribute names cannot be returned.

removeApplication

public void removeApplication(String name)
                       throws EntitlementException

Removes application.

Specified by:

removeApplication in interface EntitlementConfiguration

Parameters:

name - name of application to be removed.

Throws:

EntitlementException - if application cannot be removed.

removeApplicationType

public void removeApplicationType(String name)
                           throws EntitlementException

Removes application type.

Specified by:

removeApplicationType in interface EntitlementConfiguration

Parameters:

name - name of application type to be removed.

Throws:

EntitlementException - if application type cannot be removed.

storeApplication

public void storeApplication(Application appl)
                      throws EntitlementException

Stores the application to data store.

Specified by:

storeApplication in interface EntitlementConfiguration

Parameters:

appl - Application object.

Throws:

EntitlementException - if application cannot be stored.

storeApplicationType

public void storeApplicationType(ApplicationType applicationType)
                          throws EntitlementException

Stores the application type to data store.

Specified by:

storeApplicationType in interface EntitlementConfiguration

Parameters:

applicationType - Application type object.

Throws:

EntitlementException - if application type cannot be stored.

getSubjectAttributeNames

public Set<String> getSubjectAttributeNames(String application)

Returns subject attribute names.

Specified by:

getSubjectAttributeNames in interface EntitlementConfiguration

Parameters:

application - Application name.

Returns:

subject attribute names.

getSubjectAttributesCollectorConfiguration

public Map<String,Set<String>> getSubjectAttributesCollectorConfiguration(String name)
                                                                         throws EntitlementException

Returns subject attributes collector configuration.

Specified by:

getSubjectAttributesCollectorConfiguration in interface EntitlementConfiguration

Parameters:

name - subject attributes collector name

Returns:

subject attributes collector configuration.

Throws:

EntitlementException - if subject attributes collector configuration cannot be returned.

setSubjectAttributesCollectorConfiguration

public void setSubjectAttributesCollectorConfiguration(String name,
                                                       Map<String,Set<String>> attrMap)
                                                throws EntitlementException

Sets subject attributes collector configuration.

Specified by:

setSubjectAttributesCollectorConfiguration in interface EntitlementConfiguration

Parameters:

name - subject attributes collector name

attrMap - subject attributes collector configuration map.

Throws:

EntitlementException - if subject attributes collector configuration cannot be set.

hasEntitlementDITs

public boolean hasEntitlementDITs()

Returns true if OpenAM policy data is migrated to a form that entitlements service can operates on them.

Specified by:

hasEntitlementDITs in interface EntitlementConfiguration

Returns:

true if OpenAM policy data is migrated to a form that entitlements service can operates on them.

xacmlPrivilegeEnabled

public boolean xacmlPrivilegeEnabled()

Returns true if the system stores privileges in XACML format and supports exporting privileges in XACML format

Specified by:

xacmlPrivilegeEnabled in interface EntitlementConfiguration

Returns:

true if the system stores privileges in XACML format and supports exporting privileges in XACML format

networkMonitorEnabled

public boolean networkMonitorEnabled()

Description copied from interface: EntitlementConfiguration

Returns true if the network monitoring for entitlements is enabled

Specified by:

networkMonitorEnabled in interface EntitlementConfiguration

Returns:

true if the network monitoring for entitlements is enabled.

setNetworkMonitorEnabled

public void setNetworkMonitorEnabled(boolean enabled)

Description copied from interface: EntitlementConfiguration

Allows the network monitoring to be enabled/disabled

Specified by:

setNetworkMonitorEnabled in interface EntitlementConfiguration

Parameters:

enabled - Is the network monitoring enabled

reindexApplications

public void reindexApplications()

Description copied from interface: EntitlementConfiguration

Reindex Applications.

Specified by:

reindexApplications in interface EntitlementConfiguration

isMonitoringRunning

public boolean isMonitoringRunning()

Whether the overall monitoring framework is enabled and running.

Specified by:

isMonitoringRunning in interface EntitlementConfiguration

Returns:

true if monitoring is enabled, false otherwise.

getPolicyWindowSize

public int getPolicyWindowSize()

Description copied from interface: EntitlementConfiguration

Informs us of the size of the policy window set in the configurable options.

Specified by:

getPolicyWindowSize in interface EntitlementConfiguration

Returns:

the value of the window size as configured.