javax.xml.crypto.dsig.keyinfo.KeyName Maven / Gradle / Ivy
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/*
* Copyright 2005 Sun Microsystems, Inc. All rights reserved.
*/
/*
* $Id: KeyName.java 1092655 2011-04-15 10:24:18Z coheigea $
*/
package javax.xml.crypto.dsig.keyinfo;
import javax.xml.crypto.XMLStructure;
/**
* A representation of the XML KeyName element as
* defined in the
* W3C Recommendation for XML-Signature Syntax and Processing.
* A KeyName 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:
*
*
* <element name="KeyName" type="string"/>
*
*
* A KeyName instance may be created by invoking the
* {@link KeyInfoFactory#newKeyName newKeyName} method of the
* {@link KeyInfoFactory} class, and passing it a String
* representing the name of the key; for example:
*
* KeyInfoFactory factory = KeyInfoFactory.getInstance("DOM");
* KeyName keyName = factory.newKeyName("Alice");
*
*
* @author Sean Mullan
* @author JSR 105 Expert Group
* @see KeyInfoFactory#newKeyName(String)
*/
public interface KeyName extends XMLStructure {
/**
* Returns the name of this KeyName.
*
* @return the name of this KeyName (never
* null)
*/
String getName();
}