1/* 2 * Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26/* 27 * =========================================================================== 28 * 29 * (C) Copyright IBM Corp. 2003 All Rights Reserved. 30 * 31 * =========================================================================== 32 */ 33/* 34 * $Id: URIDereferencer.java,v 1.5 2005/05/10 15:47:42 mullan Exp $ 35 */ 36package javax.xml.crypto; 37 38/** 39 * A dereferencer of {@link URIReference}s. 40 * <p> 41 * The result of dereferencing a <code>URIReference</code> is either an 42 * instance of {@link OctetStreamData} or {@link NodeSetData}. Unless the 43 * <code>URIReference</code> is a <i>same-document reference</i> as defined 44 * in section 4.2 of the W3C Recommendation for XML-Signature Syntax and 45 * Processing, the result of dereferencing the <code>URIReference</code> 46 * MUST be an <code>OctetStreamData</code>. 47 * 48 * @author Sean Mullan 49 * @author Joyce Leung 50 * @author JSR 105 Expert Group 51 * @since 1.6 52 * @see XMLCryptoContext#setURIDereferencer(URIDereferencer) 53 * @see XMLCryptoContext#getURIDereferencer 54 */ 55public interface URIDereferencer { 56 57 /** 58 * Dereferences the specified <code>URIReference</code> and returns the 59 * dereferenced data. 60 * 61 * @param uriReference the <code>URIReference</code> 62 * @param context an <code>XMLCryptoContext</code> that may 63 * contain additional useful information for dereferencing the URI. This 64 * implementation should dereference the specified 65 * <code>URIReference</code> against the context's <code>baseURI</code> 66 * parameter, if specified. 67 * @return the dereferenced data 68 * @throws NullPointerException if <code>uriReference</code> or 69 * <code>context</code> are <code>null</code> 70 * @throws URIReferenceException if an exception occurs while 71 * dereferencing the specified <code>uriReference</code> 72 */ 73 Data dereference(URIReference uriReference, XMLCryptoContext context) 74 throws URIReferenceException; 75} 76