org.opensaml
Class SAMLAttributeQuery

java.lang.Object
  org.opensaml.SAMLObject
      org.opensaml.SAMLQuery
          org.opensaml.SAMLSubjectQuery
              org.opensaml.SAMLAttributeQuery

All Implemented Interfaces:

Cloneable

public class SAMLAttributeQuery
extends SAMLSubjectQuery
implements Cloneable

Represents a SAML Attribute Query object

Author:

Scott Cantor

Field Summary

protected ArrayList	designators
protected String	resource

Fields inherited from class org.opensaml.SAMLSubjectQuery

subject

Fields inherited from class org.opensaml.SAMLQuery

queryTypeMap

Fields inherited from class org.opensaml.SAMLObject

config, dirty, log, parentObject, root

Constructor Summary

SAMLAttributeQuery()
Default constructor

SAMLAttributeQuery(Element e)
Reconstructs an attribute query from a DOM tree

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

SAMLAttributeQuery(SAMLSubject subject, String resource, Collection designators)
Builds an attribute query out of its component parts

Method Summary

void	addDesignator(SAMLAttributeDesignator designator) Adds an attribute designator to the query
protected Element	buildRoot(Document doc, boolean xmlns) Delegates the process of building the root element of an object and inserting appropriate namespaces.
Object	clone() Copies a SAML object such that no dependencies exist between the original and the copy
void	fromDOM(Element e) Initialization of an object from a DOM element
Iterator	getDesignators() Gets the attribute designators inside the query
String	getResource() Gets the resource URI inside the query
void	removeDesignator(int index) Removes a designator by position (zero-based)
void	setDesignators(Collection designators) Sets the attribute designators inside the query
void	setResource(String resource) Sets the resource URI inside the query
Node	toDOM(Document doc, boolean xmlns) Transforms the object into a DOM tree using an existing document context

Methods inherited from class org.opensaml.SAMLSubjectQuery

checkValidity, getSubject, setSubject

Methods inherited from class org.opensaml.SAMLQuery

getInstance, getInstance, regFactory, unregFactory

Methods inherited from class org.opensaml.SAMLObject

fromStream, fromStream, getParent, plantRoot, setDirty, setParent, toBase64, toDOM, toDOM, toDOM, toStream, toString

Methods inherited from class java.lang.Object

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

Field Detail

resource

protected String resource

designators

protected ArrayList designators

Constructor Detail

SAMLAttributeQuery

public SAMLAttributeQuery()

Default constructor

SAMLAttributeQuery

public SAMLAttributeQuery(SAMLSubject subject,
                          String resource,
                          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(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(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(Element e)
             throws SAMLException

Description copied from class: SAMLObject

Initialization of an object from a DOM element

Overrides:

fromDOM in class SAMLSubjectQuery

Parameters:

e - Root element of a DOM tree

Throws:

SAMLException - Raised if an exception occurs while constructing the object

See Also:

SAMLObject.fromDOM(org.w3c.dom.Element)

getResource

public String getResource()

Gets the resource URI inside the query

Returns:

The resource URI

setResource

public void setResource(String resource)

Sets the resource URI inside the query

Parameters:

resource - The resource URI

getDesignators

public Iterator getDesignators()

Gets the attribute designators inside the query

Returns:

An iterator of attribute designators

setDesignators

public void setDesignators(Collection designators)
                    throws SAMLException

Sets the attribute designators inside the query

Parameters:

designators - The designators to include

Throws:

SAMLException - Raised if the designators are invalid

addDesignator

public void addDesignator(SAMLAttributeDesignator designator)
                   throws SAMLException

Adds an attribute designator to the query

Parameters:

designator - The designator to add

Throws:

SAMLException - Raised if the designator is invalid

removeDesignator

public void removeDesignator(int index)

Removes a designator by position (zero-based)

Parameters:

index - The position of the designator to remove

buildRoot

protected Element buildRoot(Document doc,
                            boolean xmlns)

Description copied from class: SAMLObject

Delegates the process of building the root element of an object and inserting appropriate namespaces.

Specified by:

buildRoot in class SAMLObject

Parameters:

doc - The document context to use

xmlns - Include namespace(s) on root element?

Returns:

A new root element for the object

See Also:

SAMLObject.buildRoot(org.w3c.dom.Document,boolean)

toDOM

public Node toDOM(Document doc,
                  boolean xmlns)
           throws SAMLException

Description copied from class: SAMLObject

Transforms the object into a DOM tree using an existing document context

Overrides:

toDOM in class SAMLSubjectQuery

Parameters:

doc - A Document object to use in manufacturing the tree

xmlns - Include namespace(s) on root element?

Returns:

Root element node of the DOM tree capturing the object

Throws:

SAMLException - Raised if the object is incompletely defined

See Also:

SAMLObject.toDOM(org.w3c.dom.Document,boolean)

clone

public Object clone()
             throws CloneNotSupportedException

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

Overrides:

clone in class SAMLSubjectQuery

Returns:

The new object

Throws:

CloneNotSupportedException

See Also:

Object.clone()