Package com.sun.identity.saml.assertion

Class AuthorizationDecisionStatementBase

java.lang.Object

com.sun.identity.saml.assertion.Statement

com.sun.identity.saml.assertion.SubjectStatement

com.sun.identity.saml.assertion.AuthorizationDecisionStatementBase

Direct Known Subclasses:

AuthorizationDecisionStatement

@SupportedAll
public abstract class AuthorizationDecisionStatementBase
extends SubjectStatement

The AuthorizationDecisionStatement 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. This class is an abstract base class for all AuthorizationDecisionStatement implementations and encapsulates common functionality.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuthorizationDecisionStatementBase.DecisionType	The DecisionType is an inner class defining constants for the type of Decisions than can be conveyed by an AuthorizationDecisionStatement .

Field Summary

Fields

Modifier and Type	Field	Description
protected EvidenceBase	_evidence

Fields inherited from class com.sun.identity.saml.assertion.SubjectStatement

_subject

Fields inherited from class com.sun.identity.saml.assertion.Statement

ATTRIBUTE_STATEMENT, AUTHENTICATION_STATEMENT, AUTHORIZATION_DECISION_STATEMENT, NOT_SUPPORTED

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AuthorizationDecisionStatementBase()	Default constructor
	AuthorizationDecisionStatementBase(Subject subject, String resource, int decision, List action)	Constructs a AuthorizationDecisionStatement instance.
	AuthorizationDecisionStatementBase(Subject subject, String resource, int decision, List action, EvidenceBase evidence)	Constructs an instance of AuthorizationDecisionStatement.
	AuthorizationDecisionStatementBase(Element element)	Constructs an AuthorizationStatement element from an existing XML block.

Method Summary

Modifier and Type	Method	Description
protected abstract Action	createAction(Element actionElement)	Creates appropriate Action Instance
protected abstract EvidenceBase	createEvidence(Element evidenceElement)	Creates appropriate Evidence Instance
protected abstract Subject	createSubject(Element subjectElement)	Creates appropriate Subject Instance
List	getAction()	Returns the action(s) from AuthorizationStatement.
int	getDecision()	Returns the decision for AuthorizationStatement.
String	getResource()	Returns the resource from AuthorizationStatement
int	getStatementType()	Returns the real type of statement.
String	toString()	Returns a String representation of the AuthorizationStatement.
String	toString(boolean includeNS, boolean declareNS)	Returns 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

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

Field Detail

_evidence

protected EvidenceBase _evidence

Constructor Detail

AuthorizationDecisionStatementBase

protected AuthorizationDecisionStatementBase()

Default constructor

AuthorizationDecisionStatementBase

public AuthorizationDecisionStatementBase(Element element)
                                   throws SAMLException

Constructs an AuthorizationStatement element from an existing XML block.

Parameters:

element - representing a DOM tree element

Throws:

SAMLException - if there is an error in the sender or in the element definition.

AuthorizationDecisionStatementBase

public AuthorizationDecisionStatementBase(Subject subject,
                                          String resource,
                                          int decision,
                                          List action,
                                          EvidenceBase evidence)
                                   throws SAMLException

Constructs an instance of AuthorizationDecisionStatement.

Parameters:

subject - (required) A Subject object

resource - (required) A String identifying the resource to which access authorization is sought.

decision - (required) 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 - if there is an error in the sender.

AuthorizationDecisionStatementBase

public AuthorizationDecisionStatementBase(Subject subject,
                                          String resource,
                                          int decision,
                                          List action)
                                   throws SAMLException

Constructs a AuthorizationDecisionStatement instance.

Parameters:

subject - (required) A Subject object

resource - (required) A String identifying the resource to which access authorization is sought.

decision - (required) 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 - if there is an error in the sender.

Method Detail

createEvidence

protected abstract EvidenceBase createEvidence(Element evidenceElement)
                                        throws SAMLException

Creates appropriate Evidence Instance

Parameters:

evidenceElement - the Evidence Element

Returns:

the Evidence Object

Throws:

SAMLException

createSubject

protected abstract Subject createSubject(Element subjectElement)
                                  throws SAMLException

Creates appropriate Subject Instance

Parameters:

subjectElement - the Subject Element

Returns:

the Subject Object

Throws:

SAMLException

createAction

protected abstract Action createAction(Element actionElement)
                                throws SAMLException

Creates appropriate Action Instance

Parameters:

actionElement - the Action Element

Returns:

the Action Object

Throws:

SAMLException

getAction

public List getAction()

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

getResource

public String getResource()

Returns the resource from AuthorizationStatement

Returns:

A String identifying the resource to which access authorization is sought.

getDecision

public int getDecision()

Returns the decision for AuthorizationStatement.

Returns:

The decision string such as permit deny indetereminate

getStatementType

public int getStatementType()

Returns the real type of statement. This method returns Statement.AUTHORIZATION_DECISION_STATEMENT.

Specified by:

getStatementType in class Statement

Returns:

Statement.AUTHORIZATION_DECISION_STATEMENT.

toString

public String toString()

Returns a String representation of the AuthorizationStatement.

Overrides:

toString in class Object

Returns:

A String representation of the <AuthorizationDecisionStatement element.

toString

public String toString(boolean includeNS,
                       boolean declareNS)

Returns a String representation of the AuthorizationStatement.

Specified by:

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 <AuthorizationDecisionStatement> element.