01 /*
02 * Copyright 2005 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25 /*
26 * $Id: Manifest.java,v 1.7 2005/05/10 16:03:46 mullan Exp $
27 */
28 package javax.xml.crypto.dsig;
29
30 import javax.xml.crypto.XMLStructure;
31 import java.util.List;
32
33 /**
34 * A representation of the XML <code>Manifest</code> element as defined in
35 * the <a href="http://www.w3.org/TR/xmldsig-core/">
36 * W3C Recommendation for XML-Signature Syntax and Processing</a>.
37 * The XML Schema Definition is defined as:
38 * <pre><code>
39 * <element name="Manifest" type="ds:ManifestType"/>
40 * <complexType name="ManifestType">
41 * <sequence>
42 * <element ref="ds:Reference" maxOccurs="unbounded"/>
43 * </sequence>
44 * <attribute name="Id" type="ID" use="optional"/>
45 * </complexType>
46 * </code></pre>
47 *
48 * A <code>Manifest</code> instance may be created by invoking
49 * one of the {@link XMLSignatureFactory#newManifest newManifest}
50 * methods of the {@link XMLSignatureFactory} class; for example:
51 *
52 * <pre>
53 * XMLSignatureFactory factory = XMLSignatureFactory.getInstance("DOM");
54 * List references = Collections.singletonList(factory.newReference
55 * ("#reference-1", DigestMethod.SHA1));
56 * Manifest manifest = factory.newManifest(references, "manifest-1");
57 * </pre>
58 *
59 * @author Sean Mullan
60 * @author JSR 105 Expert Group
61 * @since 1.6
62 * @see XMLSignatureFactory#newManifest(List)
63 * @see XMLSignatureFactory#newManifest(List, String)
64 */
65 public interface Manifest extends XMLStructure {
66
67 /**
68 * URI that identifies the <code>Manifest</code> element (this can be
69 * specified as the value of the <code>type</code> parameter of the
70 * {@link Reference} class to identify the referent's type).
71 */
72 final static String TYPE = "http://www.w3.org/2000/09/xmldsig#Manifest";
73
74 /**
75 * Returns the Id of this <code>Manifest</code>.
76 *
77 * @return the Id of this <code>Manifest</code> (or <code>null</code>
78 * if not specified)
79 */
80 String getId();
81
82 /**
83 * Returns an {@link java.util.Collections#unmodifiableList unmodifiable
84 * list} of one or more {@link Reference}s that are contained in this
85 * <code>Manifest</code>.
86 *
87 * @return an unmodifiable list of one or more <code>Reference</code>s
88 */
89 List getReferences();
90 }
|