org.opensaml
Class SAMLAttributeQuery

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

All Implemented Interfaces:

java.lang.Cloneable

public class SAMLAttributeQuery

extends SAMLQuery

implements java.lang.Cloneable

Represents a SAML Attribute Query object

Author:

Scott Cantor

Field Summary

Fields inherited from class org.opensaml.SAMLQuery

queryTypeMap

Fields inherited from class org.opensaml.SAMLObject

config, log, root

Constructor Summary

SAMLAttributeQuery(org.w3c.dom.Element e)
Reconstructs an attribute query from a DOM tree

SAMLAttributeQuery(java.io.InputStream in)
Reconstructs an attribute query from a stream

SAMLAttributeQuery(SAMLSubject subject, java.lang.String resource, java.util.Collection designators)
Builds an attribute query 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 attribute query from a DOM element.
java.util.Iterator	getDesignators() Gets the attribute designators 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

SAMLAttributeQuery

public SAMLAttributeQuery(SAMLSubject subject,
                          java.lang.String resource,
                          java.util.Collection designators)
                   throws SAMLException

Builds an attribute query out of its component parts

Parameters:

subject - Subject of query

resource - URI of resource being accessed at time of query

designators - Indicates specific attributes to query for

Throws:

SAMLException - Raised if the query cannot be constructed from the supplied information

SAMLAttributeQuery

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

Reconstructs an attribute query from a DOM tree

Parameters:

e - The root of a DOM tree

Throws:

SAMLException - Thrown if the object cannot be constructed

SAMLAttributeQuery

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

Reconstructs an attribute query 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 attribute 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

getDesignators

public java.util.Iterator getDesignators()

Gets the attribute designators inside the query

Returns:

An iterator of attribute designators

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()