com.sun.identity.policy

Class ResourceResult

java.lang.Object

com.sun.identity.policy.ResourceResult

Deprecated.

since 12.0.0

@Deprecated
public class ResourceResult
extends Object

Class that encapsulates a tree of resource names, with each node having an associated policy decision.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SELF_SCOPE Deprecated. Constant to indicate base (self) level scope for ResourceResult evaluation
static String	STRICT_SUBTREE_SCOPE Deprecated. Constant to indicate strict subtree level scope for ResourceResult evaluation
static String	SUBTREE_SCOPE Deprecated. Constant to indicate subtree level scope for ResourceResult evaluation
static String	VIRTUAL_ROOT Deprecated. Constant used internally as a place holder for all encompassing root resoure name.

Constructor Summary

Constructors

Constructor and Description
ResourceResult(String resourceName, PolicyDecision policyDecision) Deprecated. Constructs a resource result given the resource name and policy decison

Method Summary

Modifier and Type	Method and Description
void	addResourceResult(ResourceResult resourceResult, ResourceName resourceComparator) Deprecated. Adds a resource result to the resource result sub tree rooted at this ResourceResult
void	addResourceResult(ResourceResult resourceResult, ServiceType serviceType) Deprecated. Adds a resource result to the resource result sub tree rooted at this ResourceResult
PolicyDecision	getPolicyDecision() Deprecated. Returns the policy decision associated with this resource result
String	getResourceName() Deprecated. Returns the resource name of this resource result
Set	getResourceResults() Deprecated. Returns the child resource results of this resource result
long	getTimeToLive() Deprecated. Returns the GMT time in milliseconds since epoch when this object is to be treated as expired.
boolean	hasAdvices() Deprecated. Checks wether advices are set in this object
boolean	isStale() Deprecated. Determines if result is stale
void	markStale() Deprecated. Marks result as stale
static ResourceResult	parseResourceResult(Node resourceResultNode) Deprecated. Converts an XML representation of resource result to ResourceResult
void	setPolicyDecision(PolicyDecision policyDecision) Deprecated. Sets the policy decision for this resource result
String	toString() Deprecated. Returns a string representation of this resource result
String	toXML() Deprecated. Returns an XML representation of this resource result

Methods inherited from class java.lang.Object

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

Field Detail

SUBTREE_SCOPE

public static final String SUBTREE_SCOPE

Deprecated.

Constant to indicate subtree level scope for ResourceResult evaluation

See Also:

Constant Field Values

STRICT_SUBTREE_SCOPE

public static final String STRICT_SUBTREE_SCOPE

Deprecated.

Constant to indicate strict subtree level scope for ResourceResult evaluation

See Also:

Constant Field Values

SELF_SCOPE

public static final String SELF_SCOPE

Deprecated.

Constant to indicate base (self) level scope for ResourceResult evaluation

See Also:

Constant Field Values

VIRTUAL_ROOT

public static final String VIRTUAL_ROOT

Deprecated.

Constant used internally as a place holder for all encompassing root resoure name. Any resource name is considered to be sub resource of this resource name.

See Also:

Constant Field Values

Constructor Detail

ResourceResult

public ResourceResult(String resourceName,
                      PolicyDecision policyDecision)

Deprecated.

Constructs a resource result given the resource name and policy decison

Parameters:

resourceName - resource name for this resource result

policyDecision - policy decision associated with the resource name

Method Detail

getResourceName

public String getResourceName()

Deprecated.

Returns the resource name of this resource result

Returns:

resource name of this resource result

getPolicyDecision

public PolicyDecision getPolicyDecision()

Deprecated.

Returns the policy decision associated with this resource result

Returns:

policy decision associated with this resource result

setPolicyDecision

public void setPolicyDecision(PolicyDecision policyDecision)

Deprecated.

Sets the policy decision for this resource result

Parameters:

policyDecision - policy decision for this resource result

getResourceResults

public Set getResourceResults()

Deprecated.

Returns the child resource results of this resource result

Returns:

child resource results of this resource result

parseResourceResult

public static ResourceResult parseResourceResult(Node resourceResultNode)
                                          throws PolicyException

Deprecated.

Converts an XML representation of resource result to ResourceResult

Parameters:

resourceResultNode - XML DOM node representing resource result

Returns:

ResourceResult object representation of resource result

Throws:

PolicyException - if the conversion fails

toString

public String toString()

Deprecated.

Returns a string representation of this resource result

Overrides:

toString in class Object

Returns:

a string representation of this resource result

toXML

public String toXML()

Deprecated.

Returns an XML representation of this resource result

Returns:

an XML representation of this resource result

addResourceResult

public void addResourceResult(ResourceResult resourceResult,
                              ServiceType serviceType)
                       throws PolicyException

Deprecated.

Adds a resource result to the resource result sub tree rooted at this ResourceResult

Parameters:

resourceResult - resource result to be added

serviceType - service type of the resource result being added

Throws:

PolicyException - if the resourceResult could not be added

addResourceResult

public void addResourceResult(ResourceResult resourceResult,
                              ResourceName resourceComparator)
                       throws PolicyException

Deprecated.

Adds a resource result to the resource result sub tree rooted at this ResourceResult

Parameters:

resourceResult - resource result to be added

resourceComparator - resource name comparator

Throws:

PolicyException - if the resourceResult could not be added

markStale

public void markStale()

Deprecated.

Marks result as stale

isStale

public boolean isStale()

Deprecated.

Determines if result is stale

Returns:

true if result is stale

getTimeToLive

public long getTimeToLive()

Deprecated.

Returns the GMT time in milliseconds since epoch when this object is to be treated as expired. That is the resource result would likely be different after that time. This is computed as a result of time conditions specified in the Policy definitions.

Returns:

time to live

hasAdvices

public boolean hasAdvices()

Deprecated.

Checks wether advices are set in this object

Returns:

true, if advices are set, else false