/*

 * reserved comment block

 * DO NOT REMOVE OR ALTER!

 */

 *

 *

 */

package com.sun.org.apache.xml.internal.security.c14n;

import java.io.ByteArrayInputStream;

import java.io.OutputStream;

import java.util.Map;

import java.util.Set;

import javax.xml.parsers.DocumentBuilder;

import javax.xml.parsers.DocumentBuilderFactory;

import com.sun.org.apache.xml.internal.security.exceptions.AlgorithmAlreadyRegisteredException;

import org.w3c.dom.Document;

import org.w3c.dom.Node;

import org.w3c.dom.NodeList;

import org.xml.sax.InputSource;

/**

 *

 * @author Christian Geuer-Pollmann

 */

public class Canonicalizer {

    /** The output encoding of canonicalized data */

    public static final String ENCODING = "UTF8";

    /**

     * in only one node

     */

    public static final String XPATH_C14N_WITH_COMMENTS_SINGLE_NODE =

        "(.//. | .//@* | .//namespace::*)";

    /**

     * The URL defined in XML-SEC Rec for inclusive c14n <b>without</b> comments.

     */

    public static final String ALGO_ID_C14N_OMIT_COMMENTS =

        "http://www.w3.org/TR/2001/REC-xml-c14n-20010315";

    /**

     * The URL defined in XML-SEC Rec for inclusive c14n <b>with</b> comments.

     */

    public static final String ALGO_ID_C14N_WITH_COMMENTS =

        ALGO_ID_C14N_OMIT_COMMENTS + "#WithComments";

    /**

     * The URL defined in XML-SEC Rec for exclusive c14n <b>without</b> comments.

     */

    public static final String ALGO_ID_C14N_EXCL_OMIT_COMMENTS =

        "http://www.w3.org/2001/10/xml-exc-c14n#";

    /**

     * The URL defined in XML-SEC Rec for exclusive c14n <b>with</b> comments.

     */

    public static final String ALGO_ID_C14N_EXCL_WITH_COMMENTS =

        ALGO_ID_C14N_EXCL_OMIT_COMMENTS + "WithComments";

    /**

     * The URI for inclusive c14n 1.1 <b>without</b> comments.

     */

    public static final String ALGO_ID_C14N11_OMIT_COMMENTS =

        "http://www.w3.org/2006/12/xml-c14n11";

    /**

     * The URI for inclusive c14n 1.1 <b>with</b> comments.

     */

    public static final String ALGO_ID_C14N11_WITH_COMMENTS =

        ALGO_ID_C14N11_OMIT_COMMENTS + "#WithComments";

    /**

     * Constructor Canonicalizer

     *

     * @param algorithmURI

     * @throws InvalidCanonicalizerException

     */

        try {

            Class<? extends CanonicalizerSpi> implementingClass =

        } catch (Exception e) {

            Object exArgs[] = { algorithmURI };

            throw new InvalidCanonicalizerException(

        }

    }

    /**

     * Method getInstance

     *

     * @param algorithmURI

     * @throws InvalidCanonicalizerException

     */

    public static final Canonicalizer getInstance(String algorithmURI)

    }

    /**

     * Method register

     *

     * @param algorithmURI

     * @param implementingClass

     * @throws AlgorithmAlreadyRegisteredException

     */

    @SuppressWarnings("unchecked")

    public static void register(String algorithmURI, String implementingClass)

        // check whether URI is already registered

        if (registeredClass != null)  {

            Object exArgs[] = { algorithmURI, registeredClass };

        }

    }

    /**

     * Method getURI

     *

     * @return the URI defined for this c14n instance.

     */

    public final String getURI() {

    }

    /**

     * Method getIncludeComments

     *

     * @return true if the c14n respect the comments.

     */

    public boolean getIncludeComments() {

    }

    /**

     * This method tries to canonicalize the given bytes. It's possible to even

     * canonicalize non-wellformed sequences if they are well-formed after being

     * wrapped with a <CODE>&gt;a&lt;...&gt;/a&lt;</CODE>.

     *

     * @param inputBytes

     * @throws CanonicalizationException

     * @throws java.io.IOException

     * @throws javax.xml.parsers.ParserConfigurationException

     * @throws org.xml.sax.SAXException

     */

    public byte[] canonicalize(byte[] inputBytes)

        InputSource in = new InputSource(bais);

        DocumentBuilderFactory dfactory = DocumentBuilderFactory.newInstance();

        dfactory.setNamespaceAware(true);

        dfactory.setValidating(true);

        DocumentBuilder db = dfactory.newDocumentBuilder();

        /*

         * for some of the test vectors from the specification,

         * attribute values, NMTOKENS, etc.

         * even no DTD. So Xerces 1.3.1 fires many warnings about using

         * ErrorHandlers.

         *

         * Text from the spec:

         *

         * The input octet stream MUST contain a well-formed XML document,

         * but the input need not be validated. However, the attribute

         * value normalization and entity reference resolution MUST be

         * performed in accordance with the behaviors of a validating

         * XML processor. As well, nodes for default attributes (declared

         * in the ATTLIST with an AttValue but not specified) are created

         * in each element. Thus, the declarations in the document type

         * declaration are used to help create the canonical form, even

         * though the document type declaration is not retained in the

         * canonical form.

         */

        Document document = db.parse(in);

    }

    /**

     * Canonicalizes the subtree rooted by <CODE>node</CODE>.

     *

     * @return the result of the c14n.

     *

     * @throws CanonicalizationException

     */

    }

    /**

     * Canonicalizes the subtree rooted by <CODE>node</CODE>.

     *

     * @param node

     * @param inclusiveNamespaces

     * @return the result of the c14n.

     * @throws CanonicalizationException

     */

    public byte[] canonicalizeSubtree(Node node, String inclusiveNamespaces)

    }

    /**

     * Canonicalizes an XPath node set. The <CODE>xpathNodeSet</CODE> is treated

     * as a list of XPath nodes, not as a list of subtrees.

     *

     * @param xpathNodeSet

     * @return the result of the c14n.

     * @throws CanonicalizationException

     */

    public byte[] canonicalizeXPathNodeSet(NodeList xpathNodeSet)

    }

    /**

     * Canonicalizes an XPath node set. The <CODE>xpathNodeSet</CODE> is treated

     * as a list of XPath nodes, not as a list of subtrees.

     *

     * @param xpathNodeSet

     * @param inclusiveNamespaces

     * @return the result of the c14n.

     * @throws CanonicalizationException

     */

    public byte[] canonicalizeXPathNodeSet(

    }

    /**

     * Canonicalizes an XPath node set.

     *

     * @param xpathNodeSet

     * @return the result of the c14n.

     * @throws CanonicalizationException

     */

    public byte[] canonicalizeXPathNodeSet(Set<Node> xpathNodeSet)

    }

    /**

     * Canonicalizes an XPath node set.

     *

     * @param xpathNodeSet

     * @param inclusiveNamespaces

     * @return the result of the c14n.

     * @throws CanonicalizationException

     */

    }

    /**

     * Sets the writer where the canonicalization ends.  ByteArrayOutputStream

     * if none is set.

     * @param os

     */

    public void setWriter(OutputStream os) {

    }

    /**

     * Returns the name of the implementing {@link CanonicalizerSpi} class

     *

     * @return the name of the implementing {@link CanonicalizerSpi} class

     */

    public String getImplementingCanonicalizerClass() {

    }

    /**

     * Set the canonicalizer behaviour to not reset.

     */

    public void notReset() {

    }

}