oracle.security.xmlsec.saml2.core
Class Attribute

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

Direct Known Subclasses:

BasicAttribute, DCEForeignGroupsAttribute, DCEGroupsAttribute, DCEPrimaryGroupAttribute, DCEPrincipalAttribute, DCERealmAttribute, GenericAttribute, UUIDAttribute, X500Attribute, XACMLAttribute

public abstract class Attribute

extends oracle.security.xmlsec.util.XMLElement

Represents an attribute by name and optionally its value(s).

Field Summary

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

node, systemId

Constructor Summary

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

Method Summary

protected abstract org.w3c.dom.Element	addAttributeValue(org.w3c.dom.Node[] node, oracle.security.xmlsec.util.QName type) Adds a value to the attribute.
abstract java.lang.String	getAttributeProfileID() Returns the Profile Identification URI.
abstract java.util.List	getAttributeValues() Gets the list of attribute values.
java.lang.String	getFriendlyName() Get the friendly name of the attribute.
java.lang.String	getName()
java.lang.String	getNameFormat() Get the attribute name format.
protected static oracle.security.xmlsec.util.QName	getXsiType(org.w3c.dom.Element element) Returns the XML Schema xsi:type attribute to identify the attribute value type.
void	setFriendlyName(java.lang.String fname) Set the friendly name of the attribute.
void	setName(java.lang.String name) Set the attribute name.
protected void	setNameFormat(java.lang.String formatURI) Set the attribute name format.
protected static void	setXsiType(org.w3c.dom.Element element, oracle.security.xmlsec.util.QName type) Set the XML Schema xsi:type attribute to identify the attribute value type.

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

Constructor Detail

Attribute

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

Creates a new Attribute instance from the given Element node.

Parameters:

element - An Attribute element.

Attribute

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

Creates a new Attribute instance from the given Element node.

Parameters:

element - An Attribute element.

systemId - The URI string system ID for the Attribute.

Attribute

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

Creates a new Attribute instance.

Parameters:

owner - The owner document of the new Attribute.

Attribute

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

Creates a new Attribute instance. This constructor is for use in subclass for extension of the Attribute element.

Parameters:

owner - The owner document of the new Attribute.

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

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

Method Detail

addAttributeValue

protected abstract org.w3c.dom.Element addAttributeValue(org.w3c.dom.Node[] node,
                                                         oracle.security.xmlsec.util.QName type)

Adds a value to the attribute.

Parameters:

node - The attribute value contentNodes.

type - The XML schema type specifying the attribute value type.

Returns:

The AttributeValue element that was created.

getAttributeValues

public abstract java.util.List getAttributeValues()

Gets the list of attribute values.

Returns:

A List containing Nodes, or an empty List if none has been added or nullif the attribute value does not contain any child nodes.

setXsiType

protected static void setXsiType(org.w3c.dom.Element element,
                                 oracle.security.xmlsec.util.QName type)

Set the XML Schema xsi:type attribute to identify the attribute value type.

Parameters:

element - The attribute value element to use as the context.

type - The QName reference.

getXsiType

protected static oracle.security.xmlsec.util.QName getXsiType(org.w3c.dom.Element element)

Returns the XML Schema xsi:type attribute to identify the attribute value type.

Parameters:

element - The attribute value element to use as the context.

Returns:

The QName value type or null if not specified.

setName

public void setName(java.lang.String name)

Set the attribute name.

Parameters:

name - The String containing the attribute name.

getName

public java.lang.String getName()

setNameFormat

protected void setNameFormat(java.lang.String formatURI)

Set the attribute name format.

Parameters:

formatURI - A URI reference to the attribute name format.

getNameFormat

public java.lang.String getNameFormat()

Get the attribute name format.

Returns:

A URI reference.

setFriendlyName

public void setFriendlyName(java.lang.String fname)

Set the friendly name of the attribute.

Parameters:

fname - The String containing the friendly name.

getFriendlyName

public java.lang.String getFriendlyName()

Get the friendly name of the attribute.

Returns:

The friendly name String.

getAttributeProfileID

public abstract java.lang.String getAttributeProfileID()

Returns the Profile Identification URI.

Returns:

The identification URI String.