org.opensaml
Class SAMLSubjectQuery

java.lang.Object
  extended byorg.opensaml.SAMLObject
      extended byorg.opensaml.SAMLQuery
          extended byorg.opensaml.SAMLSubjectQuery
All Implemented Interfaces:
Cloneable
Direct Known Subclasses:
SAMLAttributeQuery, SAMLAuthenticationQuery, SAMLAuthorizationDecisionQuery

public abstract class SAMLSubjectQuery
extends SAMLQuery
implements Cloneable

Abstract class for a SAML Subject Statement

Author:
Scott Cantor

Field Summary
protected  SAMLSubject subject
           
 
Fields inherited from class org.opensaml.SAMLQuery
queryTypeMap
 
Fields inherited from class org.opensaml.SAMLObject
config, dirty, log, parentObject, root
 
Constructor Summary
SAMLSubjectQuery()
          Default constructor
SAMLSubjectQuery(Element e)
          Reconstructs a subject query from a DOM tree
SAMLSubjectQuery(InputStream in)
          Reconstructs a subject query from a stream
SAMLSubjectQuery(SAMLSubject subject)
          Builds a subject query out of its component parts
 
Method Summary
 void checkValidity()
          Evaluates the object's content to see if it is currently valid if serialized.
 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
 SAMLSubject getSubject()
          Gets the query subject
 void setSubject(SAMLSubject subject)
          Sets the query subject
 Node toDOM(Document doc, boolean xmlns)
          Transforms the object into a DOM tree using an existing document context
 
Methods inherited from class org.opensaml.SAMLQuery
getInstance, getInstance, regFactory, unregFactory
 
Methods inherited from class org.opensaml.SAMLObject
buildRoot, 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

subject

protected SAMLSubject subject
Constructor Detail

SAMLSubjectQuery

public SAMLSubjectQuery()
Default constructor


SAMLSubjectQuery

public SAMLSubjectQuery(SAMLSubject subject)
                 throws SAMLException
Builds a subject query out of its component parts

Parameters:
subject - Subject of query
Throws:
SAMLException - Raised if a statement cannot be constructed from the supplied information

SAMLSubjectQuery

public SAMLSubjectQuery(Element e)
                 throws SAMLException
Reconstructs a subject query from a DOM tree

Parameters:
e - The root of a DOM tree
Throws:
SAMLException - Thrown if the object cannot be constructed

SAMLSubjectQuery

public SAMLSubjectQuery(InputStream in)
                 throws SAMLException
Reconstructs a subject 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 SAMLObject
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)

getSubject

public SAMLSubject getSubject()
Gets the query subject

Returns:
The query subject

setSubject

public void setSubject(SAMLSubject subject)
                throws SAMLException
Sets the query subject

Parameters:
subject - The query subject
Throws:
SAMLException - Raised if the subject is invalid

checkValidity

public void checkValidity()
                   throws SAMLException
Description copied from class: SAMLObject
Evaluates the object's content to see if it is currently valid if serialized. Does not evaluate embedded objects except on the basis of whether they exist. For example, an Assertion must have a Statement, but if an invalid statement is added, SAMLAssertion.checkValidity() would succeed, while SAMLStatement.checkValidity would raise an exception.

Specified by:
checkValidity in class SAMLObject
Throws:
SAMLException - Raised if the serialized object would be invalid SAML, excluding any embedded objects
See Also:
SAMLObject.checkValidity()

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 SAMLObject
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 SAMLObject
Returns:
The new object
Throws:
CloneNotSupportedException
See Also:
Object.clone()


Copyright ? 2005 UCAID. All Rights Reserved.