com.sun.identity.saml2.assertion
インタフェース AuthnContext

public interface AuthnContext

The AuthnContext element specifies the context of an authentication event. The element can contain an authentication context class reference, an authentication declaration or declaration reference, or both. Its type is AuthnContextType.

 <complexType name="AuthnContextType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <choice>
           <sequence>
             <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}
             AuthnContextClassRef"/>
             <choice minOccurs="0">
               <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}
               AuthnContextDecl"/>
               <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}
               AuthnContextDeclRef"/>
             </choice>
           </sequence>
           <choice>
             <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}
             AuthnContextDecl"/>
             <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}
             AuthnContextDeclRef"/>
           </choice>
         </choice>
         <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}
         AuthenticatingAuthority" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

メソッドの概要

List	getAuthenticatingAuthority() Returns the value of the AuthenticatingAuthority property.
String	getAuthnContextClassRef() Returns the value of the AuthnContextClassRef property.
String	getAuthnContextDecl() Returns the value of the AuthnContextDecl property.
String	getAuthnContextDeclRef() Returns the value of the AuthnContextDeclRef property.
boolean	isMutable() Returns the mutability of the object.
void	makeImmutable() Makes the object immutable.
void	setAuthenticatingAuthority(List value) Sets the value of the AuthenticatingAuthority property.
void	setAuthnContextClassRef(String value) Sets the value of the AuthnContextClassRef property.
void	setAuthnContextDecl(String value) Sets the value of the AuthnContextDecl property.
void	setAuthnContextDeclRef(String value) Sets the value of the AuthnContextDeclRef property.
String	toXMLString() Returns a String representation of the element.
String	toXMLString(boolean includeNS, boolean declareNS) Returns a String representation of the element.

メソッドの詳細

makeImmutable

void makeImmutable()

Makes the object immutable.

isMutable

boolean isMutable()

Returns the mutability of the object.

戻り値:

true if the object is mutable; false otherwise.

getAuthnContextClassRef

String getAuthnContextClassRef()

Returns the value of the AuthnContextClassRef property.

戻り値:

the value of the AuthnContextClassRef.

関連項目:

AuthnContext.setAuthnContextClassRef(String)

setAuthnContextClassRef

void setAuthnContextClassRef(String value)
                             throws SAML2Exception

Sets the value of the AuthnContextClassRef property.

パラメータ:

value - new AuthenticationContextClassRef.

例外:

SAML2Exception - if the object is immutable.

関連項目:

AuthnContext.getAuthnContextClassRef()

getAuthnContextDeclRef

String getAuthnContextDeclRef()

Returns the value of the AuthnContextDeclRef property.

戻り値:

A String representing authentication context declaration reference.

関連項目:

AuthnContext.setAuthnContextDeclRef(String)

setAuthnContextDeclRef

void setAuthnContextDeclRef(String value)
                            throws SAML2Exception

Sets the value of the AuthnContextDeclRef property.

パラメータ:

value - A String representation of authentication context declaration reference.

例外:

SAML2Exception - if the object is immutable.

関連項目:

AuthnContext.getAuthnContextDeclRef()

getAuthnContextDecl

String getAuthnContextDecl()

Returns the value of the AuthnContextDecl property.

戻り値:

An XML String representing authentication context declaration.

関連項目:

AuthnContext.setAuthnContextDecl(String)

setAuthnContextDecl

void setAuthnContextDecl(String value)
                         throws SAML2Exception

Sets the value of the AuthnContextDecl property.

パラメータ:

value - An xml String representing authentication context declaration.

例外:

SAML2Exception - if the object is immutable.

関連項目:

AuthnContext.getAuthnContextDecl()

setAuthenticatingAuthority

void setAuthenticatingAuthority(List value)
                                throws SAML2Exception

Sets the value of the AuthenticatingAuthority property.

パラメータ:

value - List of Strings representing authenticating authority

例外:

SAML2Exception - if the object is immutable.

関連項目:

AuthnContext.getAuthenticatingAuthority()

getAuthenticatingAuthority

List getAuthenticatingAuthority()

Returns the value of the AuthenticatingAuthority property.

戻り値:

List of Strings representing AuthenticatingAuthority.

関連項目:

AuthnContext.setAuthenticatingAuthority(List)

toXMLString

String toXMLString()
                   throws SAML2Exception

Returns a String representation of the element.

戻り値:

A string containing the valid XML for this element. By default name space name is prepended to the element name.

例外:

SAML2Exception - if the object does not conform to the schema.

toXMLString

String toXMLString(boolean includeNS,
                   boolean declareNS)
                   throws SAML2Exception

Returns a String representation of the element.

パラメータ:

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

例外:

SAML2Exception - if the object does not conform to the schema.