com.sun.identity.saml2.assertion.impl

Class AuthnContextImpl

java.lang.Object

com.sun.identity.saml2.assertion.impl.AuthnContextImpl

All Implemented Interfaces:

AuthnContext

public class AuthnContextImpl
extends Object
implements AuthnContext

This is the default implementation of 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>
 

Constructor Summary

Constructors

Constructor and Description
AuthnContextImpl() Class constructor.
AuthnContextImpl(Element element) Class constructor with AuthnContext in Element format.
AuthnContextImpl(String xmlString) Class constructor with AuthnContext in xml string format.

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthnContextImpl

public AuthnContextImpl()

Class constructor. Caller may need to call setters to populate the object.

AuthnContextImpl

public AuthnContextImpl(Element element)
                 throws SAML2Exception

Class constructor with AuthnContext in Element format.

Throws:

SAML2Exception

AuthnContextImpl

public AuthnContextImpl(String xmlString)
                 throws SAML2Exception

Class constructor with AuthnContext in xml string format.

Throws:

SAML2Exception

Method Detail

makeImmutable

public void makeImmutable()

Makes the object immutable.

Specified by:

makeImmutable in interface AuthnContext

isMutable

public boolean isMutable()

Returns the mutability of the object.

Specified by:

isMutable in interface AuthnContext

Returns:

true if the object is mutable; false otherwise.

getAuthnContextClassRef

public String getAuthnContextClassRef()

Returns the value of the AuthnContextClassRef property.

Specified by:

getAuthnContextClassRef in interface AuthnContext

Returns:

the value of the AuthnContextClassRef.

See Also:

AuthnContext.setAuthnContextClassRef(String)

setAuthnContextClassRef

public void setAuthnContextClassRef(String value)
                             throws SAML2Exception

Sets the value of the AuthnContextClassRef property.

Specified by:

setAuthnContextClassRef in interface AuthnContext

Parameters:

value - new AuthenticationContextClassRef.

Throws:

SAML2Exception - if the object is immutable.

See Also:

AuthnContext.getAuthnContextClassRef()

getAuthnContextDeclRef

public String getAuthnContextDeclRef()

Returns the value of the AuthnContextDeclRef property.

Specified by:

getAuthnContextDeclRef in interface AuthnContext

Returns:

A String representing authentication context declaration reference.

See Also:

AuthnContext.setAuthnContextDeclRef(String)

setAuthnContextDeclRef

public void setAuthnContextDeclRef(String value)
                            throws SAML2Exception

Sets the value of the AuthnContextDeclRef property.

Specified by:

setAuthnContextDeclRef in interface AuthnContext

Parameters:

value - A String representation of authentication context declaration reference.

Throws:

SAML2Exception - if the object is immutable.

See Also:

AuthnContext.getAuthnContextDeclRef()

getAuthnContextDecl

public String getAuthnContextDecl()

Returns the value of the AuthnContextDecl property.

Specified by:

getAuthnContextDecl in interface AuthnContext

Returns:

An XML String representing authentication context declaration.

See Also:

AuthnContext.setAuthnContextDecl(String)

setAuthnContextDecl

public void setAuthnContextDecl(String value)
                         throws SAML2Exception

Sets the value of the AuthnContextDecl property.

Specified by:

setAuthnContextDecl in interface AuthnContext

Parameters:

value - An XML String representing authentication context declaration.

Throws:

SAML2Exception - if the object is immutable.

See Also:

AuthnContext.getAuthnContextDecl()

setAuthenticatingAuthority

public void setAuthenticatingAuthority(List<String> value)
                                throws SAML2Exception

Sets the value of the AuthenticatingAuthority property.

Specified by:

setAuthenticatingAuthority in interface AuthnContext

Parameters:

value - List of Strings representing authenticating authority.

Throws:

SAML2Exception - If the object is immutable.

See Also:

AuthnContext.getAuthenticatingAuthority()

getAuthenticatingAuthority

public List<String> getAuthenticatingAuthority()

Returns the value of the AuthenticatingAuthority property.

Specified by:

getAuthenticatingAuthority in interface AuthnContext

Returns:

List of Strings representing AuthenticatingAuthority.

See Also:

AuthnContext.setAuthenticatingAuthority(List)

toXMLString

public String toXMLString()
                   throws SAML2Exception

Returns a String representation of the element.

Specified by:

toXMLString in interface AuthnContext

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

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

Returns a String representation of the element.

Specified by:

toXMLString in interface AuthnContext

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.