Package com.sun.identity.entitlement

Class UserAttributes

java.lang.Object

com.sun.identity.entitlement.UserAttributes

All Implemented Interfaces:

ResourceAttribute

public class UserAttributes
extends Object
implements ResourceAttribute

Interface specification for entitlement ResourceAttribute

Constructor Summary

Constructors

Constructor	Description
UserAttributes()	Constructs an instance of UserAttributes

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Returns true if the passed in object is equal to this object
Map<String,Set<String>>	evaluate(Subject adminSubject, String realm, Subject subject, String resourceName, Map<String,Set<String>> environment)	Returns resoruce attributes aplicable to the request
String	getPResponseProviderName()	Returns OpenAM policy response provider name of the object
String	getPropertyName()	Returns property name.
Set<String>	getPropertyValues()	Returns property values.
String	getState()	Returns the state of this object.
int	hashCode()	Returns hash code of the object.
void	setPResponseProviderName(String pResponseProviderName)	Sets OpenAM policy response provider name of the object
void	setPropertyName(String propertyName)	Sets property name.
void	setState(String s)	Sets the state of the object.
org.json.JSONObject	toJSONObject()	Returns JSONObject mapping of the object.
String	toString()	Returns string representation of the object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UserAttributes

public UserAttributes()

Constructs an instance of UserAttributes

Method Detail

getPropertyName

public String getPropertyName()

Description copied from interface: ResourceAttribute

Returns property name.

Specified by:

getPropertyName in interface ResourceAttribute

Returns:

name property name.

setPropertyName

public void setPropertyName(String propertyName)

Description copied from interface: ResourceAttribute

Sets property name.

Specified by:

setPropertyName in interface ResourceAttribute

Parameters:

propertyName - property name.

getPropertyValues

public Set<String> getPropertyValues()

Description copied from interface: ResourceAttribute

Returns property values.

Specified by:

getPropertyValues in interface ResourceAttribute

Returns:

properties for this ResourceAttribute.

evaluate

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

Returns resoruce attributes aplicable to the request

Specified by:

evaluate in interface ResourceAttribute

Parameters:

adminSubject - Subject who is performing the evaluation.

realm - Realm name.

subject - Subject who is under evaluation.

resourceName - Resource name.

environment - Environment parameters.

Returns:

applicable resource attributes

Throws:

EntitlementException - if can not get condition decision

getState

public String getState()

Returns the state of this object.

Specified by:

getState in interface ResourceAttribute

Returns:

state of this object.

setState

public void setState(String s)

Sets the state of the object.

Specified by:

setState in interface ResourceAttribute

Parameters:

s - state of the object.

toJSONObject

public org.json.JSONObject toJSONObject()
                                 throws org.json.JSONException

Returns JSONObject mapping of the object.

Returns:

JSONObject mapping of the object.

Throws:

org.json.JSONException

toString

public String toString()

Returns string representation of the object.

Overrides:

toString in class Object

Returns:

string representation of the object.

setPResponseProviderName

public void setPResponseProviderName(String pResponseProviderName)

Sets OpenAM policy response provider name of the object

Specified by:

setPResponseProviderName in interface ResourceAttribute

Parameters:

pResponseProviderName - response provider name as used in OpenAM policy, this is relevant only when UserAttributes was created from OpenAM policy Subject.

getPResponseProviderName

public String getPResponseProviderName()

Returns OpenAM policy response provider name of the object

Specified by:

getPResponseProviderName in interface ResourceAttribute

Returns:

response provider name as used in OpenAM policy, this is relevant only when UserAttributes was created from OpenAM policy Subject

equals

public boolean equals(Object obj)

Returns true if the passed in object is equal to this object

Overrides:

equals in class Object

Parameters:

obj - object to check for equality.

Returns:

true if the passed in object is equal to this object

hashCode

public int hashCode()

Returns hash code of the object.

Overrides:

hashCode in class Object

Returns:

hash code of the object.