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: SignatureProperty.java,v 1.4 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>SignatureProperty</code> element as
35 * defined in 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="SignatureProperty" type="ds:SignaturePropertyType"/>
40 * <complexType name="SignaturePropertyType" mixed="true">
41 * <choice maxOccurs="unbounded">
42 * <any namespace="##other" processContents="lax"/>
43 * <!-- (1,1) elements from (1, unbounded) namespaces -->
44 * </choice>
45 * <attribute name="Target" type="anyURI" use="required"/>
46 * <attribute name="Id" type="ID" use="optional"/>
47 * </complexType>
48 * </code></pre>
49 *
50 * A <code>SignatureProperty</code> instance may be created by invoking the
51 * {@link XMLSignatureFactory#newSignatureProperty newSignatureProperty}
52 * method of the {@link XMLSignatureFactory} class; for example:
53 *
54 * <pre>
55 * XMLSignatureFactory factory = XMLSignatureFactory.getInstance("DOM");
56 * SignatureProperty property = factory.newSignatureProperty
57 * (Collections.singletonList(content), "#Signature-1", "TimeStamp");
58 * </pre>
59 *
60 * @author Sean Mullan
61 * @author JSR 105 Expert Group
62 * @since 1.6
63 * @see XMLSignatureFactory#newSignatureProperty(List, String, String)
64 * @see SignatureProperties
65 */
66 public interface SignatureProperty extends XMLStructure {
67
68 /**
69 * Returns the target URI of this <code>SignatureProperty</code>.
70 *
71 * @return the target URI of this <code>SignatureProperty</code> (never
72 * <code>null</code>)
73 */
74 String getTarget();
75
76 /**
77 * Returns the Id of this <code>SignatureProperty</code>.
78 *
79 * @return the Id of this <code>SignatureProperty</code> (or
80 * <code>null</code> if not specified)
81 */
82 String getId();
83
84 /**
85 * Returns an {@link java.util.Collections#unmodifiableList unmodifiable
86 * list} of one or more {@link XMLStructure}s that are contained in
87 * this <code>SignatureProperty</code>. These represent additional
88 * information items concerning the generation of the {@link XMLSignature}
89 * (i.e. date/time stamp or serial numbers of cryptographic hardware used
90 * in signature generation).
91 *
92 * @return an unmodifiable list of one or more <code>XMLStructure</code>s
93 */
94 List getContent();
95 }
|