01 /*
02 * Copyright 2005 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25 /*
26 * $Id: XMLValidateContext.java,v 1.8 2005/05/10 16:03:49 mullan Exp $
27 */
28 package javax.xml.crypto.dsig;
29
30 import javax.xml.crypto.XMLCryptoContext;
31
32 /**
33 * Contains context information for validating XML Signatures. This interface
34 * is primarily intended for type-safety.
35 *
36 * <p>Note that <code>XMLValidateContext</code> instances can contain
37 * information and state specific to the XML signature structure it is
38 * used with. The results are unpredictable if an
39 * <code>XMLValidateContext</code> is used with different signature structures
40 * (for example, you should not use the same <code>XMLValidateContext</code>
41 * instance to validate two different {@link XMLSignature} objects).
42 * <p>
43 * <b><a name="Supported Properties"></a>Supported Properties</b>
44 * <p>The following properties can be set by an application using the
45 * {@link #setProperty setProperty} method.
46 * <ul>
47 * <li><code>javax.xml.crypto.dsig.cacheReference</code>: value must be a
48 * {@link Boolean}. This property controls whether or not the
49 * {@link Reference#validate Reference.validate} method will cache the
50 * dereferenced content and pre-digested input for subsequent retrieval via
51 * the {@link Reference#getDereferencedData Reference.getDereferencedData}
52 * and {@link Reference#getDigestInputStream
53 * Reference.getDigestInputStream} methods. The default value if not
54 * specified is <code>Boolean.FALSE</code>.
55 * </ul>
56 *
57 * @author Sean Mullan
58 * @author JSR 105 Expert Group
59 * @since 1.6
60 * @see XMLSignature#validate(XMLValidateContext)
61 * @see Reference#validate(XMLValidateContext)
62 */
63 public interface XMLValidateContext extends XMLCryptoContext {
64 }
|