Package com.sun.identity.saml.protocol

Class AttributeQuery

java.lang.Object

com.sun.identity.saml.protocol.Query

com.sun.identity.saml.protocol.SubjectQuery

com.sun.identity.saml.protocol.AttributeQuery

public class AttributeQuery
extends SubjectQuery

This concrete class extends from the abstract base class SubjectQuery. It represents the query for an attribute assertion. It corresponds to the samlp:AttributeQueryType in the SAML protocol schema.

Field Summary

Fields

Modifier and Type	Field	Description
protected List	attributeDesignators	O or more AttributeDesignator of this query.
protected String	resource

Fields inherited from class com.sun.identity.saml.protocol.SubjectQuery

subject

Fields inherited from class com.sun.identity.saml.protocol.Query

ATTRIBUTE_QUERY, AUTHENTICATION_QUERY, AUTHORIZATION_DECISION_QUERY, NOT_SUPPORTED_QUERY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AttributeQuery()	Default constructor
	AttributeQuery(Subject theSubject)	Constructor to construct an AttributeQuery with 0 AttributeDesignator, and no Resource attribute.
	AttributeQuery(Subject theSubject, List designators)	Constructor to construct an AttributeQuery with a list of AttributeDesignators.
	AttributeQuery(Subject theSubject, List designators, String theResource)	Constructor.
	AttributeQuery(Element element)	This constructor is used to build an Attribute Query from a DOM tree that was built from the XML string.

Method Summary

Modifier and Type	Method	Description
List	getAttributeDesignator()	Returns the AttributeDesignators.
int	getQueryType()	Returns the type of the query.
String	getResource()	Returns the Resource String.
String	toString()	Returns the String Representation of the AttributeQuery object.
String	toString(boolean includeNS, boolean declareNS)	Returns a String representation of the samlp:AttributeQuery element.

Methods inherited from class com.sun.identity.saml.protocol.SubjectQuery

getSubject

Methods inherited from class java.lang.Object

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

Field Detail

attributeDesignators

protected List attributeDesignators

O or more AttributeDesignator of this query.

resource

protected String resource

Constructor Detail

AttributeQuery

protected AttributeQuery()

Default constructor

AttributeQuery

public AttributeQuery(Element element)
               throws SAMLException

This constructor is used to build an Attribute Query from a DOM tree that was built from the XML string.

Parameters:

element - the DOM tree element which contains an Attribute Query.

Throws:

SAMLException

AttributeQuery

public AttributeQuery(Subject theSubject,
                      List designators,
                      String theResource)
               throws SAMLException

Constructor.

Parameters:

theSubject - Subject of this query.

designators - List of AttributeDesignators of this query.

theResource - the Resource attribute of this query in String format.

Throws:

SAMLException

AttributeQuery

public AttributeQuery(Subject theSubject,
                      List designators)
               throws SAMLException

Constructor to construct an AttributeQuery with a list of AttributeDesignators.

Parameters:

theSubject - Subject of this query.

designators - List of AttributeDesignators of this query.

Throws:

SAMLException

AttributeQuery

public AttributeQuery(Subject theSubject)
               throws SAMLException

Constructor to construct an AttributeQuery with 0 AttributeDesignator, and no Resource attribute.

Parameters:

theSubject - Subject of this query.

Throws:

SAMLException

Method Detail

getResource

public String getResource()

Returns the Resource String.

Returns:

the Resource associated with this query in String format; or null if there is none.

getAttributeDesignator

public List getAttributeDesignator()

Returns the AttributeDesignators.

Returns:

the AttributeDesignators(s) associated with this query. It could contain 0 or more AttributeDesignators.

getQueryType

public int getQueryType()

Returns the type of the query.

Specified by:

getQueryType in class Query

Returns:

an integer which is Query.ATTRIBUTE_QUERY.

toString

public String toString()

Returns the String Representation of the AttributeQuery object.

Overrides:

toString in class Object

Returns:

XML String representing the AttributeQuery.

toString

public String toString(boolean includeNS,
                       boolean declareNS)

Returns a String representation of the samlp:AttributeQuery element.

Specified by:

toString in class Query

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 containing the valid XML for this element.