javax.xml.crypto.dsig.SignedInfo Maven / Gradle / Ivy
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/*
* Copyright 2005 Sun Microsystems, Inc. All rights reserved.
*/
/*
* $Id: SignedInfo.java 1092655 2011-04-15 10:24:18Z coheigea $
*/
package javax.xml.crypto.dsig;
import javax.xml.crypto.XMLStructure;
import java.io.InputStream;
import java.util.List;
/**
* An representation of the XML SignedInfo element as
* defined in the
* W3C Recommendation for XML-Signature Syntax and Processing.
* The XML Schema Definition is defined as:
*
* <element name="SignedInfo" type="ds:SignedInfoType"/>
* <complexType name="SignedInfoType">
* <sequence>
* <element ref="ds:CanonicalizationMethod"/>
* <element ref="ds:SignatureMethod"/>
* <element ref="ds:Reference" maxOccurs="unbounded"/>
* </sequence>
* <attribute name="Id" type="ID" use="optional"/>
* </complexType>
*
*
* A SignedInfo instance may be created by invoking one of the
* {@link XMLSignatureFactory#newSignedInfo newSignedInfo} methods of the
* {@link XMLSignatureFactory} class.
*
* @author Sean Mullan
* @author JSR 105 Expert Group
* @see XMLSignatureFactory#newSignedInfo(CanonicalizationMethod, SignatureMethod, List)
* @see XMLSignatureFactory#newSignedInfo(CanonicalizationMethod, SignatureMethod, List, String)
*/
public interface SignedInfo extends XMLStructure {
/**
* Returns the canonicalization method of this SignedInfo.
*
* @return the canonicalization method
*/
CanonicalizationMethod getCanonicalizationMethod();
/**
* Returns the signature method of this SignedInfo.
*
* @return the signature method
*/
SignatureMethod getSignatureMethod();
/**
* Returns an {@link java.util.Collections#unmodifiableList
* unmodifiable list} of one or more {@link Reference}s.
*
* @return an unmodifiable list of one or more {@link Reference}s
*/
List getReferences();
/**
* Returns the optional Id attribute of this
* SignedInfo.
*
* @return the id (may be null if not specified)
*/
String getId();
/**
* Returns the canonicalized signed info bytes after a signing or
* validation operation. This method is useful for debugging.
*
* @return an InputStream containing the canonicalized bytes,
* or null if this SignedInfo has not been
* signed or validated yet
*/
InputStream getCanonicalizedData();
}