com.sun.identity.saml.protocol
Class AuthorizationDecisionQuery

java.lang.Object
  |
  +--com.sun.identity.saml.protocol.Query
        |
        +--com.sun.identity.saml.protocol.SubjectQuery
              |
              +--com.sun.identity.saml.protocol.AuthorizationDecisionQuery

public class AuthorizationDecisionQuery
extends SubjectQuery

This concrete class extends from the abstract base class SubjectQuery. It represents the query for an authorization decision assertion. It corresponds to the <samlp:AuthorizationDecisionQueryType> in the SAML protocol schema.


Fields inherited from class com.sun.identity.saml.protocol.Query
ATTRIBUTE_QUERY, AUTHENTICATION_QUERY, AUTHORIZATION_DECISION_QUERY, NOT_SUPPORTED_QUERY
 
Constructor Summary
AuthorizationDecisionQuery(org.w3c.dom.Element element)
          This constructor is used to build an Authorization Decision Query from a DOM tree that was built from the XML string.
AuthorizationDecisionQuery(Subject theSubject, java.util.List theActions, Evidence theEvidence, java.lang.String theResource)
          Constructor
AuthorizationDecisionQuery(Subject theSubject, java.util.List theActions, java.lang.String theResource)
          Constructor
 
Method Summary
 java.util.List getAction()
          Gets the List of Actions
 Evidence getEvidence()
          Accessor for the Evidence
 int getQueryType()
          Gets the type of the query.
 java.lang.String getResource()
          Accessor for the Resource
 java.lang.String toString()
          This method translates the AuthorizationDecisionQuery to an XML document String based on the AuthorizationDecisionQuery schema.
 java.lang.String toString(boolean includeNS, boolean declareNS)
          Create a String representation of the samlp:AuthorizationDecisionQuery element.
 
Methods inherited from class com.sun.identity.saml.protocol.SubjectQuery
getSubject
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AuthorizationDecisionQuery

public AuthorizationDecisionQuery(org.w3c.dom.Element element)
                           throws SAMLException
This constructor is used to build an Authorization Decision Query from a DOM tree that was built from the XML string.
Parameters:
element - the DOM tree element which contains an Authorization Decision Query.
Throws:
SAMLException - when an error occurs.

AuthorizationDecisionQuery

public AuthorizationDecisionQuery(Subject theSubject,
                                  java.util.List theActions,
                                  Evidence theEvidence,
                                  java.lang.String theResource)
                           throws SAMLException
Constructor
Parameters:
theSubject - The subject of the query.
theActions - The List of Actions of the query.
theEvidence - The evidence of the query. It could be null when there is no Evidence in the query.
theResource - A string representing the resource of the query.
Throws:
SAMLException - when an error occurs.

AuthorizationDecisionQuery

public AuthorizationDecisionQuery(Subject theSubject,
                                  java.util.List theActions,
                                  java.lang.String theResource)
                           throws SAMLException
Constructor
Parameters:
theSubject - The subject of the query.
theActions - The List of Actions of the query.
theResource - A string representing the resource of the query.
Throws:
SAMLException - when an error occurs.
Method Detail

getAction

public java.util.List getAction()
Gets the List of Actions
Returns:
The Actions included in the query.

getEvidence

public Evidence getEvidence()
Accessor for the Evidence
Returns:
the Evidence in the query. Null if there is no Evidence.

getResource

public java.lang.String getResource()
Accessor for the Resource
Returns:
A string representing the resource.

getQueryType

public int getQueryType()
Gets the type of the query.
Overrides:
getQueryType in class Query
Returns:
an integer which is Query.AUTHORIZATION_DECISION_QUERY.

toString

public java.lang.String toString()
This method translates the AuthorizationDecisionQuery to an XML document String based on the AuthorizationDecisionQuery schema.
Overrides:
toString in class java.lang.Object
Returns:
An XML String representing the AuthorizationDecisionQuery.

toString

public java.lang.String toString(boolean includeNS,
                                 boolean declareNS)
Create a String representation of the samlp:AuthorizationDecisionQuery element.
Overrides:
toString in class Query
Parameters:
includeNS - Determines whether or not the namespace qualifier is prepended to the Element when converted
declareNS - Determines whether or not the namespace is declared within the Element.
Returns:
A string containing the valid XML for this element