Showing the changes to java/pkg/javax/xml/crypto/dsig/CanonicalizationMethod.java (1 of 18352 files). Show all
Unified · Split
| @@ -0,0 +1,104 @@ | ||
| 1 | +/* | |
| 2 | + * Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved. | |
| 3 | + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. | |
| 4 | + * | |
| 5 | + * This code is free software; you can redistribute it and/or modify it | |
| 6 | + * under the terms of the GNU General Public License version 2 only, as | |
| 7 | + * published by the Free Software Foundation. Oracle designates this | |
| 8 | + * particular file as subject to the "Classpath" exception as provided | |
| 9 | + * by Oracle in the LICENSE file that accompanied this code. | |
| 10 | + * | |
| 11 | + * This code is distributed in the hope that it will be useful, but WITHOUT | |
| 12 | + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 13 | + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 14 | + * version 2 for more details (a copy is included in the LICENSE file that | |
| 15 | + * accompanied this code). | |
| 16 | + * | |
| 17 | + * You should have received a copy of the GNU General Public License version | |
| 18 | + * 2 along with this work; if not, write to the Free Software Foundation, | |
| 19 | + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. | |
| 20 | + * | |
| 21 | + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA | |
| 22 | + * or visit www.oracle.com if you need additional information or have any | |
| 23 | + * questions. | |
| 24 | + */ | |
| 25 | +/* | |
| 26 | + * $Id: CanonicalizationMethod.java,v 1.6 2005/05/10 16:03:45 mullan Exp $ | |
| 27 | + */ | |
| 28 | +package javax.xml.crypto.dsig; | |
| 29 | + | |
| 30 | +import java.security.spec.AlgorithmParameterSpec; | |
| 31 | +import javax.xml.crypto.dsig.spec.C14NMethodParameterSpec; | |
| 32 | + | |
| 33 | +/** | |
| 34 | + * A representation of the XML <code>CanonicalizationMethod</code> | |
| 35 | + * element as defined in the | |
| 36 | + * <a href="http://www.w3.org/TR/xmldsig-core/"> | |
| 37 | + * W3C Recommendation for XML-Signature Syntax and Processing</a>. The XML | |
| 38 | + * Schema Definition is defined as: | |
| 39 | + * <p> | |
| 40 | + * <pre> | |
| 41 | + * <element name="CanonicalizationMethod" type="ds:CanonicalizationMethodType"/> | |
| 42 | + * <complexType name="CanonicalizationMethodType" mixed="true"> | |
| 43 | + * <sequence> | |
| 44 | + * <any namespace="##any" minOccurs="0" maxOccurs="unbounded"/> | |
| 45 | + * <!-- (0,unbounded) elements from (1,1) namespace --> | |
| 46 | + * </sequence> | |
| 47 | + * <attribute name="Algorithm" type="anyURI" use="required"/> | |
| 48 | + * </complexType> | |
| 49 | + * </pre> | |
| 50 | + * | |
| 51 | + * A <code>CanonicalizationMethod</code> instance may be created by invoking | |
| 52 | + * the {@link XMLSignatureFactory#newCanonicalizationMethod | |
| 53 | + * newCanonicalizationMethod} method of the {@link XMLSignatureFactory} class. | |
| 54 | + * | |
| 55 | + * @author Sean Mullan | |
| 56 | + * @author JSR 105 Expert Group | |
| 57 | + * @since 1.6 | |
| 58 | + * @see XMLSignatureFactory#newCanonicalizationMethod(String, C14NMethodParameterSpec) | |
| 59 | + */ | |
| 60 | +public interface CanonicalizationMethod extends Transform { | |
| 61 | + | |
| 62 | + /** | |
| 63 | + * The <a href="http://www.w3.org/TR/2001/REC-xml-c14n-20010315">Canonical | |
| 64 | + * XML (without comments)</a> canonicalization method algorithm URI. | |
| 65 | + */ | |
| 66 | + final static String INCLUSIVE = | |
| 67 | + "http://www.w3.org/TR/2001/REC-xml-c14n-20010315"; | |
| 68 | + | |
| 69 | + /** | |
| 70 | + * The | |
| 71 | + * <a href="http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments"> | |
| 72 | + * Canonical XML with comments</a> canonicalization method algorithm URI. | |
| 73 | + */ | |
| 74 | + final static String INCLUSIVE_WITH_COMMENTS = | |
| 75 | + "http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments"; | |
| 76 | + | |
| 77 | + /** | |
| 78 | + * The <a href="http://www.w3.org/2001/10/xml-exc-c14n#">Exclusive | |
| 79 | + * Canonical XML (without comments)</a> canonicalization method algorithm | |
| 80 | + * URI. | |
| 81 | + */ | |
| 82 | + final static String EXCLUSIVE = | |
| 83 | + "http://www.w3.org/2001/10/xml-exc-c14n#"; | |
| 84 | + | |
| 85 | + /** | |
| 86 | + * The <a href="http://www.w3.org/2001/10/xml-exc-c14n#WithComments"> | |
| 87 | + * Exclusive Canonical XML with comments</a> canonicalization method | |
| 88 | + * algorithm URI. | |
| 89 | + */ | |
| 90 | + final static String EXCLUSIVE_WITH_COMMENTS = | |
| 91 | + "http://www.w3.org/2001/10/xml-exc-c14n#WithComments"; | |
| 92 | + | |
| 93 | + /** | |
| 94 | + * Returns the algorithm-specific input parameters associated with this | |
| 95 | + * <code>CanonicalizationMethod</code>. | |
| 96 | + * | |
| 97 | + * <p>The returned parameters can be typecast to a | |
| 98 | + * {@link C14NMethodParameterSpec} object. | |
| 99 | + * | |
| 100 | + * @return the algorithm-specific input parameters (may be | |
| 101 | + * <code>null</code> if not specified) | |
| 102 | + */ | |
| 103 | + AlgorithmParameterSpec getParameterSpec(); | |
| 104 | +} | |