javax.xml.crypto.URIDereferencer Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of xmlsec Show documentation

Apache XML Security for Java supports XML-Signature Syntax and Processing, W3C Recommendation 12 February 2002, and XML Encryption Syntax and Processing, W3C Recommendation 10 December 2002. As of version 1.4, the library supports the standard Java API JSR-105: XML Digital Signature APIs.

There is a newer version: 4.0.2

Show 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.
 */
/*
 * Portions copyright 2005 Sun Microsystems, Inc. All rights reserved.
 */
/*
 * =========================================================================== 
 *
 * (C) Copyright IBM Corp. 2003 All Rights Reserved.
 *
 * ===========================================================================
 */
/*
 * $Id: URIDereferencer.java 1092655 2011-04-15 10:24:18Z coheigea $
 */
package javax.xml.crypto;

/**
 * A dereferencer of {@link URIReference}s.
 * 
 * The result of dereferencing a URIReference is either an 
 * instance of {@link OctetStreamData} or {@link NodeSetData}. Unless the
 * URIReference is a same-document reference as defined
 * in section 4.2 of the W3C Recommendation for XML-Signature Syntax and 
 * Processing, the result of dereferencing the URIReference
 * MUST be an OctetStreamData.
 *
 * @author Sean Mullan
 * @author Joyce Leung
 * @author JSR 105 Expert Group
 * @see XMLCryptoContext#setURIDereferencer(URIDereferencer)
 * @see XMLCryptoContext#getURIDereferencer
 */
public interface URIDereferencer {

    /**
     * Dereferences the specified URIReference and returns the 
     * dereferenced data.
     *
     * @param uriReference the URIReference
     * @param context an XMLCryptoContext that may 
     *    contain additional useful information for dereferencing the URI. This 
     *    implementation should dereference the specified 
     *    URIReference against the context's baseURI 
     *    parameter, if specified.
     * @return the dereferenced data 
     * @throws NullPointerException if uriReference or 
     *    context are null
     * @throws URIReferenceException if an exception occurs while 
     *    dereferencing the specified uriReference
     */
    Data dereference(URIReference uriReference, XMLCryptoContext context) 
        throws URIReferenceException;
}