Skip navigation links

Oracle Fusion Middleware SAML 2.0 Java API Reference for Oracle Security Developer Tools
11g Release 1 (11.1.1)

E10676-05


oracle.security.xmlsec.saml2.core
Class NameID

java.lang.Object
  extended by oracle.security.xmlsec.util.XMLNode
      extended by oracle.security.xmlsec.util.XMLElement
          extended by oracle.security.xmlsec.saml2.core.NameID

All Implemented Interfaces:
SAML2NameIdentifier
Direct Known Subclasses:
Issuer

public class NameID
extends oracle.security.xmlsec.util.XMLElement
implements SAML2NameIdentifier

Represents subject identification by a combination of a name qualifier, a name and a format. It is used to identify entities using a string valued name.


Field Summary

 

Fields inherited from class oracle.security.xmlsec.util.XMLNode
node, systemId

 

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

 

Method Summary
 java.lang.String getFormat()
          Gets the format attribute.
 java.lang.String getIDName()
          Returns the name of the identifier element.
 java.lang.String getIDNamespaceURI()
          Returns the namespace of the identifier element.
 java.lang.String getNameQualifier()
          Gets the name qualifier attribute.
 java.lang.String getSPNameQualifier()
          Gets the name qualifier attribute.
 java.lang.String getSPProvidedID()
          Gets the SP provided id attribute.
 java.lang.String getValue()
          Gets the value of this NameID element.
 void setFormat(java.lang.String uri)
          Sets the format attribute of this NameID object.
 void setNameQualifier(java.lang.String nameQualifier)
          Sets the name qualifier attribute of this NameID element.
 void setSPNameQualifier(java.lang.String spNameQualifier)
          Sets the SP name qualifier attribute of this NameID element.
 void setSPProvidedID(java.lang.String id)
          Sets the SP provided id attribute of this NameID element.
 void setValue(java.lang.String value)
          Sets the value of this NameID element.

 

Methods inherited from class oracle.security.xmlsec.util.XMLElement
addNSPrefixAttr, addNSPrefixAttr, addNSPrefixAttrDefault, addNSPrefixAttrDefault, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getChildElementsByTagName, getChildElementsByTagName, getChildElementsByTagNameNS, getChildElementsByTagNameNS, getDefaultNSPrefix, getElement, 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
getNode

 

Constructor Detail

NameID

public NameID(org.w3c.dom.Element element)
       throws org.w3c.dom.DOMException
Creates a new NameID instance from the given Element node.
Parameters:
element - A NameID element.
Throws:
org.w3c.dom.DOMException

NameID

public NameID(org.w3c.dom.Element element,
              java.lang.String systemId)
       throws org.w3c.dom.DOMException
Creates a new NameID instance from the given Element node.
Parameters:
element - A NameID element.
systemId - The URI string system ID for the NameID.
Throws:
org.w3c.dom.DOMException

NameID

public NameID(org.w3c.dom.Document owner)
       throws org.w3c.dom.DOMException
Creates a new NameID instance.
Parameters:
owner - The owner document of the new NameID.
Throws:
org.w3c.dom.DOMException

NameID

protected NameID(org.w3c.dom.Document owner,
                 java.lang.String nsURI,
                 java.lang.String localName)
          throws org.w3c.dom.DOMException
Creates a new NameID instance. This is for use in any sub-class for extension of the NameID element.
Parameters:
owner - The owner document of the new NameID.
nsURI - The namespace URI in which the new NameID 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 NameID 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 NameID 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.

setFormat

public void setFormat(java.lang.String uri)
Sets the format attribute of this NameID object.

Any of the formats defined in OASIS SAML 2.0 can be specified.

Parameters:
uri - A URI representing the syntax used to describe the name of the subject.

getFormat

public java.lang.String getFormat()
Gets the format attribute.
Returns:
A URI representing the syntax used to describe the name of the subject.

setSPProvidedID

public void setSPProvidedID(java.lang.String id)
Sets the SP provided id attribute of this NameID element.
Parameters:
id - A String value that determines the security or administrative domain of the subject.

getSPProvidedID

public java.lang.String getSPProvidedID()
Gets the SP provided id attribute.
Returns:
A String object representing the security or administrative domain of the subject or null if none has been set.

setValue

public void setValue(java.lang.String value)
Sets the value of this NameID element.
Parameters:
value - The String value representing any of the formats defined in OASIS SAML 2.0 can be specified.

getValue

public java.lang.String getValue()
Gets the value of this NameID element.
Returns:
A String object representing the value of this element.

getIDNamespaceURI

public java.lang.String getIDNamespaceURI()
Returns the namespace of the identifier element.
Specified by:
getIDNamespaceURI in interface SAML2NameIdentifier
Returns:
The namespace URI.

getIDName

public java.lang.String getIDName()
Returns the name of the identifier element.
Specified by:
getIDName in interface SAML2NameIdentifier
Returns:
A String value.

Skip navigation links

Oracle Fusion Middleware SAML 2.0 Java API Reference for Oracle Security Developer Tools
11g Release 1 (11.1.1)

E10676-05


Copyright © 2005, 2013 , Oracle. All rights reserved.