com.sun.identity.policy
Class ActionDecision

java.lang.Object
  com.sun.identity.policy.ActionDecision

public class ActionDecision
extends Object

The ActionDecision class represents the action results of a policy evaluation. It has action values for a given action and advice.

Constructor Summary

ActionDecision(String actionName, Set values)
Constructor

ActionDecision(String actionName, Set values, Map advices, long timeToLive)
Constructor

Method Summary

String	getActionName() Gets the name of the action
Map	getAdvices() Returns a Map of advices associated with this object.
long	getTimeToLive() Gets the GMT time in milliseconds since epoch when this object is to be treated as expired.
Set	getValues() Gets the action values for the action.
void	setAdvices(Map advices) Sets advices associated with this ActionDecision .
void	setTimeToLive(long timeToLive) Sets the GMT time in milliseconds since epoch when this object is to be treated as expired.
void	setValues(Set values) Sets the action values for the action.
String	toString() Gets a String representation of this object
String	toXML() Gets an XML representation of this object

Constructor Detail

ActionDecision

public ActionDecision(String actionName,
                      Set values)

Constructor

Parameters:

actionName - name of the action.

values - a Set> of String values for the action

ActionDecision

public ActionDecision(String actionName,
                      Set values,
                      Map advices,
                      long timeToLive)

Constructor

Parameters:

actionName - action name

values - a Set of String values for the action

advices - advices associated with this action decision. The advice name is the key to the Map. The value is a set of advice message Strings corresponding to the advice name.

timeToLive - the GMT time in milliseconds since epoch when this object is to be treated as expired. That is the action values would likely be different after that time.

Method Detail

getActionName

public String getActionName()

Gets the name of the action

Returns:

name of the action

setValues

public void setValues(Set values)

Sets the action values for the action.

Parameters:

values - a Set of String values

getValues

public Set getValues()

Gets the action values for the action.

Returns:

a Set>/code> of String values

getTimeToLive

public long getTimeToLive()

Gets the GMT time in milliseconds since epoch when this object is to be treated as expired. That is the action values would likely be different after that time. This is computed as a result of SimpleTimeCondition(s) specified in the Policy definition.

Returns:

long represeting the time to live for this object.

setTimeToLive

public void setTimeToLive(long timeToLive)

Sets the GMT time in milliseconds since epoch when this object is to be treated as expired. That is the action values would likely be different after that time. This is computed as a result of SimpleTimeCondition(s) specified in the Policy definition.

Parameters:

timeToLive - time to live

setAdvices

public void setAdvices(Map advices)

Sets advices associated with this ActionDecision . The advice name is the key to the Map. The value is a Set of advice message Strings corresponding to the advice name. The two possible advices are authentication level(AuthLevel) and authentication modules (AuthSchemes). The advice message Strings for AuthLevel are integer valued.

Parameters:

advices - map of advices

getAdvices

public Map getAdvices()

Returns a Map of advices associated with this object. The advice name is the key to the Map. The value is a Set of advice message Strings corresponding to the advice name. The two possible advices are authentication level(AuthLevel) and authentication modules (AuthSchemes). The advice message Strings for AuthLevel are integer valued.

Returns:

advices associated with this ActionDecision.

toString

public String toString()

Gets a String representation of this object

Overrides:

toString in class Object

Returns:

a String representation of this object

toXML

public String toXML()

Gets an XML representation of this object

Returns:

XML representation of this object