org.jscep.transport.request.Operation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jscep Show documentation
Java implementation of the Simple Certificate Enrollment Protocol
There is a newer version: 2.5.6
/*
 * Copyright (c) 2009-2010 David Grant
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.jscep.transport.request;

/**
 * This enum represents the different types of transaction operations in SCEP.
 * 
 * @author David Grant
 */
public enum Operation {
    /**
     * The operation for GetCACaps.
     * 
     * @see SCEP
     *      Internet-Draft Reference
     */
    GET_CA_CAPS("GetCACaps"),
    /**
     * The operation for GetCACert.
     * 
     * @see SCEP
     *      Internet-Draft Reference
     */
    GET_CA_CERT("GetCACert"),
    /**
     * The operation for GetNextCACert.
     * 
     * @see SCEP
     *      Internet-Draft Reference
     */
    GET_NEXT_CA_CERT("GetNextCACert"),
    /**
     * The operation for PKCSReq, GetCertInitial,
     * GetCert and GetCRL.
     * 
     * @see SCEP
     *      Internet-Draft Reference
     * @see SCEP
     *      Internet-Draft Reference
     * @see SCEP
     *      Internet-Draft Reference
     * @see SCEP
     *      Internet-Draft Reference
     */
    PKI_OPERATION("PKIOperation");

    private final String name;

    private Operation(final String name) {
        this.name = name;
    }

    /**
     * Returns the protocol-specific name for this operation.
     * 
     * @return the protocol-specific name for this operation.
     */
    public String getName() {
        return name;
    }

    /**
     * Returns the corresponding Operation instance for the provided
     * name.
     * 
     * If the provided name is not one of:
     * 

     * GetCACaps;
     * GetCACert;
     * GetNextCACert; or
     * PKIOperation
     * 
     * then this method will throw an {@link IllegalArgumentException}.
     * 
     * @param name
     *            the protocol-specific name.
     * @return the corresponding Operation
     */
    public static Operation forName(final String name) {
        if (name == null) {
            throw new NullPointerException();
        }
        for (Operation op : Operation.values()) {
            if (op.name.equals(name)) {
                return op;
            }
        }
        throw new IllegalArgumentException(name + " not found");
    }
}