Source Code Cross Referenced for X509Data.java in  » 6.0-JDK-Core » xml » javax » xml » crypto » dsig » keyinfo » Java Source Code / Java DocumentationJava Source Code and Java Documentation

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: X509Data.java,v 1.4 2005/05/10 16:35:35 mullan Exp $
027         */
028        package javax.xml.crypto.dsig.keyinfo;
029
030        import javax.xml.crypto.XMLStructure;
031        import java.security.cert.X509CRL;
032        import java.util.List;
033
034        /**
035         * A representation of the XML <code>X509Data</code> element as defined in 
036         * the <a href="http://www.w3.org/TR/xmldsig-core/">
037         * W3C Recommendation for XML-Signature Syntax and Processing</a>. An
038         * <code>X509Data</code> object contains one or more identifers of keys 
039         * or X.509 certificates (or certificates' identifiers or a revocation list). 
040         * The XML Schema Definition is defined as:
041         * 
042         * <pre>
043         *    &lt;element name="X509Data" type="ds:X509DataType"/&gt;
044         *    &lt;complexType name="X509DataType"&gt; 
045         *        &lt;sequence maxOccurs="unbounded"&gt; 
046         *          &lt;choice&gt; 
047         *            &lt;element name="X509IssuerSerial" type="ds:X509IssuerSerialType"/&gt;
048         *            &lt;element name="X509SKI" type="base64Binary"/&gt;
049         *            &lt;element name="X509SubjectName" type="string"/&gt; 
050         *            &lt;element name="X509Certificate" type="base64Binary"/&gt;
051         *            &lt;element name="X509CRL" type="base64Binary"/&gt; 
052         *            &lt;any namespace="##other" processContents="lax"/&gt;
053         *          &lt;/choice&gt;  
054         *        &lt;/sequence&gt;
055         *    &lt;/complexType&gt;
056         *
057         *    &lt;complexType name="X509IssuerSerialType"&gt; 
058         *      &lt;sequence&gt; 
059         *        &lt;element name="X509IssuerName" type="string"/&gt; 
060         *        &lt;element name="X509SerialNumber" type="integer"/&gt; 
061         *      &lt;/sequence&gt;
062         *    &lt;/complexType&gt;
063         * </pre>
064         *
065         * An <code>X509Data</code> instance may be created by invoking the
066         * {@link KeyInfoFactory#newX509Data newX509Data} methods of the
067         * {@link KeyInfoFactory} class and passing it a list of one or more 
068         * {@link XMLStructure}s representing X.509 content; for example:
069         * <pre>
070         *   KeyInfoFactory factory = KeyInfoFactory.getInstance("DOM");
071         *   X509Data x509Data = factory.newX509Data
072         *       (Collections.singletonList("cn=Alice"));
073         * </pre>
074         *
075         * @author Sean Mullan
076         * @author JSR 105 Expert Group
077         * @since 1.6
078         * @see KeyInfoFactory#newX509Data(List)
079         */
080        //@@@ check for illegal combinations of data violating MUSTs in W3c spec
081        public interface X509Data extends XMLStructure {
082
083            /**
084             * URI identifying the X509Data KeyInfo type:
085             * http://www.w3.org/2000/09/xmldsig#X509Data. This can be specified as
086             * the value of the <code>type</code> parameter of the
087             * {@link RetrievalMethod} class to describe a remote
088             * <code>X509Data</code> structure.
089             */
090            final static String TYPE = "http://www.w3.org/2000/09/xmldsig#X509Data";
091
092            /**
093             * URI identifying the binary (ASN.1 DER) X.509 Certificate KeyInfo type:
094             * http://www.w3.org/2000/09/xmldsig#rawX509Certificate. This can be 
095             * specified as the value of the <code>type</code> parameter of the
096             * {@link RetrievalMethod} class to describe a remote X509 Certificate.
097             */
098            final static String RAW_X509_CERTIFICATE_TYPE = "http://www.w3.org/2000/09/xmldsig#rawX509Certificate";
099
100            /**
101             * Returns an {@link java.util.Collections#unmodifiableList unmodifiable 
102             * list} of the content in this <code>X509Data</code>. Valid types are 
103             * {@link String} (subject names), <code>byte[]</code> (subject key ids), 
104             * {@link java.security.cert.X509Certificate}, {@link X509CRL}, 
105             * or {@link XMLStructure} ({@link X509IssuerSerial}
106             * objects or elements from an external namespace). 
107             *
108             * @return an unmodifiable list of the content in this <code>X509Data</code>
109             *    (never <code>null</code> or empty)
110             */
111            List getContent();
112        }