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

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

public class RequestAuthnContext

extends java.lang.Object

This class RequestAuthnContext represents the requesting Authentication Context as part of the FSAuthnRequest.

Constructor Summary

RequestAuthnContext()
Default constructor

RequestAuthnContext(org.w3c.dom.Element root)
Constructor

RequestAuthnContext(java.util.List authnContextClassRefList, java.util.List authnContextStatementRefList, java.lang.String authnContextComparison)
Constructor

Method Summary

java.util.List	getAuthnContextClassRefList() Gets AuthnContext Class References.
java.lang.String	getAuthnContextComparison() Gets the AuthnContext Comparison.
java.util.List	getAuthnContextStatementRefList() Gets AuthnContext Statement References.
int	getMinorVersion() Gets Minor Version
static RequestAuthnContext	parseURLEncodedRequest(javax.servlet.http.HttpServletRequest request, int minorVersion) Parses the url encoded request and creates an authncontext.
void	setAuthnContextClassRefList(java.util.List authnContextClassRefList) Sets AuthnContext Class References.
void	setAuthnContextComparison(java.lang.String authnContextComparison) Sets the authncontext comparison.
void	setAuthnContextStatementRefList(java.util.List authnContextStatementRefList) Sets AuthnContext Statement References.
void	setMinorVersion(int minorVersion) Sets the Minor Version.
java.lang.String	toURLEncodedQueryString() Converts into a URL encoded query string.
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

RequestAuthnContext

public RequestAuthnContext(java.util.List authnContextClassRefList,
                           java.util.List authnContextStatementRefList,
                           java.lang.String authnContextComparison)

Constructor

Parameters:

authnContextClassRefList - Ordered list of AuthnContext Classes references.

RequestAuthnContext

public RequestAuthnContext()

Default constructor

RequestAuthnContext

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

Constructor

Parameters:

root - DOM Element

Throws:

FSMsgException - if unable to construct the object

Method Detail

getAuthnContextClassRefList

public java.util.List getAuthnContextClassRefList()

Gets AuthnContext Class References.

Returns:

list of AuthnContext Class References.

setAuthnContextClassRefList

public void setAuthnContextClassRefList(java.util.List authnContextClassRefList)

Sets AuthnContext Class References.

Parameters:

authnContextClassRefList - list of AuthnContext Class References. to be set.

getAuthnContextStatementRefList

public java.util.List getAuthnContextStatementRefList()

Gets AuthnContext Statement References.

Returns:

AuthnContext Statement References.

setAuthnContextStatementRefList

public void setAuthnContextStatementRefList(java.util.List authnContextStatementRefList)

Sets AuthnContext Statement References.

Parameters:

authnContextStatementRefList - list of AuthnContext Statement References to be set.

getAuthnContextComparison

public java.lang.String getAuthnContextComparison()

Gets the AuthnContext Comparison.

Returns:

AuthnContext Comparison.

setAuthnContextComparison

public void setAuthnContextComparison(java.lang.String authnContextComparison)

Sets the authncontext comparison.

Parameters:

authnContextComparison - AuthnContext Comparison to be set.

getMinorVersion

public int getMinorVersion()

Gets Minor Version

Returns:

minor version

setMinorVersion

public void setMinorVersion(int minorVersion)

Sets the Minor Version.

Parameters:

minorVersion - 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.

parseURLEncodedRequest

public static RequestAuthnContext parseURLEncodedRequest(javax.servlet.http.HttpServletRequest request,
                                                         int minorVersion)
                                                  throws FSMsgException

Parses the url encoded request and creates an authncontext.

Parameters:

request - HttpServletRequest object to retrieve the query parameters.

minorVersion - minor version of the request

Returns:

RequestAuthnContext object

Throws:

FSMsgException - if unable to parse the object.

toURLEncodedQueryString

public java.lang.String toURLEncodedQueryString()
                                         throws FSMsgException

Converts into a URL encoded query string.

Returns:

URL encoded query string.

Throws:

FSMsgException - if fail to convert