com.sun.identity.federation.message.common
Class AuthnContext

java.lang.Object
  com.sun.identity.federation.message.common.AuthnContext

public class AuthnContext

extends java.lang.Object

This class AuthnContext represents an Authentication Context for the authenticated user with a requested authn context. Currently, there is no authentication statement included, however, eventually, we need to provider a plugin for adding an AuthnContextStatement.

Constructor Summary

AuthnContext()
Default constructor

AuthnContext(org.w3c.dom.Element root)
Constructor which parses the dom element.

AuthnContext(java.lang.String authnContextClassRef, java.lang.String authnContextStatementRef)
Constructor

Method Summary

java.lang.String	getAuthnContextClassRef() Gets AuthnContext Class Reference URI
java.lang.String	getAuthnContextStatementRef() Gets AuthnContext Statement Reference URI.
int	getMinorVersion() Gets minor version
void	setAuthnContextClassRef(java.lang.String authnContextClassRef) Sets AuthnContext Class Reference URI.
void	setAuthnContextStatementRef(java.lang.String authnContextStatementRef) Sets AuthnContext Statement Reference URI.
void	setMinorVersion(int version) Sets Minor Version
java.lang.String	toXMLString() Converts into an XML String.
java.lang.String	toXMLString(boolean includeNS, boolean declareNS) Converts into an XML String.
java.lang.String	toXMLString(boolean includeNS, boolean declareNS, boolean includeHeader) Converts into an XML String.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthnContext

public AuthnContext(java.lang.String authnContextClassRef,
                    java.lang.String authnContextStatementRef)

Constructor

Parameters:

authnContextClassRef - Authentication Context Class Reference URI

authnContextStatementRef - Authentication Context Statement Reference URI

AuthnContext

public AuthnContext()

Default constructor

AuthnContext

public AuthnContext(org.w3c.dom.Element root)
             throws FSMsgException

Constructor which parses the dom element.

Parameters:

root - AuthnContext DOM Element.

Throws:

FSMsgException - for parsing failures.

Method Detail

getAuthnContextClassRef

public java.lang.String getAuthnContextClassRef()

Gets AuthnContext Class Reference URI

Returns:

String AuthnContextClass Ref URI.

setAuthnContextClassRef

public void setAuthnContextClassRef(java.lang.String authnContextClassRef)

Sets AuthnContext Class Reference URI.

Parameters:

authnContextClassRef - AuthnContext Class Ref URI.

getAuthnContextStatementRef

public java.lang.String getAuthnContextStatementRef()

Gets AuthnContext Statement Reference URI.

Returns:

String AuthnContext Statement Reference URI.

setAuthnContextStatementRef

public void setAuthnContextStatementRef(java.lang.String authnContextStatementRef)

Sets AuthnContext Statement Reference URI.

Parameters:

authnContextStatementRef - AuthnContext Statement Ref URI.

getMinorVersion

public int getMinorVersion()

Gets minor version

Returns:

minor version

setMinorVersion

public void setMinorVersion(int version)

Sets Minor Version

Parameters:

version - minor version to be set

toXMLString

public java.lang.String toXMLString()
                             throws FSMsgException

Converts into an XML String.

Returns:

A string containing the valid XML for this element

Throws:

FSMsgException - if unable to get the XML string

toXMLString

public java.lang.String toXMLString(boolean includeNS,
                                    boolean declareNS)
                             throws FSMsgException

Converts into an XML String.

Parameters:

includeNS - Determines whether or not the namespace qualifier is prepended to the Element when converted

declareNS - Determines whether or not the namespace is declared within the Element.

Returns:

A string containing the valid XML for this element

Throws:

FSMsgException - if unable to get the XML string

toXMLString

public java.lang.String toXMLString(boolean includeNS,
                                    boolean declareNS,
                                    boolean includeHeader)
                             throws FSMsgException

Converts into an XML String.

Parameters:

includeNS - Determines whether or not the namespace qualifier is prepended to the Element when converted

declareNS - Determines whether or not the namespace is declared within the Element.

includeHeader - Determines whether the output include the xml declaration header.

Returns:

A string containing the valid XML for this element

Throws:

FSMsgException - if unable to get the XML string