org.opensaml
Class SAMLAuthenticationStatement

java.lang.Object
  |
  +--org.opensaml.SAMLObject
        |
        +--org.opensaml.SAMLStatement
              |
              +--org.opensaml.SAMLAuthenticationStatement

All Implemented Interfaces:

java.lang.Cloneable

public class SAMLAuthenticationStatement

extends SAMLStatement

implements java.lang.Cloneable

Represents a SAML Authentication Statement

Author:

Scott Cantor

Field Summary

Fields inherited from class org.opensaml.SAMLStatement

statementTypeMap

Fields inherited from class org.opensaml.SAMLObject

config, log, root

Constructor Summary

SAMLAuthenticationStatement(org.w3c.dom.Element e)
Reconstructs a statement from a DOM tree

SAMLAuthenticationStatement(java.io.InputStream in)
Reconstructs a statement from a stream

SAMLAuthenticationStatement(SAMLSubject subject, java.lang.String authMethod, java.util.Date authInstant, java.lang.String subjectIP, java.lang.String subjectDNS, java.util.Collection bindings)
Builds a statement 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 statement from a DOM element.
java.util.Date	getAuthInstant() Gets the datetime of authentication
java.lang.String	getAuthMethod() Gets the authentication method
java.util.Iterator	getBindings() Gets SAML authority binding information
SAMLSubject	getSubject() Gets the subject of the statement
java.lang.String	getSubjectDNS() Gets the subject's DNS address
java.lang.String	getSubjectIP() Gets the subject's IP address
org.w3c.dom.Node	toDOM(org.w3c.dom.Document doc) Overridden method to return a DOM tree representing the statement

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

SAMLAuthenticationStatement

public SAMLAuthenticationStatement(SAMLSubject subject,
                                   java.lang.String authMethod,
                                   java.util.Date authInstant,
                                   java.lang.String subjectIP,
                                   java.lang.String subjectDNS,
                                   java.util.Collection bindings)
                            throws SAMLException

Builds a statement out of its component parts

Parameters:

subject - Subject of statement

authMethod - URI of authentication method

authInstant - Datetime of authentication

subjectIP - IP address of subject in dotted decimal notation (optional)

subjectDNS - DNS address of subject (optional)

bindings - Collection of SAMLAuthorityBinding objects to reference SAML responders (optional)

Throws:

SAMLException - Raised if a statement cannot be constructed from the supplied information

SAMLAuthenticationStatement

public SAMLAuthenticationStatement(org.w3c.dom.Element e)
                            throws SAMLException

Reconstructs a statement from a DOM tree

Parameters:

e - The root of a DOM tree

Throws:

SAMLException - Thrown if the object cannot be constructed

SAMLAuthenticationStatement

public SAMLAuthenticationStatement(java.io.InputStream in)
                            throws SAMLException

Reconstructs a statement 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 statement from a DOM element.

Checks the statement'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 subject of the statement

Returns:

The subject of the statement

getSubjectIP

public java.lang.String getSubjectIP()

Gets the subject's IP address

Returns:

The subject's IP address in dotted decimal notation

getSubjectDNS

public java.lang.String getSubjectDNS()

Gets the subject's DNS address

Returns:

The subject's DNS address

getAuthMethod

public java.lang.String getAuthMethod()

Gets the authentication method

Returns:

The authentication method URI

getAuthInstant

public java.util.Date getAuthInstant()

Gets the datetime of authentication

Returns:

The date and time of authentication

getBindings

public java.util.Iterator getBindings()

Gets SAML authority binding information

Returns:

An iterator of bindings

toDOM

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

Overridden method to return a DOM tree representing the statement

Overrides:

toDOM in class SAMLObject

Parameters:

doc - A Document object to use in manufacturing the tree

Returns:

Root "AuthenticationStatement" 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()