com.sun.identity.federation.message.common
クラス RequestAuthnContext

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

public class RequestAuthnContext
extends Object

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

コンストラクタの概要

RequestAuthnContext()
Default constructor.

RequestAuthnContext(Element root)
Constructor to create RequestAuthnContext object from Docuemnt Element.

RequestAuthnContext(List authnContextClassRefList, List authnContextStatementRefList, String authnContextComparison)
Constructor to create RequestAuthnContext object.

メソッドの概要

List	getAuthnContextClassRefList() Returns List of AuthnContext Class References.
String	getAuthnContextComparison() Returns the AuthnContext Comparison type.
List	getAuthnContextStatementRefList() Returns a List of AuthnContext Statement References.
int	getMinorVersion() Returns the MinorVersion.
static RequestAuthnContext	parseURLEncodedRequest(HttpServletRequest request, int minorVersion) Returns RequestAuthnContext object.
void	setAuthnContextClassRefList(List authnContextClassRefList) Sets a List of AuthnContext Class References.
void	setAuthnContextComparison(String authnContextComparison) Sets the AuthnContext comparison type.
void	setAuthnContextStatementRefList(List authnContextStatementRefList) Sets a List of AuthnContext Statement References.
void	setMinorVersion(int minorVersion) Sets the MinorVersion.
String	toURLEncodedQueryString() Returns an URL Encoded String.
String	toXMLString() Returns a String representation of the Logout Response.
String	toXMLString(boolean includeNS, boolean declareNS) Returns a String representation of this object.
String	toXMLString(boolean includeNS, boolean declareNS, boolean includeHeader) Returns a String representation of the Logout Response.

コンストラクタの詳細

RequestAuthnContext

public RequestAuthnContext(List authnContextClassRefList,
                           List authnContextStatementRefList,
                           String authnContextComparison)

Constructor to create RequestAuthnContext object.

パラメータ:

authnContextClassRefList - Ordered list of AuthnContext Classes Refs.

authnContextStatementRefList - Ordered list of AuthnContext Statement Refs. Note: authnContextClassRefList and authContextStatementRefList are mutually exclusive lists.

authnContextComparison - AuthnContext Comparison Type. Possible values are exact, minimum, better and maximum.

RequestAuthnContext

public RequestAuthnContext()

Default constructor.

RequestAuthnContext

public RequestAuthnContext(Element root)
                    throws FSMsgException

Constructor to create RequestAuthnContext object from Docuemnt Element.

パラメータ:

root - the Document Element.

例外:

FSMsgException - on error.

メソッドの詳細

getAuthnContextClassRefList

public List getAuthnContextClassRefList()

Returns List of AuthnContext Class References.

戻り値:

List of AuthnContext Class Reference classes.

関連項目:

RequestAuthnContext.setAuthnContextClassRefList(List)

setAuthnContextClassRefList

public void setAuthnContextClassRefList(List authnContextClassRefList)

Sets a List of AuthnContext Class References.

パラメータ:

authnContextClassRefList - a List of AuthnContext Class References.

関連項目:

RequestAuthnContext.getAuthnContextClassRefList()

getAuthnContextStatementRefList

public List getAuthnContextStatementRefList()

Returns a List of AuthnContext Statement References.

戻り値:

a List of AuthnContext Statement References.

関連項目:

RequestAuthnContext.setAuthnContextStatementRefList(List)

setAuthnContextStatementRefList

public void setAuthnContextStatementRefList(List authnContextStatementRefList)

Sets a List of AuthnContext Statement References.

パラメータ:

authnContextStatementRefList - a List of AuthnContext Statement References.

関連項目:

RequestAuthnContext.getAuthnContextStatementRefList()

getAuthnContextComparison

public String getAuthnContextComparison()

Returns the AuthnContext Comparison type.

戻り値:

authnContextComparison the AuthnContext Comparison type.

関連項目:

RequestAuthnContext.setAuthnContextComparison(String)

setAuthnContextComparison

public void setAuthnContextComparison(String authnContextComparison)

Sets the AuthnContext comparison type.

パラメータ:

authnContextComparison - the AuthnContext comparison type.

関連項目:

RequestAuthnContext.getAuthnContextComparison()

getMinorVersion

public int getMinorVersion()

Returns the MinorVersion.

戻り値:

the MinorVersion.

関連項目:

RequestAuthnContext.setMinorVersion(int)

setMinorVersion

public void setMinorVersion(int minorVersion)

Sets the MinorVersion.

パラメータ:

minorVersion - the MinorVersion.

関連項目:

RequestAuthnContext.getMinorVersion()

toXMLString

public String toXMLString()
                   throws FSMsgException

Returns a String representation of the Logout Response.

戻り値:

a string containing the valid XML for this element

例外:

FSMsgException - if there is an error converting this object ot a string.

toXMLString

public String toXMLString(boolean includeNS,
                          boolean declareNS)
                   throws FSMsgException

Returns a String representation of this object.

パラメータ:

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.

戻り値:

a string containing the valid XML for this element

例外:

FSMsgException - if there is an error converting this object to a string.

toXMLString

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

Returns a String representation of the Logout Response.

パラメータ:

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.

戻り値:

a string containing the valid XML for this element

例外:

FSMsgException - if there is an error converting this object ot a string.

parseURLEncodedRequest

public static RequestAuthnContext parseURLEncodedRequest(HttpServletRequest request,
                                                         int minorVersion)
                                                  throws FSMsgException

Returns RequestAuthnContext object. The object is creating by parsing the HttpServletRequest object.

パラメータ:

request - the HttpServletRequest object.

戻り値:

object.

例外:

FSMsgException - if there is an error creating RequestAuthnContext object.

toURLEncodedQueryString

public String toURLEncodedQueryString()
                               throws FSMsgException

Returns an URL Encoded String.

戻り値:

a url encoded query string.

例外:

FSMsgException - if there is an error.