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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xmlsec Show documentation
The 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$
 */
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
 * {@link KeyInfoFactory#newX509IssuerSerial newX509IssuerSerial} method 
 * of the {@link 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 {@link X509Certificate}:
 *  * KeyInfoFactory factory = KeyInfoFactory.getInstance("DOM");
 * X509IssuerSerial issuer = factory.newX509IssuerSerial
 *     (cert.getIssuerX500Principal().getName(), cert.getSerialNumber());
 * 
 *
 * @author Sean Mullan
 * @author JSR 105 Expert Group
 * @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.
     *
     * @return the X.500 distinguished name in RFC 2253 String format (never 
     *    null)
     */
    String getIssuerName();

    /**
     * Returns the serial number of this X509IssuerSerial.
     *
     * @return the serial number (never null)
     */
    BigInteger getSerialNumber();
}