org.opensaml
Class SAMLAuthenticationQuery

java.lang.Object
  extended by org.opensaml.SAMLObject
      extended by org.opensaml.SAMLQuery
          extended by org.opensaml.SAMLSubjectQuery
              extended by org.opensaml.SAMLAuthenticationQuery
All Implemented Interfaces:
Cloneable

public class SAMLAuthenticationQuery
extends SAMLSubjectQuery
implements Cloneable

Represents a SAML Authentication Query object

Author:
Scott Cantor

Field Summary
protected  String authMethod
           
 
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
SAMLAuthenticationQuery()
          Default constructor
SAMLAuthenticationQuery(Element e)
          Reconstructs an authentication query from a DOM tree
SAMLAuthenticationQuery(InputStream in)
          Reconstructs an authentication query from a stream
SAMLAuthenticationQuery(SAMLSubject subject, String authMethod)
          Builds an authentication query out of its component parts
 
Method Summary
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
 String getAuthMethod()
          Gets the authentication method inside the query
 void setAuthMethod(String authMethod)
          Sets the authentication method 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

authMethod

protected String authMethod
Constructor Detail

SAMLAuthenticationQuery

public SAMLAuthenticationQuery()
Default constructor


SAMLAuthenticationQuery

public SAMLAuthenticationQuery(SAMLSubject subject,
                               String authMethod)
                        throws SAMLException
Builds an authentication query out of its component parts

Parameters:
subject - Subject of query
authMethod - Authentication method in query
Throws:
SAMLException - Raised if the query cannot be constructed from the supplied information

SAMLAuthenticationQuery

public SAMLAuthenticationQuery(Element e)
                        throws SAMLException
Reconstructs an authentication query from a DOM tree

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

SAMLAuthenticationQuery

public SAMLAuthenticationQuery(InputStream in)
                        throws SAMLException
Reconstructs an authentication 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)

getAuthMethod

public String getAuthMethod()
Gets the authentication method inside the query

Returns:
The authentication method URI

setAuthMethod

public void setAuthMethod(String authMethod)
Sets the authentication method inside the query

Parameters:
authMethod - The authentication method URI

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


Copyright ? 2005 UCAID. All Rights Reserved.