/*
 * Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
/*
 * $Id: X509IssuerSerial.java,v 1.4 2005/05/10 16:35:35 mullan Exp $
 */
package javax.xml.crypto.dsig.keyinfo;

import java.math.BigInteger;
import java.security.cert.X509Certificate;
import javax.xml.crypto.XMLStructure;

A representation of the XML X509IssuerSerial element as defined in the W3C Recommendation for XML-Signature Syntax and Processing. An X509IssuerSerial object contains an X.509 issuer distinguished name (DN) and serial number pair. The XML schema definition is defined as:
  <element name="X509IssuerSerial" type="ds:X509IssuerSerialType"/>
  <complexType name="X509IssuerSerialType">
    <sequence>
      <element name="X509IssuerName" type="string"/>
      <element name="X509SerialNumber" type="integer"/>
    </sequence>
  </complexType>
An X509IssuerSerial instance may be created by invoking the newX509IssuerSerial method of the KeyInfoFactory class, and passing it a String and BigInteger representing the X.500 DN and serial number. Here is an example of creating an X509IssuerSerial from the issuer DN and serial number of an existing X509Certificate:
KeyInfoFactory factory = KeyInfoFactory.getInstance("DOM");
X509IssuerSerial issuer = factory.newX509IssuerSerial
    (cert.getIssuerX500Principal().getName(), cert.getSerialNumber());
Author:Sean Mullan, JSR 105 Expert Group
See Also:
Since:1.6
/** * A representation of the XML <code>X509IssuerSerial</code> element as * defined in the <a href="http://www.w3.org/TR/xmldsig-core/"> * W3C Recommendation for XML-Signature Syntax and Processing</a>. * An <code>X509IssuerSerial</code> object contains an X.509 issuer * distinguished name (DN) and serial number pair. The XML schema definition is * defined as: * * <pre> * &lt;element name="X509IssuerSerial" type="ds:X509IssuerSerialType"/&gt; * &lt;complexType name="X509IssuerSerialType"&gt; * &lt;sequence&gt; * &lt;element name="X509IssuerName" type="string"/&gt; * &lt;element name="X509SerialNumber" type="integer"/&gt; * &lt;/sequence&gt; * &lt;/complexType&gt; * </pre> * * An <code>X509IssuerSerial</code> instance may be created by invoking the * {@link KeyInfoFactory#newX509IssuerSerial newX509IssuerSerial} method * of the {@link KeyInfoFactory} class, and passing it a * <code>String</code> and <code>BigInteger</code> representing the X.500 * DN and serial number. Here is an example of creating an * <code>X509IssuerSerial</code> from the issuer DN and serial number of an * existing {@link X509Certificate}: * <pre> * KeyInfoFactory factory = KeyInfoFactory.getInstance("DOM"); * X509IssuerSerial issuer = factory.newX509IssuerSerial * (cert.getIssuerX500Principal().getName(), cert.getSerialNumber()); * </pre> * * @author Sean Mullan * @author JSR 105 Expert Group * @since 1.6 * @see X509Data#getContent * @see KeyInfoFactory#newX509IssuerSerial(String, BigInteger) */
public interface X509IssuerSerial extends XMLStructure {
Returns the X.500 distinguished name of this X509IssuerSerial in RFC 2253 String format.
Returns:the X.500 distinguished name in RFC 2253 String format (never null)
/** * Returns the X.500 distinguished name of this * <code>X509IssuerSerial</code> in * <a href="http://www.ietf.org/rfc/rfc2253.txt">RFC 2253</a> String format. * * @return the X.500 distinguished name in RFC 2253 String format (never * <code>null</code>) */
String getIssuerName();
Returns the serial number of this X509IssuerSerial.
Returns:the serial number (never null)
/** * Returns the serial number of this <code>X509IssuerSerial</code>. * * @return the serial number (never <code>null</code>) */
BigInteger getSerialNumber(); }