Package com.sun.identity.saml2.assertion

Interface AuthnContext

All Known Implementing Classes:

AuthnContextImpl

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>
 

Method Summary

Modifier and Type	Method	Description
List<String>	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<String> 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.

Method Detail

makeImmutable

void makeImmutable()

Makes the object immutable.

isMutable

boolean isMutable()

Returns the mutability of the object.

Returns:

true if the object is mutable; false otherwise.

getAuthnContextClassRef

String getAuthnContextClassRef()

Returns the value of the AuthnContextClassRef property.

Returns:

the value of the AuthnContextClassRef.

See Also:

setAuthnContextClassRef(String)

setAuthnContextClassRef

void setAuthnContextClassRef(String value)
                      throws SAML2Exception

Sets the value of the AuthnContextClassRef property.

Parameters:

value - new AuthenticationContextClassRef.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getAuthnContextClassRef()

getAuthnContextDeclRef

String getAuthnContextDeclRef()

Returns the value of the AuthnContextDeclRef property.

Returns:

A String representing authentication context declaration reference.

See Also:

setAuthnContextDeclRef(String)

setAuthnContextDeclRef

void setAuthnContextDeclRef(String value)
                     throws SAML2Exception

Sets the value of the AuthnContextDeclRef property.

Parameters:

value - A String representation of authentication context declaration reference.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getAuthnContextDeclRef()

getAuthnContextDecl

String getAuthnContextDecl()

Returns the value of the AuthnContextDecl property.

Returns:

An XML String representing authentication context declaration.

See Also:

setAuthnContextDecl(String)

setAuthnContextDecl

void setAuthnContextDecl(String value)
                  throws SAML2Exception

Sets the value of the AuthnContextDecl property.

Parameters:

value - An xml String representing authentication context declaration.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getAuthnContextDecl()

setAuthenticatingAuthority

void setAuthenticatingAuthority(List<String> value)
                         throws SAML2Exception

Sets the value of the AuthenticatingAuthority property.

Parameters:

value - List of Strings representing authenticating authority

Throws:

SAML2Exception - if the object is immutable.

See Also:

getAuthenticatingAuthority()

getAuthenticatingAuthority

List<String> getAuthenticatingAuthority()

Returns the value of the AuthenticatingAuthority property.

Returns:

List of Strings representing AuthenticatingAuthority.

See Also:

setAuthenticatingAuthority(List)

toXMLString

String toXMLString()
            throws SAML2Exception

Returns a String representation of the element.

Returns:

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

Throws:

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.

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:

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