Source Code Cross Referenced for CanonicalizationMethod.java in  » 6.0-JDK-Core » xml » javax » xml » crypto » dsig » Java Source Code / Java DocumentationJava Source Code and Java Documentation

001        /*
002         * Copyright 2005 Sun Microsystems, Inc.  All Rights Reserved.
003         * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004         *
005         * This code is free software; you can redistribute it and/or modify it
006         * under the terms of the GNU General Public License version 2 only, as
007         * published by the Free Software Foundation.  Sun designates this
008         * particular file as subject to the "Classpath" exception as provided
009         * by Sun in the LICENSE file that accompanied this code.
010         *
011         * This code is distributed in the hope that it will be useful, but WITHOUT
012         * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013         * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
014         * version 2 for more details (a copy is included in the LICENSE file that
015         * accompanied this code).
016         *
017         * You should have received a copy of the GNU General Public License version
018         * 2 along with this work; if not, write to the Free Software Foundation,
019         * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020         *
021         * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022         * CA 95054 USA or visit www.sun.com if you need additional information or
023         * have any questions.
024         */
025        /*
026         * $Id: CanonicalizationMethod.java,v 1.6 2005/05/10 16:03:45 mullan Exp $
027         */
028        package javax.xml.crypto.dsig;
029
030        import java.security.spec.AlgorithmParameterSpec;
031        import javax.xml.crypto.dsig.spec.C14NMethodParameterSpec;
032
033        /**
034         * A representation of the XML <code>CanonicalizationMethod</code> 
035         * element as defined in the 
036         * <a href="http://www.w3.org/TR/xmldsig-core/">
037         * W3C Recommendation for XML-Signature Syntax and Processing</a>. The XML 
038         * Schema Definition is defined as:
039         * <p>
040         * <pre>
041         *   &lt;element name="CanonicalizationMethod" type="ds:CanonicalizationMethodType"/&gt;
042         *     &lt;complexType name="CanonicalizationMethodType" mixed="true"&gt;
043         *       &lt;sequence&gt;
044         *         &lt;any namespace="##any" minOccurs="0" maxOccurs="unbounded"/&gt;
045         *           &lt;!-- (0,unbounded) elements from (1,1) namespace --&gt;
046         *       &lt;/sequence&gt;
047         *       &lt;attribute name="Algorithm" type="anyURI" use="required"/&gt;
048         *     &lt;/complexType&gt;
049         * </pre>
050         *
051         * A <code>CanonicalizationMethod</code> instance may be created by invoking 
052         * the {@link XMLSignatureFactory#newCanonicalizationMethod 
053         * newCanonicalizationMethod} method of the {@link XMLSignatureFactory} class.
054         *
055         * @author Sean Mullan
056         * @author JSR 105 Expert Group
057         * @since 1.6
058         * @see XMLSignatureFactory#newCanonicalizationMethod(String, C14NMethodParameterSpec)
059         */
060        public interface CanonicalizationMethod extends Transform {
061
062            /**
063             * The <a href="http://www.w3.org/TR/2001/REC-xml-c14n-20010315">Canonical 
064             * XML (without comments)</a> canonicalization method algorithm URI.
065             */
066            final static String INCLUSIVE = "http://www.w3.org/TR/2001/REC-xml-c14n-20010315";
067
068            /**
069             * The 
070             * <a href="http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments">
071             * Canonical XML with comments</a> canonicalization method algorithm URI.
072             */
073            final static String INCLUSIVE_WITH_COMMENTS = "http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments";
074
075            /**
076             * The <a href="http://www.w3.org/2001/10/xml-exc-c14n#">Exclusive 
077             * Canonical XML (without comments)</a> canonicalization method algorithm
078             * URI.
079             */
080            final static String EXCLUSIVE = "http://www.w3.org/2001/10/xml-exc-c14n#";
081
082            /**
083             * The <a href="http://www.w3.org/2001/10/xml-exc-c14n#WithComments">
084             * Exclusive Canonical XML with comments</a> canonicalization method 
085             * algorithm URI.
086             */
087            final static String EXCLUSIVE_WITH_COMMENTS = "http://www.w3.org/2001/10/xml-exc-c14n#WithComments";
088
089            /**
090             * Returns the algorithm-specific input parameters associated with this 
091             * <code>CanonicalizationMethod</code>.
092             *
093             * <p>The returned parameters can be typecast to a 
094             * {@link C14NMethodParameterSpec} object.
095             *
096             * @return the algorithm-specific input parameters (may be 
097             *    <code>null</code> if not specified)
098             */
099            AlgorithmParameterSpec getParameterSpec();
100        }