/*
* Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/*
* $Id: RetrievalMethod.java,v 1.8 2005/05/10 16:35:35 mullan Exp $
*/
package javax.xml.crypto.dsig.keyinfo;
import javax.xml.crypto.Data;
import javax.xml.crypto.URIReference;
import javax.xml.crypto.URIReferenceException;
import javax.xml.crypto.XMLCryptoContext;
import javax.xml.crypto.XMLStructure;
import javax.xml.crypto.dsig.Transform;
import java.util.List;
/**
* A representation of the XML RetrievalMethod
element as
* defined in the
* W3C Recommendation for XML-Signature Syntax and Processing.
* A RetrievalMethod
object is used to convey a reference to
* KeyInfo
information that is stored at another location.
* The XML schema definition is defined as:
*
*
* <element name="RetrievalMethod" type="ds:RetrievalMethodType"/> * <complexType name="RetrievalMethodType"> * <sequence> * <element name="Transforms" type="ds:TransformsType" minOccurs="0"/> * </sequence> * <attribute name="URI" type="anyURI"/> * <attribute name="Type" type="anyURI" use="optional"/> * </complexType> ** * A
RetrievalMethod
instance may be created by invoking one of the
* {@link KeyInfoFactory#newRetrievalMethod newRetrievalMethod} methods
* of the {@link KeyInfoFactory} class, and passing it the URI
* identifying the location of the KeyInfo, an optional type URI identifying
* the type of KeyInfo, and an optional list of {@link Transform}s; for example:
* * KeyInfoFactory factory = KeyInfoFactory.getInstance("DOM"); * RetrievalMethod rm = factory.newRetrievalMethod * ("#KeyValue-1", KeyValue.DSA_TYPE, Collections.singletonList(Transform.BASE64)); ** * @author Sean Mullan * @author JSR 105 Expert Group * @since 1.6 * @see KeyInfoFactory#newRetrievalMethod(String) * @see KeyInfoFactory#newRetrievalMethod(String, String, List) */ public interface RetrievalMethod extends URIReference, XMLStructure { /** * Returns an {@link java.util.Collections#unmodifiableList unmodifiable * list} of {@link Transform}s of this
RetrievalMethod
.
*
* @return an unmodifiable list of Transform
objects (may be
* empty but never null
).
*/
List getTransforms();
/**
* Returns the URI of the referenced KeyInfo
information.
*
* @return the URI of the referenced KeyInfo
information in
* RFC 2396 format (never null
)
*/
String getURI();
/**
* Dereferences the KeyInfo
information referenced by this
* RetrievalMethod
and applies the specified
* Transform
s.
*
* @param context an XMLCryptoContext
that may contain
* additional useful information for dereferencing the URI. The
* context's baseURI
and dereferencer
* parameters (if specified) are used to resolve and dereference this
* RetrievalMethod
* @return a Data
object representing the raw contents of the
* KeyInfo
information referenced by this
* RetrievalMethod
. It is the caller's responsibility to
* convert the returned data to an appropriate
* KeyInfo
object.
* @throws NullPointerException if context
is null
* @throws URIReferenceException if there is an error while dereferencing
*/
Data dereference(XMLCryptoContext context) throws URIReferenceException;
}