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 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

Constructors

Constructor and Description
Attribute(org.w3c.dom.Document owner) 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

Modifier and Type	Method and Description
protected org.w3c.dom.Element	addAttributeValue(org.w3c.dom.Node[] content, QName type) Adds an AttributeValue element to this Attribute.
protected org.w3c.dom.Element	addAttributeValue(org.w3c.dom.Node content, QName type) Adds an AttributeValue element to this Attribute.
void	addAttributeValue(java.lang.String value) Adds a new AttributeValue element to this Attribute.
void	addAttributeValues(java.lang.String[] values) Adds a new AttributeValue element for each string in the given array.
abstract java.lang.String	getAttributeProfileID() Returns the Profile Identification URI.
java.util.List	getAttributeValues() Returns the list of this Attribute's AttributeValues.
protected java.lang.String[]	getAttributeValuesAsStrings(QName type) Returns the contents of this Attribute's AttributeValues that have the given xsi:type as strings.
protected java.lang.String[]	getAttributeValuesAsStrings(QName type, boolean includeNull) Returns the contents of this Attribute's AttributeValues that have the given xsi:types as strings.
java.lang.String[]	getAttributeValueStrings() Returns the contents of this Attribute's AttributeValues that have xsi:type="xs:string".
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 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, 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, 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

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.

Throws:

org.w3c.dom.DOMException

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.

Throws:

org.w3c.dom.DOMException

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.

Throws:

org.w3c.dom.DOMException

Method Detail

addAttributeValue

protected org.w3c.dom.Element addAttributeValue(org.w3c.dom.Node content,
                                                QName type)

Adds an AttributeValue element to this Attribute.

Parameters:

content - The content of the new AttributeValue element, to be appended as a child node.

type - The XML schema type for the AttributeValue, to be set in an xsi:type attribute.

Returns:

The AttributeValue element that was created.

Since:

11.1.1.0.0

addAttributeValue

protected org.w3c.dom.Element addAttributeValue(org.w3c.dom.Node[] content,
                                                QName type)

Adds an AttributeValue element to this Attribute.

Parameters:

content - The content of the new AttributeValue element, to be appended as child nodes.

type - The XML schema type for the AttributeValue, to be set in an xsi:type attribute.

Returns:

The AttributeValue element that was created.

getAttributeValuesAsStrings

protected java.lang.String[] getAttributeValuesAsStrings(QName type)

Returns the contents of this Attribute's AttributeValues that have the given xsi:type as strings. An individual value will contain only the collected Text child nodes of the AttributeValue, so the given xsi:type should reference simple primitive/built-in types only.

Parameters:

type - The xsi:type of the AttributeValue elements to return. If type is null, the string value of all AttributeValues will be returned.

Returns:

An array of Strings, or null if no AttribtueValues of the given xsi:type are present.

getAttributeValuesAsStrings

protected java.lang.String[] getAttributeValuesAsStrings(QName type,
                                                         boolean includeNull)

Returns the contents of this Attribute's AttributeValues that have the given xsi:types as strings. An individual value will contain only the collected Text child nodes of the AttributeValue, so the given xsi:type should reference simple primitive/built-in types only.

Parameters:

types - The xsi:types of the AttributeValue elements to return. If type is null, the string value of all AttributeValues will be returned.

includeNull - If true, the string values of AttributeValue elements with no xsi:type attribute defined will be included in the result.

Returns:

An array of Strings, or null if no AttribtueValues of the given xsi:type are present.

setXsiType

protected static void setXsiType(org.w3c.dom.Element element,
                                 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 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.

addAttributeValue

public void addAttributeValue(java.lang.String value)

Adds a new AttributeValue element to this Attribute. The new element will have the attribute xsi:type="xs:string" and, if the given string value is null, it will also have the attribute xsi:nil="true".

Parameters:

value - The string content of the new AttributeValue element.

Since:

11.1.1.0.0

addAttributeValues

public void addAttributeValues(java.lang.String[] values)

Adds a new AttributeValue element for each string in the given array. Each AttributeValue element will have the attribute xsi:type="xs:string" and, if a given value is null, it will also have the attribute xsi:nil="true".

Parameters:

values - The individual contents of the new AttributeValue elements.

Since:

11.1.1.0.0

getAttributeValues

public java.util.List getAttributeValues()

Returns the list of this Attribute's AttributeValues.

Returns:

A List of AttributeValue elements, or null if this Attribute has none.

Since:

11.1.1.0.0

getAttributeValueStrings

public java.lang.String[] getAttributeValueStrings()

Returns the contents of this Attribute's AttributeValues that have xsi:type="xs:string".

Returns:

An array of Strings, or null if no AttributeValues of xsi:type="xs:string" are present.

Since:

11.1.1.0.0

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.