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: SignedInfo.java,v 1.7 2005/05/10 16:03:47 mullan Exp $
027 */
028 package javax.xml.crypto.dsig;
029
030 import javax.xml.crypto.XMLStructure;
031 import java.io.InputStream;
032 import java.util.List;
033
034 /**
035 * An representation of the XML <code>SignedInfo</code> element as
036 * defined in the <a href="http://www.w3.org/TR/xmldsig-core/">
037 * W3C Recommendation for XML-Signature Syntax and Processing</a>.
038 * The XML Schema Definition is defined as:
039 * <pre><code>
040 * <element name="SignedInfo" type="ds:SignedInfoType"/>
041 * <complexType name="SignedInfoType">
042 * <sequence>
043 * <element ref="ds:CanonicalizationMethod"/>
044 * <element ref="ds:SignatureMethod"/>
045 * <element ref="ds:Reference" maxOccurs="unbounded"/>
046 * </sequence>
047 * <attribute name="Id" type="ID" use="optional"/>
048 * </complexType>
049 * </code></pre>
050 *
051 * A <code>SignedInfo</code> instance may be created by invoking one of the
052 * {@link XMLSignatureFactory#newSignedInfo newSignedInfo} methods of the
053 * {@link XMLSignatureFactory} class.
054 *
055 * @author Sean Mullan
056 * @author JSR 105 Expert Group
057 * @since 1.6
058 * @see XMLSignatureFactory#newSignedInfo(CanonicalizationMethod, SignatureMethod, List)
059 * @see XMLSignatureFactory#newSignedInfo(CanonicalizationMethod, SignatureMethod, List, String)
060 */
061 public interface SignedInfo extends XMLStructure {
062
063 /**
064 * Returns the canonicalization method of this <code>SignedInfo</code>.
065 *
066 * @return the canonicalization method
067 */
068 CanonicalizationMethod getCanonicalizationMethod();
069
070 /**
071 * Returns the signature method of this <code>SignedInfo</code>.
072 *
073 * @return the signature method
074 */
075 SignatureMethod getSignatureMethod();
076
077 /**
078 * Returns an {@link java.util.Collections#unmodifiableList
079 * unmodifiable list} of one or more {@link Reference}s.
080 *
081 * @return an unmodifiable list of one or more {@link Reference}s
082 */
083 List getReferences();
084
085 /**
086 * Returns the optional <code>Id</code> attribute of this
087 * <code>SignedInfo</code>.
088 *
089 * @return the id (may be <code>null</code> if not specified)
090 */
091 String getId();
092
093 /**
094 * Returns the canonicalized signed info bytes after a signing or
095 * validation operation. This method is useful for debugging.
096 *
097 * @return an <code>InputStream</code> containing the canonicalized bytes,
098 * or <code>null</code> if this <code>SignedInfo</code> has not been
099 * signed or validated yet
100 */
101 InputStream getCanonicalizedData();
102 }
|