org.opensaml
Class SAMLAuthenticationQuery

java.lang.Object
  |
  +--org.opensaml.SAMLObject
        |
        +--org.opensaml.SAMLQuery
              |
              +--org.opensaml.SAMLAuthenticationQuery

All Implemented Interfaces:

java.lang.Cloneable

public class SAMLAuthenticationQuery

extends SAMLQuery

implements java.lang.Cloneable

Represents a SAML Authentication Query object

Author:

Scott Cantor

Field Summary

Fields inherited from class org.opensaml.SAMLQuery

queryTypeMap

Fields inherited from class org.opensaml.SAMLObject

config, log, root

Constructor Summary

SAMLAuthenticationQuery(org.w3c.dom.Element e)
Reconstructs an authentication query from a DOM tree

SAMLAuthenticationQuery(java.io.InputStream in)
Reconstructs an authentication query from a stream

SAMLAuthenticationQuery(SAMLSubject subject, java.lang.String authMethod)
Builds an authentication query out of its component parts

Method Summary

java.lang.Object	clone() Copies a SAML object such that no dependencies exist between the original and the copy
void	fromDOM(org.w3c.dom.Element e) Initialization of authentication query from a DOM element.
java.lang.String	getAuthMethod() Gets the authentication method inside the query
SAMLSubject	getSubject() Gets the query subject
org.w3c.dom.Node	toDOM(org.w3c.dom.Document doc) Overridden method to return a DOM tree representing the request

Methods inherited from class org.opensaml.SAMLObject

fromStream, plantRoot, toBase64, toDOM, toStream, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SAMLAuthenticationQuery

public SAMLAuthenticationQuery(SAMLSubject subject,
                               java.lang.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(org.w3c.dom.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(java.io.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(org.w3c.dom.Element e)
             throws SAMLException

Initialization of authentication query from a DOM element.

Checks the query's syntactic validity. An exception is thrown if any problems are detected. The exception will contain a message describing the problem, and may wrap another exception.

Overrides:

fromDOM in class SAMLObject

Parameters:

e - Root element of a DOM tree

Throws:

SAMLException - Raised if an exception occurs while constructing the object.

getSubject

public SAMLSubject getSubject()

Gets the query subject

Returns:

The query subject

getAuthMethod

public java.lang.String getAuthMethod()

Gets the authentication method inside the query

Returns:

The authentication method URI

toDOM

public org.w3c.dom.Node toDOM(org.w3c.dom.Document doc)

Overridden method to return a DOM tree representing the request

Overrides:

toDOM in class SAMLObject

Parameters:

doc - A Document object to use in manufacturing the tree

Returns:

Root "AttributeQuery" element of a DOM tree

clone

public java.lang.Object clone()
                       throws java.lang.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

java.lang.CloneNotSupportedException

See Also:

Object.clone()