KeyName


1   /*
2    * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
3    */
4   /*
5    * $Id: KeyName.java,v 1.4 2005/05/10 16:35:35 mullan Exp $
6    */
7   package javax.xml.crypto.dsig.keyinfo;
8   
9   import javax.xml.crypto.XMLStructure;
10  
11  /**
12   * A representation of the XML <code>KeyName</code> element as 
13   * defined in the <a HREF="http://www.w3.org/TR/xmldsig-core/">
14   * W3C Recommendation for XML-Signature Syntax and Processing</a>.
15   * A <code>KeyName</code> object contains a string value which may be used
16   * by the signer to communicate a key identifier to the recipient. The
17   * XML Schema Definition is defined as:
18   *
19   * <pre>
20   * &lt;element name="KeyName" type="string"/&gt;
21   * </pre>
22   * 
23   * A <code>KeyName</code> instance may be created by invoking the
24   * {@link KeyInfoFactory#newKeyName newKeyName} method of the
25   * {@link KeyInfoFactory} class, and passing it a <code>String</code> 
26   * representing the name of the key; for example:
27   * <pre>
28   * KeyInfoFactory factory = KeyInfoFactory.getInstance("DOM");
29   * KeyName keyName = factory.newKeyName("Alice");   
30   * </pre>
31   *
32   * @author Sean Mullan
33   * @author JSR 105 Expert Group
34   * @since 1.6
35   * @see KeyInfoFactory#newKeyName(String)
36   */
37  public interface KeyName extends XMLStructure {
38  
39      /**
40       * Returns the name of this <code>KeyName</code>.
41       *
42       * @return the name of this <code>KeyName</code> (never 
43       *    <code>null</code>)
44       */
45      String   getName();
46  }
47

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags