iaik.pkcs.pkcs11.objects.DateAttribute Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sunpkcs11-wrapper
PKCS#11 wrapper based on sunpkcs11
There is a newer version: 1.4.10
// Copyright (c) 2002 Graz University of Technology. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
//    this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. The end-user documentation included with the redistribution, if any, must
//    include the following acknowledgment:
//
//    "This product includes software developed by IAIK of Graz University of
//     Technology."
//
//    Alternately, this acknowledgment may appear in the software itself, if and
//    wherever such third-party acknowledgments normally appear.
//
// 4. The names "Graz University of Technology" and "IAIK of Graz University of
//    Technology" must not be used to endorse or promote products derived from
//    this software without prior written permission.
//
// 5. Products derived from this software may not be called "IAIK PKCS Wrapper",
//    nor may "IAIK" appear in their name, without prior written permission of
//    Graz University of Technology.
//
// THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE LICENSOR BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
// OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
// OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
// ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
// OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.

package iaik.pkcs.pkcs11.objects;

import java.util.Date;

import iaik.pkcs.pkcs11.Util;
import iaik.pkcs.pkcs11.wrapper.Functions;
import sun.security.pkcs11.wrapper.CK_DATE;

/**
 * Objects of this class represent a date attribute of an PKCS#11 object
 * as specified by PKCS#11.
 *
 * @author  Karl Scheibelhofer 
 * @version 1.0
 * @invariants
 */
@SuppressWarnings("restriction")
public class DateAttribute extends Attribute {

    /**
     * Default constructor - only for internal use in
     * AttributeArrayAttribute.getValueString().
     */
    DateAttribute() {
        super();
    }

    /**
     * Constructor taking the PKCS#11 type of the attribute.
     *
     * @param type
     *          The PKCS#11 type of this attribute; e.g.
     *          PKCS11Constants.CKA_START_DATE.
     * @preconditions (type <> null)
     * @postconditions
     */
    public DateAttribute(Long type) {
        super(type);
    }

    /**
     * Set the date value of this attribute. Null, is also valid.
     * A call to this method sets the present flag to true.
     *
     * @param value
     *          The date value to set. May be null.
     * @preconditions
     * @postconditions
     */
    public void setDateValue(Date value) {
        ckAttribute_.pValue = Util.convertToCkDate(value);
        present_ = true;
    }

    /**
     * Get the date value of this attribute. Null, is also possible.
     *
     * @return The date value of this attribute or null.
     * @preconditions
     * @postconditions
     */
    public Date getDateValue() {
        return Util.convertToDate((CK_DATE) ckAttribute_.pValue);
    }

    /**
     * Compares all member variables of this object with the other object.
     * Returns only true, if all are equal in both objects.
     *
     * @param otherObject
     *          The other object to compare to.
     * @return True, if other is an instance of this class and all member
     *         variables of both objects are equal. False, otherwise.
     * @preconditions
     * @postconditions
     */
    @Override
    public boolean equals(java.lang.Object otherObject) {
        if (this == otherObject) {
            return true;
        }

        if (!(otherObject instanceof DateAttribute)) {
            return false;
        }

        DateAttribute other = (DateAttribute) otherObject;
        if (!this.present_ && !other.present_) {
            return true;
        }

        if (!(this.present_ && other.present_)) {
            return false;
        }

        if (this.sensitive_ != other.sensitive_) {
            return false;
        }

        if (this.ckAttribute_.type != other.ckAttribute_.type) {
            return false;
        }

        return Functions.equals((CK_DATE) this.ckAttribute_.pValue,
                (CK_DATE) other.ckAttribute_.pValue);
    }

    /**
     * The overriding of this method should ensure that the objects of this
     * class work correctly in a hashtable.
     *
     * @return The hash code of this object.
     * @preconditions
     * @postconditions
     */
    @Override
    public int hashCode() {
        return ((int) ckAttribute_.type)
            ^ ((ckAttribute_.pValue != null) ? Functions
                .hashCode((CK_DATE) ckAttribute_.pValue) : 0);
    }

    @Override
    public void setValue(java.lang.Object value)
        throws UnsupportedOperationException {
        setDateValue((Date) value);
    }

}