com.sun.identity.policy
Class ActionDecision

java.lang.Object
  |
  +--com.sun.identity.policy.ActionDecision

public class ActionDecision

extends java.lang.Object

The ActionDecision class represents the action results of a policy evaluation. It has action values for a given action and advice. The advice is either the authenticatin level of the required authentication scheme or the authentication schemes with which the user must authenticate. Additional advices may be supported in future.

Constructor Summary

ActionDecision()
No argument constructor

ActionDecision(java.lang.String actionName, java.util.Set values)
Constructor

ActionDecision(java.lang.String actionName, java.util.Set values, java.util.Map advices, long timeToLive)
Constructor

Method Summary

java.lang.String	getActionName() Gets the name of the action
java.util.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.
java.util.Set	getValues() Gets the action values for the action.
void	setAdvices(java.util.Map advices) Sets advices associated with this action decision.
void	setTimeToLive(long timeToLive) Sets the GMT time in milliseconds since epoch when this object is to be treated as expired.
void	setValues(java.util.Set values) Sets the action values for the action.
java.lang.String	toString() Gets a String representation of this object
java.lang.String	toXML() Gets an XML representation of this object

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ActionDecision

public ActionDecision()

No argument constructor

ActionDecision

public ActionDecision(java.lang.String actionName,
                      java.util.Set values)

Constructor

Parameters:

actionName - action name

values - a set of String values for the action

ActionDecision

public ActionDecision(java.lang.String actionName,
                      java.util.Set values,
                      java.util.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 java.lang.String getActionName()

Gets the name of the action

Returns:

name of the action

setValues

public void setValues(java.util.Set values)

Sets the action values for the action.

Parameters:

values - a set of String values

getValues

public java.util.Set getValues()

Gets the action values for the action.

Returns:

a set 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 time conditions specified in the Policy definition.

Returns:

time to live

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 time conditions specified in the Policy definition.

Parameters:

timeToLive - time to live

setAdvices

public void setAdvices(java.util.Map advices)

Sets 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. The two possible advices are authentication level(AuthLevel) and authentication schemes (AuthSchemes). The advice message Strings for AuthLevel are integer valued.

Parameters:

advices - map of advices

getAdvices

public java.util.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 schemes (AuthSchemes). The advice message Strings for AuthLevel are integer valued.

Returns:

advices associated with this action decision

toString

public java.lang.String toString()

Gets a String representation of this object

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this object

toXML

public java.lang.String toXML()

Gets an XML representation of this object

Returns:

XML representation of this object