com.sun.identity.policy.remote

Class PolicyResponse

java.lang.Object

com.sun.identity.policy.remote.PolicyResponse

public class PolicyResponse
extends Object

This PolicyResponse represents a PolicyResponse XML document. The PolicyResponse DTD is defined as the following:

Field Summary

Fields

Modifier and Type	Field and Description
static String	APP_SSO_TOKEN_INVALID Exception message if Application SSO Token is invalid
static int	POLICY_ADD_LISTENER_RESPONSE Add Policy Listener Resource ID.
static int	POLICY_ADVICES_HANDLEABLE_BY_AM_RESPONSE Policy Advices Handleable by OpenAM Response ID.
static int	POLICY_EXCEPTION Policy Exception ID.
static int	POLICY_REMOVE_LISTENER_RESPONSE Remove Policy Listener Resource ID.
static int	POLICY_RESPONSE_RESOURCE_RESULT Policy Response Resource Result ID.

Constructor Summary

Constructors

Constructor and Description
PolicyResponse() Default constructor for PolicyResponse.

Method Summary

Modifier and Type	Method and Description
AdvicesHandleableByAMResponse	getAdvicesHandleableByAMResponse() Returns the AdvicesHandleableByAMResponse object.
String	getExceptionMsg() Returns the exception response.
long	getIssueInstant() Returns the issue instant
int	getMethodID() Returns the method ID of the Policy Response.
String	getRequestId() Returns the request ID.
Set	getResourceResults() Returns the set of the sub resource results.
static PolicyResponse	parseXML(Node pNode) Returns PolicyResponse object constructed from XML.
void	setAdvicesHandleableByAMResponse(AdvicesHandleableByAMResponse advicesHandleableByAMResponse) Set the AdvicesHandleableByAMResponse.
void	setExceptionMsg(String exMsg) Sets the exception response.
void	setIssueInstant(long issueInst) Sets the issue instant
void	setMethodID(int id) Sets the method ID of the Policy Response.
void	setRequestId(String reqId) Sets the request ID.
void	setResourceResults(Set set) Sets the set of the sub resource results.
String	toXMLString() Returns string representation of this object.

Methods inherited from class java.lang.Object

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

Field Detail

POLICY_RESPONSE_RESOURCE_RESULT

public static final int POLICY_RESPONSE_RESOURCE_RESULT

Policy Response Resource Result ID.

See Also:

Constant Field Values

POLICY_ADD_LISTENER_RESPONSE

public static final int POLICY_ADD_LISTENER_RESPONSE

Add Policy Listener Resource ID.

See Also:

Constant Field Values

POLICY_REMOVE_LISTENER_RESPONSE

public static final int POLICY_REMOVE_LISTENER_RESPONSE

Remove Policy Listener Resource ID.

See Also:

Constant Field Values

POLICY_EXCEPTION

public static final int POLICY_EXCEPTION

Policy Exception ID.

See Also:

Constant Field Values

POLICY_ADVICES_HANDLEABLE_BY_AM_RESPONSE

public static final int POLICY_ADVICES_HANDLEABLE_BY_AM_RESPONSE

Policy Advices Handleable by OpenAM Response ID.

See Also:

Constant Field Values

APP_SSO_TOKEN_INVALID

public static final String APP_SSO_TOKEN_INVALID

Exception message if Application SSO Token is invalid

See Also:

Constant Field Values

Constructor Detail

PolicyResponse

public PolicyResponse()

Default constructor for PolicyResponse.

Method Detail

getMethodID

public int getMethodID()

Returns the method ID of the Policy Response.

Returns:

the method ID.

setMethodID

public void setMethodID(int id)

Sets the method ID of the Policy Response.

Parameters:

id - the method ID.

getRequestId

public String getRequestId()

Returns the request ID.

Returns:

the request ID.

setRequestId

public void setRequestId(String reqId)

Sets the request ID.

Parameters:

reqId - the ID of the request.

getIssueInstant

public long getIssueInstant()

Returns the issue instant

Returns:

the issue instant

setIssueInstant

public void setIssueInstant(long issueInst)

Sets the issue instant

Parameters:

issueInst - issue instant

getResourceResults

public Set getResourceResults()

Returns the set of the sub resource results.

Returns:

the sub resource result set.

setResourceResults

public void setResourceResults(Set set)

Sets the set of the sub resource results.

Parameters:

set - the sub resource result set.

getAdvicesHandleableByAMResponse

public AdvicesHandleableByAMResponse getAdvicesHandleableByAMResponse()

Returns the AdvicesHandleableByAMResponse object.

Returns:

AdvicesHandleableByAMResponse object.

setAdvicesHandleableByAMResponse

public void setAdvicesHandleableByAMResponse(AdvicesHandleableByAMResponse advicesHandleableByAMResponse)

Set the AdvicesHandleableByAMResponse.

Parameters:

advicesHandleableByAMResponse - the AdvicesHandleableByAMResponse.

getExceptionMsg

public String getExceptionMsg()

Returns the exception response.

Returns:

the exception response.

setExceptionMsg

public void setExceptionMsg(String exMsg)

Sets the exception response.

Parameters:

exMsg - the exception response.

parseXML

public static PolicyResponse parseXML(Node pNode)
                               throws PolicyEvaluationException

Returns PolicyResponse object constructed from XML.

Parameters:

pNode - the XML DOM node for the PolicyResponse object.

Returns:

constructed PolicyResponse object.

Throws:

PolicyEvaluationException

toXMLString

public String toXMLString()

Returns string representation of this object.

Returns:

string representation of this object.