1/* 2 * Copyright (c) 2005, 2013, 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 */ 28package javax.xml.crypto.dsig; 29 30import java.security.spec.AlgorithmParameterSpec; 31import 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 * <pre> 40 * <element name="CanonicalizationMethod" type="ds:CanonicalizationMethodType"/> 41 * <complexType name="CanonicalizationMethodType" mixed="true"> 42 * <sequence> 43 * <any namespace="##any" minOccurs="0" maxOccurs="unbounded"/> 44 * <!-- (0,unbounded) elements from (1,1) namespace --> 45 * </sequence> 46 * <attribute name="Algorithm" type="anyURI" use="required"/> 47 * </complexType> 48 * </pre> 49 * 50 * A <code>CanonicalizationMethod</code> instance may be created by invoking 51 * the {@link XMLSignatureFactory#newCanonicalizationMethod 52 * newCanonicalizationMethod} method of the {@link XMLSignatureFactory} class. 53 * 54 * @author Sean Mullan 55 * @author JSR 105 Expert Group 56 * @since 1.6 57 * @see XMLSignatureFactory#newCanonicalizationMethod(String, C14NMethodParameterSpec) 58 */ 59public interface CanonicalizationMethod extends Transform { 60 61 /** 62 * The <a href="http://www.w3.org/TR/2001/REC-xml-c14n-20010315">Canonical 63 * XML (without comments)</a> canonicalization method algorithm URI. 64 */ 65 final static String INCLUSIVE = 66 "http://www.w3.org/TR/2001/REC-xml-c14n-20010315"; 67 68 /** 69 * The 70 * <a href="http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments"> 71 * Canonical XML with comments</a> canonicalization method algorithm URI. 72 */ 73 final static String INCLUSIVE_WITH_COMMENTS = 74 "http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments"; 75 76 /** 77 * The <a href="http://www.w3.org/2001/10/xml-exc-c14n#">Exclusive 78 * Canonical XML (without comments)</a> canonicalization method algorithm 79 * URI. 80 */ 81 final static String EXCLUSIVE = 82 "http://www.w3.org/2001/10/xml-exc-c14n#"; 83 84 /** 85 * The <a href="http://www.w3.org/2001/10/xml-exc-c14n#WithComments"> 86 * Exclusive Canonical XML with comments</a> canonicalization method 87 * algorithm URI. 88 */ 89 final static String EXCLUSIVE_WITH_COMMENTS = 90 "http://www.w3.org/2001/10/xml-exc-c14n#WithComments"; 91 92 /** 93 * Returns the algorithm-specific input parameters associated with this 94 * <code>CanonicalizationMethod</code>. 95 * 96 * <p>The returned parameters can be typecast to a 97 * {@link C14NMethodParameterSpec} object. 98 * 99 * @return the algorithm-specific input parameters (may be 100 * <code>null</code> if not specified) 101 */ 102 AlgorithmParameterSpec getParameterSpec(); 103} 104