FailInfo.java :  » Authentication-Authorization » ejbca » org » ejbca » core » protocol » Java Open Source

/*************************************************************************
 *                                                                       *
 *  EJBCA: The OpenSource Certificate Authority                          *
 *                                                                       *
 *  This software is free software; you can redistribute it and/or       *
 *  modify it under the terms of the GNU Lesser General Public           *
 *  License as published by the Free Software Foundation; either         *
 *  version 2.1 of the License, or any later version.                    *
 *                                                                       *
 *  See terms of license at gnu.org.                                     *
 *                                                                       *
 *************************************************************************/
 
/**
 * $Header: /cvsroot/ejbca/ejbca/src/java/org/ejbca/core/protocol/FailInfo.java,v 1.5 2006/11/02 17:03:21 anatom Exp $
 * $Revision: 1.5 $
 * $Date: 2006/11/02 17:03:21 $
 *
 */
package org.ejbca.core.protocol;

import java.io.Serializable;

import org.bouncycastle.asn1.DERBitString;
import org.bouncycastle.asn1.x509.ReasonFlags;

/**
 * Encapsulates the possible values for the failinfo part of a SCEP FAILURE response.
 *
 * @author Jon Barber (jon.barber@acm.org)
 * @version $Id: FailInfo.java,v 1.5 2006/11/02 17:03:21 anatom Exp $
 */

public class FailInfo implements Serializable {

    /**
     * Unrecognized or unsupported algorithm ident
     */
    public static final FailInfo BAD_ALGORITHM = new FailInfo(0);

    /**
     * Integrity check failed
     */
    public static final FailInfo BAD_MESSAGE_CHECK = new FailInfo(1);

    /**
     * Transaction not permitted or supported
     */
    public static final FailInfo BAD_REQUEST = new FailInfo(2);

    /**
     * Message time field was not sufficiently close to the system time
     */
    public static final FailInfo BAD_TIME = new FailInfo(3);

    /**
     * No certificate could be identified matching the provided criteria
     */
    public static final FailInfo BAD_CERTIFICATE_ID = new FailInfo(4);
    /**
     * Request for wrong certificate authority
     */
    public static final FailInfo WRONG_AUTHORITY = new FailInfo(6);
    /**
     * Data incorrect, for example request for a non-existing user
     */
    public static final FailInfo INCORRECT_DATA = new FailInfo(7);
    /**
     * Verification of Proof of possession failed
     */
    public static final FailInfo BAD_POP = new FailInfo(9);
    /**
     * Not authorized
     */
    public static final FailInfo NOT_AUTHORIZED = new FailInfo(23);
    /**
     * The value actually encoded into the response message as the failinfo attribute
     */
    private final int value;

    private FailInfo(int value) {
        this.value = value;
    }

    /**
     * Gets the value embedded in the response message as a failinfo attribute
     * @return  the value to use
     */
    public String getValue() {
        return Integer.toString(value);
    }

    /** Returns the FailInfo value as a bit string, where the value represents the bit that is set
     * 
     * @return DERBitString
     */
    public DERBitString getAsBitString() {
      int i = 1 << value;
      // Use reasonflags, because it already has convertion between int and BitString in it
      DERBitString str = new ReasonFlags(i);
      return str;
    }

    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof FailInfo)) return false;

        final FailInfo scepResponseStatus = (FailInfo) o;

        if (value != scepResponseStatus.value) return false;

        return true;
    }

    public int hashCode() {
        return value;
    }
    public String toString() {
      return Integer.toString(value);
    }
}