Oracle Security Developer Tools XML Security Java API Reference
10g (10.1.4.0.1)

B28178-01


oracle.security.xmlsec.dsig
Class XSAlgorithmIdentifier

java.lang.Object
  extended byoracle.security.xmlsec.util.XMLNode
      extended byoracle.security.xmlsec.util.XMLElement
          extended byoracle.security.xmlsec.dsig.XSAlgorithmIdentifier

Direct Known Subclasses:
XEEncryptionMethod

public class XSAlgorithmIdentifier
extends XMLElement

Class representing a XML-DSIG algorithm identifier element.

Standard algorithm URI constants can be found in XMLURI, including:

See Also:
XSSignature.createAlgorithmIdentifier(java.lang.String, java.lang.String)

Field Summary

 

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

 

Constructor Summary
XSAlgorithmIdentifier(org.w3c.dom.Document owner, java.lang.String tagName)
          Creates a new XSAlgorithmIdentifier instance.
XSAlgorithmIdentifier(org.w3c.dom.Document owner, java.lang.String tagName, java.lang.String algorithm)
          Creates a new XSAlgorithmIdentifier instance.
XSAlgorithmIdentifier(org.w3c.dom.Element element)
          Creates a new XSAlgorithmIdentifier instance from the given Element node.
XSAlgorithmIdentifier(org.w3c.dom.Element element, java.lang.String systemId)
          Creates a new XSAlgorithmIdentifier instance from the given Element node.

 

Method Summary
 void addParameter(org.w3c.dom.Node param)
          Adds an explicit parameter element to this algorithm ID.
 void addParameter(java.lang.String nsURI, java.lang.String name, java.lang.String value)
          Adds an explicit parameter element to this algorithm ID, with the given tag name and text value.
 java.lang.String getAlgorithm()
          Returns the algorithm URI.
 org.w3c.dom.NodeList getParameters()
          Returns a list of the explicit parameter elements for this algorithm ID.
 void setAlgorithm(java.lang.String algorithm)
          Sets the Algorithm attribute for this algorithm ID.

 

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

XSAlgorithmIdentifier

public XSAlgorithmIdentifier(org.w3c.dom.Element element)
                      throws org.w3c.dom.DOMException
Creates a new XSAlgorithmIdentifier instance from the given Element node.
Parameters:
element - An Element node in the XML document that conforms to the XML-DSIG algorithm identifier schema.

XSAlgorithmIdentifier

public XSAlgorithmIdentifier(org.w3c.dom.Element element,
                             java.lang.String systemId)
                      throws org.w3c.dom.DOMException
Creates a new XSAlgorithmIdentifier instance from the given Element node.
Parameters:
element - An Element node in the XML document that conforms to the XML-DSIG algorithm identifier schema.
systemId - The URI string system ID for this element.
Since:
2.0
See Also:
XMLNode.setSystemId(java.lang.String)

XSAlgorithmIdentifier

public XSAlgorithmIdentifier(org.w3c.dom.Document owner,
                             java.lang.String tagName)
                      throws org.w3c.dom.DOMException
Creates a new XSAlgorithmIdentifier instance.
Parameters:
owner - The owner document of the new XSAlgorithmIdentifier
tagName - The name of the element to be created; for example, "DigestMethod" if this XSAlgorithmIdentifier identifies the digest algorithm in a Signature element.

XSAlgorithmIdentifier

public XSAlgorithmIdentifier(org.w3c.dom.Document owner,
                             java.lang.String tagName,
                             java.lang.String algorithm)
                      throws org.w3c.dom.DOMException
Creates a new XSAlgorithmIdentifier instance.
Parameters:
owner - The owner document of the new XSAlgorithmIdentifier
tagName - The name of the element to be created; for example, "DigestMethod" if this XSAlgorithmIdentifier identifies the digest algorithm in a Reference element.
algorithm - The URI value of the Algorithm attribute.

Method Detail

setAlgorithm

public void setAlgorithm(java.lang.String algorithm)
                  throws org.w3c.dom.DOMException
Sets the Algorithm attribute for this algorithm ID.
Parameters:
algorithm - The URI value of the Algorithm attribute.
Throws:
org.w3c.dom.DOMException

getAlgorithm

public java.lang.String getAlgorithm()
Returns the algorithm URI.
Returns:
The URI value of the Algorithm attribute, or null if the attribute is missing.

addParameter

public void addParameter(org.w3c.dom.Node param)
                  throws org.w3c.dom.DOMException
Adds an explicit parameter element to this algorithm ID.
Parameters:
param - An org.w3c.dom.Node.
Throws:
org.w3c.dom.DOMException

addParameter

public void addParameter(java.lang.String nsURI,
                         java.lang.String name,
                         java.lang.String value)
                  throws org.w3c.dom.DOMException
Adds an explicit parameter element to this algorithm ID, with the given tag name and text value.
Parameters:
nsURI - The URI of the namespace in which the parameter is to be created.
name - The tag name to be used for the new parameter element.
value - The text value for the new parameter element.
Throws:
org.w3c.dom.DOMException

getParameters

public org.w3c.dom.NodeList getParameters()
Returns a list of the explicit parameter elements for this algorithm ID.
Returns:
A NodeList containing any parameter elements in this XSAlgorithmIdentifier.

Oracle Security Developer Tools XML Security Java API Reference
10g (10.1.4.0.1)

B28178-01


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