001 /*
002 * Copyright 2005 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025 /*
026 * $Id: KeyInfo.java,v 1.7 2005/05/10 16:35:34 mullan Exp $
027 */
028 package javax.xml.crypto.dsig.keyinfo;
029
030 import java.util.List;
031 import javax.xml.crypto.MarshalException;
032 import javax.xml.crypto.XMLCryptoContext;
033 import javax.xml.crypto.XMLStructure;
034
035 /**
036 * A representation of the XML <code>KeyInfo</code> element as defined in
037 * the <a href="http://www.w3.org/TR/xmldsig-core/">
038 * W3C Recommendation for XML-Signature Syntax and Processing</a>.
039 * A <code>KeyInfo</code> contains a list of {@link XMLStructure}s, each of
040 * which contain information that enables the recipient(s) to obtain the key
041 * needed to validate an XML signature. The XML Schema Definition is defined as:
042 *
043 * <pre>
044 * <element name="KeyInfo" type="ds:KeyInfoType"/>
045 * <complexType name="KeyInfoType" mixed="true">
046 * <choice maxOccurs="unbounded">
047 * <element ref="ds:KeyName"/>
048 * <element ref="ds:KeyValue"/>
049 * <element ref="ds:RetrievalMethod"/>
050 * <element ref="ds:X509Data"/>
051 * <element ref="ds:PGPData"/>
052 * <element ref="ds:SPKIData"/>
053 * <element ref="ds:MgmtData"/>
054 * <any processContents="lax" namespace="##other"/>
055 * <!-- (1,1) elements from (0,unbounded) namespaces -->
056 * </choice>
057 * <attribute name="Id" type="ID" use="optional"/>
058 * </complexType>
059 * </pre>
060 *
061 * A <code>KeyInfo</code> instance may be created by invoking one of the
062 * {@link KeyInfoFactory#newKeyInfo newKeyInfo} methods of the
063 * {@link KeyInfoFactory} class, and passing it a list of one or more
064 * <code>XMLStructure</code>s and an optional id parameter;
065 * for example:
066 * <pre>
067 * KeyInfoFactory factory = KeyInfoFactory.getInstance("DOM");
068 * KeyInfo keyInfo = factory.newKeyInfo
069 * (Collections.singletonList(factory.newKeyName("Alice"), "keyinfo-1"));
070 * </pre>
071 *
072 * <p><code>KeyInfo</code> objects can also be marshalled to XML by invoking
073 * the {@link #marshal marshal} method.
074 *
075 * @author Sean Mullan
076 * @author JSR 105 Expert Group
077 * @since 1.6
078 * @see KeyInfoFactory#newKeyInfo(List)
079 * @see KeyInfoFactory#newKeyInfo(List, String)
080 */
081 public interface KeyInfo extends XMLStructure {
082
083 /**
084 * Returns an {@link java.util.Collections#unmodifiableList unmodifiable
085 * list} containing the key information. Each entry of the list is
086 * an {@link XMLStructure}.
087 *
088 * <p>If there is a public subclass representing the type of
089 * <code>XMLStructure</code>, it is returned as an instance of that
090 * class (ex: an <code>X509Data</code> element would be returned as an
091 * instance of {@link javax.xml.crypto.dsig.keyinfo.X509Data}).
092 *
093 * @return an unmodifiable list of one or more <code>XMLStructure</code>s
094 * in this <code>KeyInfo</code>. Never returns <code>null</code> or an
095 * empty list.
096 */
097 List getContent();
098
099 /**
100 * Return the optional Id attribute of this <code>KeyInfo</code>, which
101 * may be useful for referencing this <code>KeyInfo</code> from other
102 * XML structures.
103 *
104 * @return the Id attribute of this <code>KeyInfo</code> (may be
105 * <code>null</code> if not specified)
106 */
107 String getId();
108
109 /**
110 * Marshals the key info to XML.
111 *
112 * @param parent a mechanism-specific structure containing the parent node
113 * that the marshalled key info will be appended to
114 * @param context the <code>XMLCryptoContext</code> containing additional
115 * context (may be null if not applicable)
116 * @throws ClassCastException if the type of <code>parent</code> or
117 * <code>context</code> is not compatible with this key info
118 * @throws MarshalException if the key info cannot be marshalled
119 * @throws NullPointerException if <code>parent</code> is <code>null</code>
120 */
121 void marshal(XMLStructure parent, XMLCryptoContext context)
122 throws MarshalException;
123 }
|