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

java.lang.Object
  上位を拡張 com.sun.identity.federation.message.common.AuthnContext

public class AuthnContext
extends Object

This class AuthnContext represents an Authentication Context for the authenticated user with a requested authn context.


フィールドの概要
protected  String authnContextClassRef
           
protected  String authnContextStatementRef
           
protected  int minorVersion
           
 
コンストラクタの概要
AuthnContext()
          Default constructor
AuthnContext(Element root)
          Constructor creates AuthnContext object from the Document Element.
AuthnContext(String authnContextClassRef, String authnContextStatementRef)
          Constructor creates AuthnContext object.
 
メソッドの概要
 String getAuthnContextClassRef()
          Returns the AuthnContext Class Reference URI.
 String getAuthnContextStatementRef()
          Returns the AuthnContext Statement Reference URI.
 int getMinorVersion()
          Returns the MinorVersion attribute.
 void setAuthnContextClassRef(String authnContextClassRef)
          Sets the AuthnContext Class Reference URI.
 void setAuthnContextStatementRef(String authnContextStatementRef)
          Sets AuthnContext Statement Reference URI.
 void setMinorVersion(int version)
          Sets the MinorVersion.
 String toXMLString()
          Returns the string representation of this object.
 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 this object.
 

フィールドの詳細

authnContextClassRef

protected String authnContextClassRef

authnContextStatementRef

protected String authnContextStatementRef

minorVersion

protected int minorVersion
コンストラクタの詳細

AuthnContext

public AuthnContext()
Default constructor


AuthnContext

public AuthnContext(String authnContextClassRef,
                    String authnContextStatementRef)
Constructor creates AuthnContext object.

パラメータ:
authnContextClassRef - Authentication Context Class Reference URI
authnContextStatementRef - Authentication Context Statement Reference URI

AuthnContext

public AuthnContext(Element root)
             throws FSMsgException
Constructor creates AuthnContext object from the Document Element.

パラメータ:
root - the Document Element.
例外:
FSMsgException - on error.
メソッドの詳細

getAuthnContextClassRef

public String getAuthnContextClassRef()
Returns the AuthnContext Class Reference URI.

戻り値:
the AuthnContext Class Reference URI.
関連項目:
AuthnContext.setAuthnContextClassRef(java.lang.String)

setAuthnContextClassRef

public void setAuthnContextClassRef(String authnContextClassRef)
Sets the AuthnContext Class Reference URI.

パラメータ:
authnContextClassRef - AuthnContext Class Ref URI.
関連項目:
AuthnContext.getAuthnContextClassRef()

getAuthnContextStatementRef

public String getAuthnContextStatementRef()
Returns the AuthnContext Statement Reference URI.

戻り値:
the AuthnContext Statement Reference URI.
関連項目:
AuthnContext.setAuthnContextStatementRef(java.lang.String)

setAuthnContextStatementRef

public void setAuthnContextStatementRef(String authnContextStatementRef)
Sets AuthnContext Statement Reference URI.

パラメータ:
authnContextStatementRef - AuthnContext Statement Ref URI.
関連項目:
AuthnContext.getAuthnContextStatementRef()

getMinorVersion

public int getMinorVersion()
Returns the MinorVersion attribute.

戻り値:
the Minor Version.
関連項目:
AuthnContext.setMinorVersion(int)

setMinorVersion

public void setMinorVersion(int version)
Sets the MinorVersion.

パラメータ:
version - the minor version in the assertion.
関連項目:
AuthnContext.setMinorVersion(int)

toXMLString

public String toXMLString()
                   throws FSMsgException
Returns the string representation of this object. This method translates the response to an XML document string.

戻り値:
An XML String representing the response. NOTE: this is a complete SAML response xml string with ResponseID, MajorVersion, etc.
例外:
FSMsgException

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 ot a string.

toXMLString

public String toXMLString(boolean includeNS,
                          boolean declareNS,
                          boolean includeHeader)
                   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.
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.