/*

 * Copyright 1997-2006 Sun Microsystems, Inc.  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.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

package sun.security.x509;

import java.io.IOException;

import java.io.InputStream;

import java.io.OutputStream;

import java.math.BigInteger;

import java.util.Enumeration;

import sun.security.util.*;

/**

 * This class defines the SerialNumber attribute for the Certificate.

 *

 * @author Amit Kapoor

 * @author Hemma Prafullchandra

 * @see CertAttrSet

 */

public class CertificateSerialNumber implements CertAttrSet<String> {

    /**

     * Identifier for this attribute, to be used with the

     * get, set, delete methods of Certificate, x509 type.

     */

    public static final String IDENT = "x509.info.serialNumber";

    /**

     * Sub attributes name for this CertAttrSet.

     */

    public static final String NAME = "serialNumber";

    public static final String NUMBER = "number";

    private SerialNumber        serial;

    /**

     * Default constructor for the certificate attribute.

     *

     * @param serial the serial number for the certificate.

     */

    public CertificateSerialNumber(BigInteger num) {

      this.serial = new SerialNumber(num);

    }

    /**

     * Default constructor for the certificate attribute.

     *

     * @param serial the serial number for the certificate.

     */

    public CertificateSerialNumber(int num) {

      this.serial = new SerialNumber(num);

    }

    /**

     * Create the object, decoding the values from the passed DER stream.

     *

     * @param in the DerInputStream to read the serial number from.

     * @exception IOException on decoding errors.

     */

    public CertificateSerialNumber(DerInputStream in) throws IOException {

        serial = new SerialNumber(in);

    }

    /**

     * Create the object, decoding the values from the passed stream.

     *

     * @param in the InputStream to read the serial number from.

     * @exception IOException on decoding errors.

     */

    public CertificateSerialNumber(InputStream in) throws IOException {

        serial = new SerialNumber(in);

    }

    /**

     * Create the object, decoding the values from the passed DerValue.

     *

     * @param val the DER encoded value.

     * @exception IOException on decoding errors.

     */

    public CertificateSerialNumber(DerValue val) throws IOException {

        serial = new SerialNumber(val);

    }

    /**

     * Return the serial number as user readable string.

     */

    public String toString() {

        if (serial == null) return "";

        return (serial.toString());

    }

    /**

     * Encode the serial number in DER form to the stream.

     *

     * @param out the DerOutputStream to marshal the contents to.

     * @exception IOException on errors.

     */

    public void encode(OutputStream out) throws IOException {

        DerOutputStream tmp = new DerOutputStream();

        serial.encode(tmp);

        out.write(tmp.toByteArray());

    }

    /**

     * Set the attribute value.

     */

    public void set(String name, Object obj) throws IOException {

        if (!(obj instanceof SerialNumber)) {

            throw new IOException("Attribute must be of type SerialNumber.");

        }

        if (name.equalsIgnoreCase(NUMBER)) {

            serial = (SerialNumber)obj;

        } else {

            throw new IOException("Attribute name not recognized by " +

                                "CertAttrSet:CertificateSerialNumber.");

        }

    }

    /**

     * Get the attribute value.

     */

    public Object get(String name) throws IOException {

        if (name.equalsIgnoreCase(NUMBER)) {

            return (serial);

        } else {

            throw new IOException("Attribute name not recognized by " +

                                "CertAttrSet:CertificateSerialNumber.");

        }

    }

    /**

     * Delete the attribute value.

     */

    public void delete(String name) throws IOException {

        if (name.equalsIgnoreCase(NUMBER)) {

            serial = null;

        } else {

            throw new IOException("Attribute name not recognized by " +

                                "CertAttrSet:CertificateSerialNumber.");

        }

    }

    /**

     * Return an enumeration of names of attributes existing within this

     * attribute.

     */

    public Enumeration<String> getElements() {

        AttributeNameEnumeration elements = new AttributeNameEnumeration();

        elements.addElement(NUMBER);

        return (elements.elements());

    }

    /**

     * Return the name of this attribute.

     */

    public String getName() {

        return (NAME);

    }

}