com.sun.identity.saml2.protocol.impl

Class RequestedAuthnContextImpl

java.lang.Object

com.sun.identity.saml2.protocol.impl.RequestedAuthnContextImpl

All Implemented Interfaces:

RequestedAuthnContext

public class RequestedAuthnContextImpl
extends Object
implements RequestedAuthnContext

Java content class for RequestedAuthnContextType complex type.

The following schema fragment specifies the expected content contained within this java content object.

 <complexType name="RequestedAuthnContextType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <choice>
         <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}AuthnContextClassRef" maxOccurs="unbounded"/>
         <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}AuthnContextDeclRef" maxOccurs="unbounded"/>
       </choice>
       <attribute name="Comparison" type="{urn:oasis:names:tc:SAML:2.0:protocol}AuthnContextComparisonType" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
String	elementName

Constructor Summary

Constructors

Constructor and Description
RequestedAuthnContextImpl() Constructor
RequestedAuthnContextImpl(Element element) Constructor
RequestedAuthnContextImpl(String xmlString) Constructor

Method Summary

Modifier and Type	Method and Description
List	getAuthnContextClassRef() Returns the value of AuthnContextClassRef property.
List	getAuthnContextDeclRef() Returns List of String representing authentication context declaration reference.
String	getComparison() Returns the value of comparison property.
boolean	isMutable() Returns true if the object is mutable
void	makeImmutable() Makes the obejct immutable
void	setAuthnContextClassRef(List value) Sets the value of AuthnContextClassRef property.
void	setAuthnContextDeclRef(List value) Sets the value of the AuthnContextDeclRef property.
void	setComparison(String value) Sets the value of the comparison property.
String	toXMLString() Returns an XML Representation of this object.
String	toXMLString(boolean includeNSPrefix, boolean declareNS) Converts into an XML String.

Methods inherited from class java.lang.Object

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

Field Detail

elementName

public final String elementName

See Also:

Constant Field Values

Constructor Detail

RequestedAuthnContextImpl

public RequestedAuthnContextImpl()

Constructor

RequestedAuthnContextImpl

public RequestedAuthnContextImpl(Element element)
                          throws SAML2Exception

Constructor

Parameters:

element - the Document Element.

Throws:

SAML2Exception - if there is an error creating this object.

RequestedAuthnContextImpl

public RequestedAuthnContextImpl(String xmlString)
                          throws SAML2Exception

Constructor

Parameters:

xmlString - the RequestedAuthnContext XML String.

Throws:

SAML2Exception - if there is an error creating this object.

Method Detail

getAuthnContextClassRef

public List getAuthnContextClassRef()

Returns the value of AuthnContextClassRef property.

Specified by:

getAuthnContextClassRef in interface RequestedAuthnContext

Returns:

List of String representing authentication context class reference.

See Also:

setAuthnContextClassRef(List)

setAuthnContextClassRef

public void setAuthnContextClassRef(List value)
                             throws SAML2Exception

Sets the value of AuthnContextClassRef property.

Specified by:

setAuthnContextClassRef in interface RequestedAuthnContext

Parameters:

value - List of String representing authentication context class referance.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getAuthnContextClassRef()

getAuthnContextDeclRef

public List getAuthnContextDeclRef()

Returns List of String representing authentication context declaration reference.

Specified by:

getAuthnContextDeclRef in interface RequestedAuthnContext

Returns:

List of String representing authentication context declaration reference.

See Also:

setAuthnContextDeclRef(List)

setAuthnContextDeclRef

public void setAuthnContextDeclRef(List value)
                            throws SAML2Exception

Sets the value of the AuthnContextDeclRef property.

Specified by:

setAuthnContextDeclRef in interface RequestedAuthnContext

Parameters:

value - List of String representing authentication context declaration referance.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getAuthnContextDeclRef()

getComparison

public String getComparison()

Returns the value of comparison property.

Specified by:

getComparison in interface RequestedAuthnContext

Returns:

An String representing comparison method.

See Also:

setComparison(String)

setComparison

public void setComparison(String value)
                   throws SAML2Exception

Sets the value of the comparison property.

Specified by:

setComparison in interface RequestedAuthnContext

Parameters:

value - An String representing comparison method.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getComparison()

toXMLString

public String toXMLString()
                   throws SAML2Exception

Returns an XML Representation of this object.

Specified by:

toXMLString in interface RequestedAuthnContext

Returns:

A string containing the valid XML for this element

Throws:

SAML2Exception - if unable to get the XML string.

toXMLString

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

Converts into an XML String.

Specified by:

toXMLString in interface RequestedAuthnContext

Parameters:

includeNSPrefix - 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 unable to get the XML string.

makeImmutable

public void makeImmutable()

Makes the obejct immutable

Specified by:

makeImmutable in interface RequestedAuthnContext

isMutable

public boolean isMutable()

Returns true if the object is mutable

Specified by:

isMutable in interface RequestedAuthnContext

Returns:

true if the object is mutable