|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opensaml.SAMLObject
org.opensaml.SAMLQuery
org.opensaml.SAMLSubjectQuery
org.opensaml.SAMLAttributeQuery
public class SAMLAttributeQuery
Represents a SAML Attribute Query object
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 |
---|
protected String resource
protected ArrayList designators
Constructor Detail |
---|
public SAMLAttributeQuery()
public SAMLAttributeQuery(SAMLSubject subject, String resource, Collection designators) throws SAMLException
subject
- Subject of queryresource
- URI of resource being accessed at time of
querydesignators
- Indicates specific attributes to query for
SAMLException
- Raised if the query cannot be constructed from
the supplied informationpublic SAMLAttributeQuery(Element e) throws SAMLException
e
- The root of a DOM tree
SAMLException
- Thrown if the object cannot be constructedpublic SAMLAttributeQuery(InputStream in) throws SAMLException
in
- A stream containing XML
SAMLException
- Raised if an exception occurs while constructing
the object.Method Detail |
---|
public void fromDOM(Element e) throws SAMLException
SAMLObject
fromDOM
in class SAMLSubjectQuery
e
- Root element of a DOM tree
SAMLException
- Raised if an exception occurs while constructing
the objectSAMLObject.fromDOM(org.w3c.dom.Element)
public String getResource()
public void setResource(String resource)
resource
- The resource URIpublic Iterator getDesignators()
public void setDesignators(Collection designators) throws SAMLException
designators
- The designators to include
SAMLException
- Raised if the designators are invalidpublic void addDesignator(SAMLAttributeDesignator designator) throws SAMLException
designator
- The designator to add
SAMLException
- Raised if the designator is invalidpublic void removeDesignator(int index)
index
- The position of the designator to removeprotected Element buildRoot(Document doc, boolean xmlns)
SAMLObject
buildRoot
in class SAMLObject
doc
- The document context to usexmlns
- Include namespace(s) on root element?
SAMLObject.buildRoot(org.w3c.dom.Document,boolean)
public Node toDOM(Document doc, boolean xmlns) throws SAMLException
SAMLObject
toDOM
in class SAMLSubjectQuery
doc
- A Document object to use in manufacturing the treexmlns
- Include namespace(s) on root element?
SAMLException
- Raised if the object is incompletely definedSAMLObject.toDOM(org.w3c.dom.Document,boolean)
public Object clone() throws CloneNotSupportedException
clone
in class SAMLSubjectQuery
CloneNotSupportedException
Object.clone()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |