Package com.sun.identity.policy.remote

Class PolicyResponse

  • public class PolicyResponse
extends Object
    This PolicyResponse represents a PolicyResponse XML document. The PolicyResponse DTD is defined as the following: 
    
   <!-- PolicyResponse element is used by the server to return a
    response to the client.
    If the client request is a policy evaluation request, then the
    policy decision is sent back using ResourceResult.
    If the client request is a policy listener addition, then an
    acknowledgement is sent back using AddPolicyListenerResponse.
    If the client request is a policy listener removal, then an
    acknowledgement is sent back using RemovePolicyListenerResponse.
    If anything wrong happens during the request processing, an
    error message is sent back to the client using Exception.
    The attribute requestId specifies the id of the request to
    which this response is regarding.
   -->

   <!ELEMENT    PolicyResponse    ( ResourceResult+
                                    | AddPolicyListenerResponse
                                    | RemovePolicyListenerResponse
                                    | AdvicesHandleableByAMResponse
                                    | Exception ) >
   <!ATTLIST    PolicyResponse
       requestId      CDATA        #REQUIRED
   >

    • 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.

      • toXMLString

        public String toXMLString()
        Returns string representation of this object.
        Returns:
        string representation of this object.