src/java.xml.crypto/share/classes/javax/xml/crypto/dsig/XMLSignContext.java
changeset 47216 71c04702a3d5
parent 44999 b1c62cd70983
equal deleted inserted replaced
47215:4ebc2e2fb97c 47216:71c04702a3d5
       
     1 /*
       
     2  * Copyright (c) 2005, 2017, 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  * $Id: XMLSignContext.java,v 1.8 2005/05/10 16:03:48 mullan Exp $
       
    27  */
       
    28 package javax.xml.crypto.dsig;
       
    29 
       
    30 import javax.xml.crypto.KeySelector;
       
    31 import javax.xml.crypto.XMLCryptoContext;
       
    32 
       
    33 /**
       
    34  * Contains context information for generating XML Signatures. This interface
       
    35  * is primarily intended for type-safety.
       
    36  *
       
    37  * <p>Note that <code>XMLSignContext</code> instances can contain
       
    38  * information and state specific to the XML signature structure it is
       
    39  * used with. The results are unpredictable if an
       
    40  * <code>XMLSignContext</code> is used with different signature structures
       
    41  * (for example, you should not use the same <code>XMLSignContext</code>
       
    42  * instance to sign two different {@link XMLSignature} objects).
       
    43  * <p>
       
    44  * <b><a id="SupportedProperties"></a>Supported Properties</b>
       
    45  * <p>The following properties can be set using the
       
    46  * {@link #setProperty setProperty} method.
       
    47  * <ul>
       
    48  *   <li><code>javax.xml.crypto.dsig.cacheReference</code>: value must be a
       
    49  *      {@link Boolean}. This property controls whether or not the digested
       
    50  *      {@link Reference} objects will cache the dereferenced content and
       
    51  *      pre-digested input for subsequent retrieval via the
       
    52  *      {@link Reference#getDereferencedData Reference.getDereferencedData} and
       
    53  *      {@link Reference#getDigestInputStream Reference.getDigestInputStream}
       
    54  *      methods. The default value if not specified is
       
    55  *      <code>Boolean.FALSE</code>.
       
    56  * </ul>
       
    57  *
       
    58  * @author Sean Mullan
       
    59  * @author JSR 105 Expert Group
       
    60  * @since 1.6
       
    61  * @see XMLSignature#sign(XMLSignContext)
       
    62  */
       
    63 public interface XMLSignContext extends XMLCryptoContext {}