/*

 * Copyright (c) 2005, 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: KeyName.java,v 1.4 2005/05/10 16:35:35 mullan Exp $

 */

package javax.xml.crypto.dsig.keyinfo;

import javax.xml.crypto.XMLStructure;

/**

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

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

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

 * A <code>KeyName</code> object contains a string value which may be used

 * by the signer to communicate a key identifier to the recipient. The

 * XML Schema Definition is defined as:

 *

 * <pre>

 * <element name="KeyName" type="string"/>

 * </pre>

 *

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

 * {@link KeyInfoFactory#newKeyName newKeyName} method of the

 * {@link KeyInfoFactory} class, and passing it a <code>String</code>

 * representing the name of the key; for example:

 * <pre>

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

 * KeyName keyName = factory.newKeyName("Alice");

 * </pre>

 *

 * @author Sean Mullan

 * @author JSR 105 Expert Group

 * @since 1.6

 * @see KeyInfoFactory#newKeyName(String)

 */

public interface KeyName extends XMLStructure {

    /**

     * Returns the name of this <code>KeyName</code>.

     *

     * @return the name of this <code>KeyName</code> (never

     *    <code>null</code>)

     */

    String getName();

}