oracle.security.xmlsec.saml2.core
Class BaseID

java.lang.Object
oracle.security.xmlsec.util.XMLNode
oracle.security.xmlsec.util.XMLElement
oracle.security.xmlsec.saml2.core.BaseID

All Implemented Interfaces:

SAML2NameIdentifier

public abstract class BaseID

extends oracle.security.xmlsec.util.XMLElement

implements SAML2NameIdentifier

Represents a descriptive identifier for subjects and issuers of SAML assertions and protocol messages. This abstract class identifies a subject by a combination of a name qualifier and a SP name qualifier.

Field Summary

Fields inherited from class oracle.security.xmlsec.util.XMLNode

node, systemId

Constructor Summary

	BaseID(org.w3c.dom.Document owner) Creates a new BaseID instance.
protected	BaseID(org.w3c.dom.Document owner, java.lang.String nsURI, java.lang.String localName) Creates a new BaseID instance.
	BaseID(org.w3c.dom.Element element) Creates a new BaseID instance from the given Element node.
	BaseID(org.w3c.dom.Element element, java.lang.String systemId) Creates a new BaseID instance from the given Element node.

Method Summary

java.lang.String	getNameQualifier() Gets the name qualifier attribute.
java.lang.String	getSPNameQualifier() Gets the name qualifier attribute.
abstract java.lang.Object	getValue() Gets the value of this BaseID element.
void	setNameQualifier(java.lang.String nameQualifier) Sets the name qualifier attribute of this BaseID element.
void	setSPNameQualifier(java.lang.String spNameQualifier) Sets the SP name qualifier attribute of this BaseID element.
abstract void	setValue(java.lang.Object value) Sets the value of this BaseID element.

Methods inherited from class oracle.security.xmlsec.util.XMLElement

addNSPrefixAttr, addNSPrefixAttr, addNSPrefixAttrDefault, addNSPrefixAttrDefault, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getChildElementsByTagName, getChildElementsByTagName, getChildElementsByTagNameNS, getChildElementsByTagNameNS, getDefaultNSPrefix, getElementsByTagName, getElementsByTagNameNS, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setDefaultNSPrefix

Methods inherited from class oracle.security.xmlsec.util.XMLNode

appendChild, appendChild, appendTo, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNode, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getSystemId, hasAttributes, hasChildNodes, insertBefore, insertBefore, isSupported, normalize, removeChild, removeChild, replaceChild, replaceChild, setNodeValue, setPrefix, setSystemId, toBytesXML, toStringXML

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.security.xmlsec.saml2.core.SAML2NameIdentifier

getIDName, getIDNamespaceURI, getNode

Constructor Detail

BaseID

public BaseID(org.w3c.dom.Element element)
       throws org.w3c.dom.DOMException

Creates a new BaseID instance from the given Element node.

Parameters:

element - A BaseID element.

Throws:

org.w3c.dom.DOMException

BaseID

public BaseID(org.w3c.dom.Element element,
              java.lang.String systemId)
       throws org.w3c.dom.DOMException

Creates a new BaseID instance from the given Element node.

Parameters:

element - A BaseID element.

systemId - The system Id for the BaseID element.

Throws:

org.w3c.dom.DOMException

BaseID

public BaseID(org.w3c.dom.Document owner)
       throws org.w3c.dom.DOMException

Creates a new BaseID instance.

Parameters:

owner - The owner document of the new BaseID.

Throws:

org.w3c.dom.DOMException

BaseID

protected BaseID(org.w3c.dom.Document owner,
                 java.lang.String nsURI,
                 java.lang.String localName)
          throws org.w3c.dom.DOMException

Creates a new BaseID instance. This is for use in any sub-class for extension of the BaseID element.

Parameters:

owner - The owner document of the new BaseID.

nsURI - The namespace URI in which the new BaseID is to be created.

localName - The localName of the element represented by the class that extends this class.

Throws:

org.w3c.dom.DOMException

Method Detail

setNameQualifier

public void setNameQualifier(java.lang.String nameQualifier)

Sets the name qualifier attribute of this BaseID element.

Parameters:

nameQualifier - A String value that determines the security or administrative domain of the subject.

getNameQualifier

public java.lang.String getNameQualifier()

Gets the name qualifier attribute.

Returns:

A String object representing the security or administrative domain of the subject or null if none has been set.

setSPNameQualifier

public void setSPNameQualifier(java.lang.String spNameQualifier)

Sets the SP name qualifier attribute of this BaseID element.

Parameters:

spNameQualifier - A String value that determines the name of the service provider or affiliations of service providers of the subject.

getSPNameQualifier

public java.lang.String getSPNameQualifier()

Gets the name qualifier attribute.

Returns:

A String object representing the name of the service provider or affiliations of service providers of the subject or null if none has been set.

setValue

public abstract void setValue(java.lang.Object value)

Sets the value of this BaseID element.

Parameters:

value - An Object representing the element of type BaseID.

getValue

public abstract java.lang.Object getValue()

Gets the value of this BaseID element.

Returns:

An Object representing the value of the element of type BaseID.