javax.xml.crypto.dsig.keyinfo.RetrievalMethod Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.apache.servicemix.bundles.xmlsec
This OSGi bundle wraps ${pkgArtifactId} ${pkgVersion} jar file.
The newest version!
/**
 * 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: RetrievalMethod.java 1092655 2011-04-15 10:24:18Z coheigea $
 */
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
 * @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 
    * Transforms.
    *
    * @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;
}