/*

 * Copyright (c) 2005, 2014, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

/*

 * $Id: SignatureProperty.java,v 1.4 2005/05/10 16:03:46 mullan Exp $

 */

package javax.xml.crypto.dsig;

import javax.xml.crypto.XMLStructure;

import java.util.List;

/**

 * A representation of the XML <code>SignatureProperty</code> element as

 * defined in the <a href="http://www.w3.org/TR/xmldsig-core/">

 * W3C Recommendation for XML-Signature Syntax and Processing</a>.

 * The XML Schema Definition is defined as:

 * <pre><code>

 *<element name="SignatureProperty" type="ds:SignaturePropertyType"/>

 *   <complexType name="SignaturePropertyType" mixed="true">

 *     <choice maxOccurs="unbounded">

 *       <any namespace="##other" processContents="lax"/>

 *       <!-- (1,1) elements from (1, unbounded) namespaces -->

 *     </choice>

 *     <attribute name="Target" type="anyURI" use="required"/>

 *     <attribute name="Id" type="ID" use="optional"/>

 *   </complexType>

 * </code></pre>

 *

 * A <code>SignatureProperty</code> instance may be created by invoking the

 * {@link XMLSignatureFactory#newSignatureProperty newSignatureProperty}

 * method of the {@link XMLSignatureFactory} class; for example:

 *

 * <pre>

 *   XMLSignatureFactory factory = XMLSignatureFactory.getInstance("DOM");

 *   SignatureProperty property = factory.newSignatureProperty

 *      (Collections.singletonList(content), "#Signature-1", "TimeStamp");

 * </pre>

 *

 * @author Sean Mullan

 * @author JSR 105 Expert Group

 * @since 1.6

 * @see XMLSignatureFactory#newSignatureProperty(List, String, String)

 * @see SignatureProperties

 */

public interface SignatureProperty extends XMLStructure {

    /**

     * Returns the target URI of this <code>SignatureProperty</code>.

     *

     * @return the target URI of this <code>SignatureProperty</code> (never

     *    <code>null</code>)

     */

    String getTarget();

    /**

     * Returns the Id of this <code>SignatureProperty</code>.

     *

     * @return the Id of this <code>SignatureProperty</code> (or

     *    <code>null</code> if not specified)

     */

    String getId();

    /**

     * Returns an {@link java.util.Collections#unmodifiableList unmodifiable

     * list} of one or more {@link XMLStructure}s that are contained in

     * this <code>SignatureProperty</code>. These represent additional

     * information items concerning the generation of the {@link XMLSignature}

     * (i.e. date/time stamp or serial numbers of cryptographic hardware used

     * in signature generation).

     *

     * @return an unmodifiable list of one or more <code>XMLStructure</code>s

     */

    List<XMLStructure> getContent();

}