javax.xml.crypto.dsig.keyinfo.PGPData Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of xmlsec Show documentation

Apache XML Security for Java supports XML-Signature Syntax and Processing, W3C Recommendation 12 February 2002, and XML Encryption Syntax and Processing, W3C Recommendation 10 December 2002. As of version 1.4, the library supports the standard Java API JSR-105: XML Digital Signature APIs.

There is a newer version: 4.0.2

Show newest version

/**
 * 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: PGPData.java 1333869 2012-05-04 10:42:44Z coheigea $
 */
package javax.xml.crypto.dsig.keyinfo;

import java.util.Collections;
import java.util.List;
import javax.xml.crypto.XMLStructure;

/**
 * A representation of the XML PGPData element as defined in 
 * the 
 * W3C Recommendation for XML-Signature Syntax and Processing. A
 * PGPData object is used to convey information related to 
 * PGP public key pairs and signatures on such keys. The XML Schema Definition 
 * is defined as:
 * 
 *  *    <element name="PGPData" type="ds:PGPDataType"/> 
 *    <complexType name="PGPDataType"> 
 *      <choice>
 *        <sequence>
 *          <element name="PGPKeyID" type="base64Binary"/> 
 *          <element name="PGPKeyPacket" type="base64Binary" minOccurs="0"/> 
 *          <any namespace="##other" processContents="lax" minOccurs="0"
 *           maxOccurs="unbounded"/>
 *        </sequence>
 *        <sequence>
 *          <element name="PGPKeyPacket" type="base64Binary"/> 
 *          <any namespace="##other" processContents="lax" minOccurs="0"
 *           maxOccurs="unbounded"/>
 *        </sequence>
 *      </choice>
 *    </complexType>
 * 
 *
 * A PGPData instance may be created by invoking one of the
 * {@link KeyInfoFactory#newPGPData newPGPData} methods of the {@link
 * KeyInfoFactory} class, and passing it 
 * byte arrays representing the contents of the PGP public key 
 * identifier and/or PGP key material packet, and an optional list of
 * elements from an external namespace.
 *
 * @author Sean Mullan
 * @author JSR 105 Expert Group
 * @see KeyInfoFactory#newPGPData(byte[])
 * @see KeyInfoFactory#newPGPData(byte[], byte[], List)
 * @see KeyInfoFactory#newPGPData(byte[], List)
 */
public interface PGPData extends XMLStructure {

    /**
     * URI identifying the PGPData KeyInfo type:
     * http://www.w3.org/2000/09/xmldsig#PGPData. This can be specified as the 
     * value of the type parameter of the {@link RetrievalMethod} 
     * class to describe a remote PGPData structure.
     */
    String TYPE = "http://www.w3.org/2000/09/xmldsig#PGPData";

    /**
     * Returns the PGP public key identifier of this PGPData as 
     * defined in RFC 2440, 
     * section 11.2.
     *
     * @return the PGP public key identifier (may be null if 
     *    not specified). Each invocation of this method returns a new clone 
     *    to protect against subsequent modification.
     */
    byte[] getKeyId();

    /**
     * Returns the PGP key material packet of this PGPData as
     * defined in RFC 2440, 
     * section 5.5.
     *
     * @return the PGP key material packet (may be null if not 
     *    specified). Each invocation of this method returns a new clone to 
     *    protect against subsequent modification.
     */
    byte[] getKeyPacket();

    /**
     * Returns an {@link Collections#unmodifiableList unmodifiable list}
     * of {@link XMLStructure}s representing elements from an external 
     * namespace. 
     *
     * @return an unmodifiable list of XMLStructures (may be 
     *    empty, but never null)
     */
    List getExternalElements();
}