com.sun.identity.entitlement.opensso

Class PolicySubject

java.lang.Object

com.sun.identity.entitlement.opensso.PolicySubject

All Implemented Interfaces:

EntitlementSubject

public class PolicySubject
extends Object
implements EntitlementSubject

This subject wraps all OpenAM policy subjects.

Constructor Summary

Constructors

Constructor and Description
PolicySubject()
PolicySubject(String name, String className, Set<String> values, boolean exclusive) Constructor.

Method Summary

Modifier and Type	Method and Description
SubjectDecision	evaluate(String realm, SubjectAttributesManager mgr, Subject subject, String resourceName, Map<String,Set<String>> environment) Returns subject decision.
String	getClassName() Returns class name.
String	getName() Returns name.
Subject	getPolicySubject() Constructs a legacy policy subject based on the information in this adapter.
Set<String>	getRequiredAttributeNames() Returns required attribute names.
Map<String,Set<String>>	getSearchIndexAttributes() Returns search index attributes.
String	getState() Returns state of this subject.
Set<String>	getValues() Returns values.
boolean	isExclusive() Returns true if this is an exclusive subject.
boolean	isIdentity() Returns true is this subject is an identity object.
void	setState(String state) Sets states

Methods inherited from class java.lang.Object

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

Constructor Detail

PolicySubject

public PolicySubject()

PolicySubject

public PolicySubject(String name,
                     String className,
                     Set<String> values,
                     boolean exclusive)

Constructor.

Parameters:

name - Name of condition.

className - Implementation class name.

values - Values of this subject.

exclusive - true to be exclusive.

Method Detail

getName

public String getName()

Returns name.

Returns:

name.

getClassName

public String getClassName()

Returns class name.

Returns:

class name.

getValues

public Set<String> getValues()

Returns values.

Returns:

values.

isExclusive

public boolean isExclusive()

Returns true if this is an exclusive subject.

Returns:

true if this is an exclusive subject.

setState

public void setState(String state)

Sets states

Specified by:

setState in interface EntitlementSubject

Parameters:

state - State.

getState

public String getState()

Returns state of this subject.

Specified by:

getState in interface EntitlementSubject

Returns:

state of this subject.

getSearchIndexAttributes

public Map<String,Set<String>> getSearchIndexAttributes()

Returns search index attributes.

Specified by:

getSearchIndexAttributes in interface EntitlementSubject

Returns:

search index attributes.

getRequiredAttributeNames

public Set<String> getRequiredAttributeNames()

Returns required attribute names.

Specified by:

getRequiredAttributeNames in interface EntitlementSubject

Returns:

required attribute names.

evaluate

public SubjectDecision evaluate(String realm,
                                SubjectAttributesManager mgr,
                                Subject subject,
                                String resourceName,
                                Map<String,Set<String>> environment)
                         throws EntitlementException

Returns subject decision.

Specified by:

evaluate in interface EntitlementSubject

Parameters:

realm - Realm name.

mgr - Subject attribute manager

subject - Subject to be evaluated.

resourceName - Resource name to be evaluated.

environment - Environment map.

Returns:

subject decision.

Throws:

EntitlementException - if error occurs.

isIdentity

public boolean isIdentity()

Returns true is this subject is an identity object.

Specified by:

isIdentity in interface EntitlementSubject

Returns:

true is this subject is an identity object.

getPolicySubject

public Subject getPolicySubject()
                         throws EntitlementException

Constructs a legacy policy subject based on the information in this adapter.

Returns:

the legacy policy subject

Throws:

EntitlementException - if an error occurs constructing the subject.