com.authlete.common.dto.HskResponse Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of authlete-java-common Show documentation

Authlete Java library used commonly by service implementations and the Authlete server.

There is a newer version: 4.15

/*
 * Copyright (C) 2021 Authlete, Inc.
 *
 * Licensed 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.
 */
package com.authlete.common.dto;


/**
 * Response from Authlete's {@code /api/hsk/create} API,
 * /api/hsk/delete/{handle} API and
 * /api/hsk/get/{handle} API.
 *
 * @since 2.97
 * @since Authlete 2.2.12
 */
public class HskResponse extends ApiResponse
{
    private static final long serialVersionUID = 1L;


    /**
     * The result of the API call.
     */
    public enum Action
    {
        /**
         * The API call succeeded.
         */
        SUCCESS,

        /**
         * The API call was wrong.
         */
        INVALID_REQUEST,

        /**
         * There is no record that corresponds to the specified handle.
         */
        NOT_FOUND,

        /**
         * An error occurred on Authlete side.
         */
        SERVER_ERROR,
    }


    private Action action;
    private Hsk hsk;


    /**
     * Get the result of the API call.
     *
     * @return
     *         The result of the API call.
     */
    public Action getAction()
    {
        return action;
    }


    /**
     * Set the result of the API call.
     *
     * @param action
     *         The result of the API call.
     *
     * @return
     *         {@code this} object.
     */
    public HskResponse setAction(Action action)
    {
        this.action = action;

        return this;
    }


    /**
     * Get the information about the key on the HSM.
     *
     * @return
     *         Information about the key.
     */
    public Hsk getHsk()
    {
        return hsk;
    }


    /**
     * Set the information about the key on the HSM.
     *
     * @param hsk
     *         Information about the key.
     *
     * @return
     *         {@code this} object.
     */
    public HskResponse setHsk(Hsk hsk)
    {
        this.hsk = hsk;

        return this;
    }
}