Package com.sun.identity.saml2.assertion.impl

Class BaseIDImpl

java.lang.Object

com.sun.identity.saml2.assertion.impl.BaseIDAbstractImpl

com.sun.identity.saml2.assertion.impl.BaseIDImpl

All Implemented Interfaces:

BaseID, BaseIDAbstract

public class BaseIDImpl
extends BaseIDAbstractImpl
implements BaseID

The BaseID is an extension point that allows applications to add new kinds of identifiers.

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASE_ID_ELEMENT
static String	NAME_QUALIFIER_ATTR
static String	SP_NAME_QUALIFIER_ATTR

Constructor Summary

Constructors

Constructor	Description
BaseIDImpl()	Default constructor
BaseIDImpl(String xml)	This constructor is used to build BaseID object from a XML string.
BaseIDImpl(Element element)	This constructor is used to build BaseID object from a block of existing XML that has already been built into a DOM.

Method Summary

Modifier and Type	Method	Description
String	toXMLString()	Returns a String representation
String	toXMLString(boolean includeNSPrefix, boolean declareNS)	Returns a String representation

Methods inherited from class com.sun.identity.saml2.assertion.impl.BaseIDAbstractImpl

getNameQualifier, getSPNameQualifier, isMutable, makeImmutable, setNameQualifier, setSPNameQualifier

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sun.identity.saml2.assertion.BaseIDAbstract

getNameQualifier, getSPNameQualifier, isMutable, makeImmutable, setNameQualifier, setSPNameQualifier

Field Detail

BASE_ID_ELEMENT

public static final String BASE_ID_ELEMENT

See Also:

Constant Field Values

NAME_QUALIFIER_ATTR

public static final String NAME_QUALIFIER_ATTR

See Also:

Constant Field Values

SP_NAME_QUALIFIER_ATTR

public static final String SP_NAME_QUALIFIER_ATTR

See Also:

Constant Field Values

Constructor Detail

BaseIDImpl

public BaseIDImpl()

Default constructor

BaseIDImpl

public BaseIDImpl(String xml)
           throws SAML2Exception

This constructor is used to build BaseID object from a XML string.

Parameters:

xml - A java.lang.String representing a BaseID object

Throws:

SAML2Exception - if it could not process the XML string

BaseIDImpl

public BaseIDImpl(Element element)
           throws SAML2Exception

This constructor is used to build BaseID object from a block of existing XML that has already been built into a DOM.

Parameters:

element - A org.w3c.dom.Element representing DOM tree for BaseID object

Throws:

SAML2Exception - if it could not process the Element

Method Detail

toXMLString

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

Returns a String representation

Specified by:

toXMLString in interface BaseID

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 representation

Throws:

SAML2Exception - if something is wrong during conversion

toXMLString

public String toXMLString()
                   throws SAML2Exception

Returns a String representation

Specified by:

toXMLString in interface BaseID

Returns:

A String representation

Throws:

SAML2Exception - if something is wrong during conversion