oracle.security.xmlsec.dsig

Class ObjectReference

java.lang.Object

oracle.security.xmlsec.util.XMLNode

oracle.security.xmlsec.util.XMLElement

oracle.security.xmlsec.dsig.ObjectReference

Direct Known Subclasses:

RetrievalMethod, XECipherReference, XEReference, XSReference

public abstract class ObjectReference
extends XMLElement

Base class for elements that serve as references. I.e., elements consisting of a URI identifying the referenced object, along with any transformation and type information needed to process it.

The base XML schema for such elements is:

        <complexType>
                <sequence>
                        <element ref="Transforms" minOccurs="0"/>
                </sequence>
                <attribute name="URI" type="anyURI" use="optional"/>
        </complexType>
        

The Transforms element is defined in the application's namespace, and is a sequence of dsig:Transform elements.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ObjectReference.CIDResolver

Field Summary

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

node, systemId

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ObjectReference(org.w3c.dom.Document owner, java.lang.String tagName) Creates a new ObjectReference instance.
protected	ObjectReference(org.w3c.dom.Document owner, java.lang.String tagName, java.lang.String uri) Creates a new ObjectReference instance.
protected	ObjectReference(org.w3c.dom.Document owner, java.lang.String nsURI, java.lang.String tagName, java.lang.String uri) Creates a new ObjectReference instance.
protected	ObjectReference(org.w3c.dom.Element element) Creates a new ObjectReference instance from the given Element node.
protected	ObjectReference(org.w3c.dom.Element element, java.lang.String systemId) Creates a new ObjectReference instance from the given Element node.

Method Summary

Modifier and Type	Method and Description
void	addTransform(XSAlgorithmIdentifier trans) Adds a Transform algorithm to the list of Transforms to be applied to the referenced object.
protected java.lang.Object	dereference() Internal use only.
static XMLContainer	dereference(java.lang.String uri, org.w3c.dom.Document doc, org.w3c.dom.Element refElem, java.lang.String systemId) Internal use only.
java.util.Vector	getTransforms() Returns a list of the XML transforms to be applied to the referenced data object.
java.lang.String	getURI() Returns the value of the URI attribute identifying the referenced object.
static void	setCIDResolver(ObjectReference.CIDResolver cidResolver)
void	setURI(java.lang.String uri) Sets the URI attribute identifying the referenced object.

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

ObjectReference

protected ObjectReference(org.w3c.dom.Element element)
                   throws org.w3c.dom.DOMException

Creates a new ObjectReference instance from the given Element node.

Parameters:

element - An Element node in the XML document.

Throws:

org.w3c.dom.DOMException

ObjectReference

protected ObjectReference(org.w3c.dom.Element element,
                          java.lang.String systemId)
                   throws org.w3c.dom.DOMException

Creates a new ObjectReference instance from the given Element node.

Parameters:

element - An Element node in the XML document.

systemId - The URI string system ID for this element.

Throws:

org.w3c.dom.DOMException

Since:

2.0

See Also:

XMLNode.setSystemId(java.lang.String)

ObjectReference

protected ObjectReference(org.w3c.dom.Document owner,
                          java.lang.String tagName)
                   throws org.w3c.dom.DOMException

Creates a new ObjectReference instance.

Parameters:

owner - The owner document of the new ObjectReference.

tagName - The name of the element to be created; for example, "Reference" if this ObjectReference is to be a XML-DSIG Reference element. The element is created in the XML-DSIG namespace.

Throws:

org.w3c.dom.DOMException

ObjectReference

protected ObjectReference(org.w3c.dom.Document owner,
                          java.lang.String tagName,
                          java.lang.String uri)
                   throws org.w3c.dom.DOMException

Creates a new ObjectReference instance.

Parameters:

owner - The owner document of the new ObjectReference.

tagName - The name of the element to be created; for example, "Reference" if this ObjectReference is to be a XML-DSIG Reference element. The element is created in the XML-DSIG namespace.

uri - A URI identifying the object being referenced.

Throws:

org.w3c.dom.DOMException

ObjectReference

protected ObjectReference(org.w3c.dom.Document owner,
                          java.lang.String nsURI,
                          java.lang.String tagName,
                          java.lang.String uri)
                   throws org.w3c.dom.DOMException

Creates a new ObjectReference instance.

Parameters:

owner - The owner document of the new ObjectReference.

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

tagName - The name of the element to be created; for example, "Reference" if this ObjectReference is to be a XML-DSIG Reference element.

uri - A URI identifying the object being referenced.

Throws:

org.w3c.dom.DOMException

Method Detail

dereference

public static XMLContainer dereference(java.lang.String uri,
                                       org.w3c.dom.Document doc,
                                       org.w3c.dom.Element refElem,
                                       java.lang.String systemId)
                                throws ReferenceException

Internal use only.

Retrieves the referenced data object, but do not run transforms

Returns:

An instance of oracle.security.crypto.util.XMLContainer.

Throws:

ReferenceException - If an error occurs retrieving the referenced data object

dereference

protected java.lang.Object dereference()
                                throws ReferenceException

Internal use only. This method is for use by subclasses of ObjectReference only.

Retrieves the referenced data object, and applies any specified transforms.

Returns:

An instance of oracle.security.crypto.util.XMLContainer.

Throws:

ReferenceException - If an error occurs retrieving the referenced data object or applying the transforms.

Since:

2.0

setURI

public void setURI(java.lang.String uri)
            throws org.w3c.dom.DOMException

Sets the URI attribute identifying the referenced object.

Parameters:

uri - A URI identifying the referenced object.

Throws:

org.w3c.dom.DOMException

getURI

public java.lang.String getURI()

Returns the value of the URI attribute identifying the referenced object.

Returns:

A URI identifying the referenced object, or null if the attribute is missing.

addTransform

public void addTransform(XSAlgorithmIdentifier trans)
                  throws org.w3c.dom.DOMException

Adds a Transform algorithm to the list of Transforms to be applied to the referenced object.

Parameters:

trans - A XSAlgorithmIdentifier instance.

Throws:

org.w3c.dom.DOMException

getTransforms

public java.util.Vector getTransforms()

Returns a list of the XML transforms to be applied to the referenced data object.

Returns:

A Vector of XSAlgorithmIdentifiers.

setCIDResolver

public static void setCIDResolver(ObjectReference.CIDResolver cidResolver)