com.sun.identity.saml.assertion
Class AuthorizationDecisionStatement

java.lang.Object
  |
  +--com.sun.identity.saml.assertion.Statement
        |
        +--com.sun.identity.saml.assertion.SubjectStatement
              |
              +--com.sun.identity.saml.assertion.AuthorizationDecisionStatement

public class AuthorizationDecisionStatement
extends SubjectStatement

The element supplies a statement by the issuer that the request for access by the specified subject to the specified resource has resulted in the specified decision on the basis of some optionally specified evidence.


Inner Class Summary
static class AuthorizationDecisionStatement.DecisionType
           
 
Fields inherited from class com.sun.identity.saml.assertion.Statement
ATTRIBUTE_STATEMENT, AUTHENTICATION_STATEMENT, AUTHORIZATION_DECISION_STATEMENT, NOT_SUPPORTED
 
Constructor Summary
AuthorizationDecisionStatement(org.w3c.dom.Element element)
          This constructor builds an AuthorizationStatement element from an existing XML block
AuthorizationDecisionStatement(Subject subject, java.lang.String resource, int decision, java.util.List action)
          Constructor for AuthorizationDecisionStatement
AuthorizationDecisionStatement(Subject subject, java.lang.String resource, int decision, java.util.List action, Evidence evidence)
          Constructor for AuthorizationDecisionStatement
 
Method Summary
 java.util.List getAction()
          Get the action(s) from AuthorizationStatement
 int getDecision()
          Get the decision for AuthorizationStatement
 Evidence getEvidence()
          Get the evidence from AuthorizationStatement
 java.lang.String getResource()
          Get the resource from AuthorizationStatement
 int getStatementType()
          Get the real type of statement.
 java.lang.String toString()
          Create a String representation of the AuthorizationStatement
 java.lang.String toString(boolean includeNS, boolean declareNS)
          Create a String representation of the AuthorizationStatement
 
Methods inherited from class com.sun.identity.saml.assertion.SubjectStatement
getSubject, setSubject
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AuthorizationDecisionStatement

public AuthorizationDecisionStatement(org.w3c.dom.Element element)
                               throws SAMLException
This constructor builds an AuthorizationStatement element from an existing XML block
Parameters:
element - : representing a DOM tree element
Throws:
SAMLException: - An SAMLException implies that there is an error in the sender or in the element definition.

AuthorizationDecisionStatement

public AuthorizationDecisionStatement(Subject subject,
                                      java.lang.String resource,
                                      int decision,
                                      java.util.List action,
                                      Evidence evidence)
                               throws SAMLException
Constructor for AuthorizationDecisionStatement
Parameters:
subject[required]: - A Subject object
resource[required]: - A String indentifying the resource to which access authorization is sought.
decision[required]: - An integer representing the decision. The decision rendered by the issuer with respect to the specified resource. The value is of the DecisionType simple type.
action[required]: - A List of Action objects specifying the set of actions authorized to be performed on the specified resource.
evidence[optional]: - An Evidence object representing a set of assertions that the issuer replied on in making decisions.
Throws:
SAMLException: - An SAMLException implies that there is an error in the sender.

AuthorizationDecisionStatement

public AuthorizationDecisionStatement(Subject subject,
                                      java.lang.String resource,
                                      int decision,
                                      java.util.List action)
                               throws SAMLException
Constructor for AuthorizationDecisionStatement
Parameters:
subject[required]: - A Subject object
resource[required]: - A String indentifying the resource to which access authorization is sought.
decision[required]: - An integer representing the decision. The decision rendered by the issuer with respect to the specified resource. The value is of the DecisionType simple type.
action[required]: - A List of Action objects specifying the set of actions authorized to be performed on the specified resource.
Throws:
SAMLException: - An SAMLException implies that there is an error in the sender.
Method Detail

getAction

public java.util.List getAction()
Get the action(s) from AuthorizationStatement
Returns:
A List of Action object(s) specifying the set of actions authorized to be performed on the specified resource.

getEvidence

public Evidence getEvidence()
Get the evidence from AuthorizationStatement
Returns:
An Evidence object that the issuer replied on in making decisions.

getResource

public java.lang.String getResource()
Get the resource from AuthorizationStatement
Returns:
A String indentifying the resource to which access authorization is sought.

getDecision

public int getDecision()
Get the decision for AuthorizationStatement
Returns:
The decision string such as "permit","deny" or "indetereminate"

getStatementType

public int getStatementType()
Get the real type of statement. This method returns Statement.AUTHORIZATION_DECISION_STATEMENT.
Overrides:
getStatementType in class Statement
Returns:
An integer which is Statement.AUTHORIZATION_DECISION_STATEMENT.

toString

public java.lang.String toString()
Create a String representation of the AuthorizationStatement
Overrides:
toString in class java.lang.Object
Returns:
A String representation of the element

toString

public java.lang.String toString(boolean includeNS,
                                 boolean declareNS)
Create a String representation of the AuthorizationStatement
Overrides:
toString in class SubjectStatement
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 representation of the element