Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.3)

Part Number E41849-02

weblogic.xml.security.transforms
Class Transform

java.lang.Object
  extended by weblogic.xml.security.transforms.Transform
All Implemented Interfaces:
DSIGConstants

public abstract class Transform
extends Object
implements DSIGConstants

Represents a transformation to be applied to data before applying a cryptographic operation such as digesting. A Transform consists of an Algorithm attribute and a set of parameters, if any, appropriate for the given algorithm.


Field Summary
static String ENVELOPED
           
static String W3C_C14N
           
static String W3C_C14N_WC
           
static String W3C_EXC_C14N
           
static String W3C_EXC_C14N_WC
           
protected static XMLOutputStreamFactory xfactory
           
static String XPATH
           
 
Fields inherited from interface weblogic.xml.security.signature.DSIGConstants
ATTR_ALGORITHM, ATTR_ID, ATTR_PREFIX_LIST, ATTR_URI, ATTR_XMLNS, DSIG_PREFIX, DSIG_URI, EXC_C14N_DEFAULT_PREFIX, TAG_C14N_METHOD, TAG_DIGEST_METHOD, TAG_DIGEST_VALUE, TAG_DSA_G, TAG_DSA_KEY_VALUE, TAG_DSA_P, TAG_DSA_Q, TAG_DSA_Y, TAG_HMAC_OUTPUT_LENGTH, TAG_INCLUSIVE_NAMESPACES, TAG_KEY_INFO, TAG_KEY_NAME, TAG_KEY_VALUE, TAG_OBJECT, TAG_REFERENCE, TAG_RSA_EXPONENT, TAG_RSA_KEY_VALUE, TAG_RSA_MODULUS, TAG_SIGNATURE, TAG_SIGNATURE_METHOD, TAG_SIGNATURE_VALUE, TAG_SIGNED_INFO, TAG_TRANSFORM, TAG_TRANSFORMS, TAG_X509_CERTIFICATE, TAG_X509_DATA, TAG_X509_ISSUER_NAME, TAG_X509_ISSUER_SERIAL, TAG_X509_SERIAL_NUMBER, TAG_X509_SUBJECT_NAME, TAG_XPATH, TC_C14N_METHOD, TC_DIGEST_METHOD, TC_DSA_KEY_VALUE, TC_KEY_INFO, TC_KEY_VALUE, TC_REFERENCE, TC_RSA_KEY_VALUE, TC_SIGNATURE, TC_SIGNATURE_METHOD, TC_SIGNED_INFO, TC_TRANSFORMS, TC_X509_DATA, VERBOSE, VERBOSE_PROPERTY, VERBOSE_PROPERTY_ALT
 
Constructor Summary
Transform()
           
 
Method Summary
protected  void fromXMLInternal(XMLInputStream xin, String ns)
           
static Transform getTransform(String uri)
           
abstract  String getURI()
           
abstract  XMLOutputStream getXMLOutputStream()
           
static void main(String[] args)
           
 void setDest(Transform dest)
          Allows Transforms to be chained.
abstract  void setNamespaces(Map namespaceMap)
          setNamespaces allows the caller to pass in a set of namespaces in the scope of but not declared in the node/data being transformed.
 void setParameter(String name, String value)
          Sets a parameter for the Transform.
 void toXML(XMLOutputStream xos, String ns, int indent)
           
protected  void toXMLInternal(XMLOutputStream xos, String ns, int indent)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

xfactory

protected static final XMLOutputStreamFactory xfactory

XPATH

public static final String XPATH
See Also:
Constant Field Values

W3C_C14N

public static final String W3C_C14N
See Also:
Constant Field Values

W3C_C14N_WC

public static final String W3C_C14N_WC
See Also:
Constant Field Values

W3C_EXC_C14N

public static final String W3C_EXC_C14N
See Also:
Constant Field Values

W3C_EXC_C14N_WC

public static final String W3C_EXC_C14N_WC
See Also:
Constant Field Values

ENVELOPED

public static final String ENVELOPED
See Also:
Constant Field Values
Constructor Detail

Transform

public Transform()
Method Detail

getTransform

public static Transform getTransform(String uri)
                              throws TransformException
Returns:
A Transform that implements the specified URI
Throws:
TransformException

getURI

public abstract String getURI()
Returns:
The URI for the Transform

setParameter

public void setParameter(String name,
                         String value)
                  throws TransformException
Sets a parameter for the Transform. For example, this may be used to set the XPath expression for an XPath Transform

Throws:
TransformException

setNamespaces

public abstract void setNamespaces(Map namespaceMap)
setNamespaces allows the caller to pass in a set of namespaces in the scope of but not declared in the node/data being transformed. This allows the c14n algorith to fill in the missing pieces.

Parameters:
namespaceMap - a Map value

getXMLOutputStream

public abstract XMLOutputStream getXMLOutputStream()
                                            throws XMLStreamException
Throws:
XMLStreamException

setDest

public final void setDest(Transform dest)
                   throws IncompatibleTransformException
Allows Transforms to be chained.

Throws:
IncompatibleTransformException

toXML

public void toXML(XMLOutputStream xos,
                  String ns,
                  int indent)
           throws XMLStreamException
Throws:
XMLStreamException

toXMLInternal

protected void toXMLInternal(XMLOutputStream xos,
                             String ns,
                             int indent)
                      throws XMLStreamException
Throws:
XMLStreamException

fromXMLInternal

protected void fromXMLInternal(XMLInputStream xin,
                               String ns)
                        throws XMLStreamException
Throws:
XMLStreamException

main

public static void main(String[] args)
                 throws Exception
Throws:
Exception

Copyright 1996, 2014, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.3)

Part Number E41849-02