org.opensaml
Class SAMLAuthorizationDecisionQuery

java.lang.Object
  |
  +--org.opensaml.SAMLObject
        |
        +--org.opensaml.SAMLQuery
              |
              +--org.opensaml.SAMLAuthorizationDecisionQuery

All Implemented Interfaces:

java.lang.Cloneable

public class SAMLAuthorizationDecisionQuery

extends SAMLQuery

implements java.lang.Cloneable

Represents a SAML AuthorizationDecisionQuery

Author:

Helen Rehn, Scott Cantor

Field Summary

Fields inherited from class org.opensaml.SAMLQuery

queryTypeMap

Fields inherited from class org.opensaml.SAMLObject

config, log, root

Constructor Summary

SAMLAuthorizationDecisionQuery(org.w3c.dom.Element e)
Reconstructs a query from a DOM tree

SAMLAuthorizationDecisionQuery(java.io.InputStream in)
Reconstructs an action from a stream

SAMLAuthorizationDecisionQuery(SAMLSubject subject, java.lang.String resource, java.util.Collection actions, java.util.Collection evidence)
Builds an AuthorizationDecisionQuery out of its component parts

Method Summary

java.lang.Object	clone() Copies a SAML object such that no dependencies exist between the original and the copy
void	fromDOM(org.w3c.dom.Element e) Initialization of query from a DOM element.
java.util.Iterator	getActions() Gets the actions inside the query
java.util.Iterator	getEvidence() Gets the evidence inside the query
java.lang.String	getResource() Gets the resource URI inside the query
SAMLSubject	getSubject() Gets the query subject
org.w3c.dom.Node	toDOM(org.w3c.dom.Document doc) Overridden method to return a DOM tree representing the query

Methods inherited from class org.opensaml.SAMLObject

fromStream, plantRoot, toBase64, toDOM, toStream, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SAMLAuthorizationDecisionQuery

public SAMLAuthorizationDecisionQuery(SAMLSubject subject,
                                      java.lang.String resource,
                                      java.util.Collection actions,
                                      java.util.Collection evidence)
                               throws SAMLException

Builds an AuthorizationDecisionQuery out of its component parts

Parameters:

subject - subject of the query

resource - URI of the resource being accessed at the time of the query

actions - specific actions being queried for

evidence - evidence which may be considered

Throws:

SAMLException - Raised if an AuthorizationDecisionQuery cannot be constructed from the supplied information

SAMLAuthorizationDecisionQuery

public SAMLAuthorizationDecisionQuery(org.w3c.dom.Element e)
                               throws SAMLException

Reconstructs a query from a DOM tree

Parameters:

e - The root of a DOM tree

Throws:

SAMLException - Thrown if the object cannot be constructed

SAMLAuthorizationDecisionQuery

public SAMLAuthorizationDecisionQuery(java.io.InputStream in)
                               throws SAMLException

Reconstructs an action from a stream

Parameters:

in - A stream containing XML

Throws:

SAMLException - Raised if an exception occurs while constructing the object.

Method Detail

fromDOM

public void fromDOM(org.w3c.dom.Element e)
             throws SAMLException

Initialization of query from a DOM element.

Checks the query's syntactic validity. An exception is thrown if any problems are detected. The exception will contain a message describing the problem, and may wrap another exception.

Overrides:

fromDOM in class SAMLObject

Parameters:

e - Root element of a DOM tree

Throws:

SAMLException - Raised if an exception occurs while constructing the object.

getSubject

public SAMLSubject getSubject()

Gets the query subject

Returns:

the query subject

getResource

public java.lang.String getResource()

Gets the resource URI inside the query

Returns:

the resource URI

getActions

public java.util.Iterator getActions()

Gets the actions inside the query

Returns:

An iterator over the actions

getEvidence

public java.util.Iterator getEvidence()

Gets the evidence inside the query

Returns:

An iterator over the evidence

toDOM

public org.w3c.dom.Node toDOM(org.w3c.dom.Document doc)

Overridden method to return a DOM tree representing the query

Overrides:

toDOM in class SAMLObject

Parameters:

doc - A Document object to use in manufacturing the tree

Returns:

Root element of a DOM tree

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Copies a SAML object such that no dependencies exist between the original and the copy

Overrides:

clone in class SAMLObject

Returns:

The new object

java.lang.CloneNotSupportedException

See Also:

Object.clone()