Package com.sun.identity.policy.remote
Class PolicyRequest
- java.lang.Object
-
- com.sun.identity.policy.remote.PolicyRequest
-
public class PolicyRequest extends Object
ThisPolicyRequestclass represents a PolicyRequest XML document. The PolicyRequest DTD is defined as the following:
-
-
Field Summary
Fields Modifier and Type Field Description static intPOLICY_REQUEST_ADD_POLICY_LISTENERPolicy Request - Add Policy Listener ID.static intPOLICY_REQUEST_ADVICES_HANDLEABLE_BY_AM_REQUESTPolicy Request - Advices handleable by OpenAM ID.static intPOLICY_REQUEST_GET_RESOURCE_RESULTSPolicy Request - Get Resource Results ID.static intPOLICY_REQUEST_REMOVE_POLICY_LISTENERPolicy Request - Remove Policy Listener ID.
-
Constructor Summary
Constructors Constructor Description PolicyRequest()Default constructor forPolicyRequest.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetAppSSOToken()Returns the single sign on token of the application who sends the request.intgetMethodID()Returns the method ID of the Policy Request.StringgetMethodName()Retrieves the string representation of the method Id.PolicyListenerRequestgetPolicyListenerRequest()Returns thePolicyListenerRequestobject.RemoveListenerRequestgetRemoveListenerRequest()Returns theRemoveListenerRequestobject.StringgetRequestId()Returns the request ID.ResourceResultRequestgetResourceResultRequest()Returns the resource result request object.static PolicyRequestparseXML(Node pNode)Returns aPolicyRequestobject constructed from a XML.voidsetAdvicesHandleableByAMRequest(AdvicesHandleableByAMRequest advicesHandleableByAMRequest)Sets theAdvicesHandleableByAMRequestsub element ofPolicyRequest.voidsetAppSSOToken(String ssoToken)Sets the single sign on token of the application who sends the request.voidsetMethodID(int id)Sets the method ID of the Policy Request.voidsetPolicyListenerRequest(PolicyListenerRequest req)Sets thePolicyListenerRequestof the Policy Service.voidsetRemoveListenerRequest(RemoveListenerRequest req)Sets theRemoveListenerRequestof the Policy Service.voidsetRequestId(String reqId)Sets the request ID.voidsetResourceResultRequest(ResourceResultRequest req)Sets the resource result request object.StringtoXMLString()Returns a string representation of this object.
-
-
-
Field Detail
-
POLICY_REQUEST_GET_RESOURCE_RESULTS
public static final int POLICY_REQUEST_GET_RESOURCE_RESULTS
Policy Request - Get Resource Results ID.- See Also:
- Constant Field Values
-
POLICY_REQUEST_ADD_POLICY_LISTENER
public static final int POLICY_REQUEST_ADD_POLICY_LISTENER
Policy Request - Add Policy Listener ID.- See Also:
- Constant Field Values
-
POLICY_REQUEST_REMOVE_POLICY_LISTENER
public static final int POLICY_REQUEST_REMOVE_POLICY_LISTENER
Policy Request - Remove Policy Listener ID.- See Also:
- Constant Field Values
-
POLICY_REQUEST_ADVICES_HANDLEABLE_BY_AM_REQUEST
public static final int POLICY_REQUEST_ADVICES_HANDLEABLE_BY_AM_REQUEST
Policy Request - Advices handleable by OpenAM ID.- See Also:
- Constant Field Values
-
-
Method Detail
-
getMethodID
public int getMethodID()
Returns the method ID of the Policy Request.- Returns:
- the method ID.
-
getMethodName
public String getMethodName()
Retrieves the string representation of the method Id.- Returns:
- the string representation of the method Id
- Throws:
IllegalStateException- should the method Id become unknown
-
setMethodID
public void setMethodID(int id)
Sets the method ID of the Policy Request.- Parameters:
id- the method ID.
-
getAppSSOToken
public String getAppSSOToken()
Returns the single sign on token of the application who sends the request.- Returns:
- the single sign on token of the application.
-
setAppSSOToken
public void setAppSSOToken(String ssoToken)
Sets the single sign on token of the application who sends the request.- Parameters:
ssoToken- the single sign on token of the application.
-
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.
-
getResourceResultRequest
public ResourceResultRequest getResourceResultRequest()
Returns the resource result request object.- Returns:
- the resource result request.
-
setResourceResultRequest
public void setResourceResultRequest(ResourceResultRequest req)
Sets the resource result request object.- Parameters:
req- the resource result request.
-
getPolicyListenerRequest
public PolicyListenerRequest getPolicyListenerRequest()
Returns thePolicyListenerRequestobject.- Returns:
- the
PolicyListenerRequestobject.
-
setPolicyListenerRequest
public void setPolicyListenerRequest(PolicyListenerRequest req)
Sets thePolicyListenerRequestof the Policy Service.- Parameters:
req- thePolicyListenerRequestof this Policy Service
-
getRemoveListenerRequest
public RemoveListenerRequest getRemoveListenerRequest()
Returns theRemoveListenerRequestobject.- Returns:
- the
RemoveListenerRequestobject
-
setRemoveListenerRequest
public void setRemoveListenerRequest(RemoveListenerRequest req)
Sets theRemoveListenerRequestof the Policy Service.- Parameters:
req- theRemoveListenerRequestof this Policy Service
-
setAdvicesHandleableByAMRequest
public void setAdvicesHandleableByAMRequest(AdvicesHandleableByAMRequest advicesHandleableByAMRequest)
Sets theAdvicesHandleableByAMRequestsub element ofPolicyRequest.- Parameters:
advicesHandleableByAMRequest- theAdvicesHandleableByAMRequestsub element ofPolicyRequest.
-
parseXML
public static PolicyRequest parseXML(Node pNode) throws PolicyEvaluationException
Returns aPolicyRequestobject constructed from a XML.- Parameters:
pNode- the XML DOM node for thePolicyRequestobject.- Returns:
- constructed
PolicyRequestobject - Throws:
PolicyEvaluationException
-
toXMLString
public String toXMLString()
Returns a string representation of this object.- Returns:
- a string representation of this object.
-
-