com.fluidbpm.program.api.vo.ws.auth.AuthRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fluid-api Show documentation

Used for the * Custom Program Step, * Custom Actions, * Scheduled Actions and * Fluid API in the Fluid BPM and Content Management system.

There is a newer version: 1.12

Show newest version

/*
 * Koekiebox CONFIDENTIAL
 *
 * [2012] - [2017] Koekiebox (Pty) Ltd
 * All Rights Reserved.
 *
 * NOTICE: All information contained herein is, and remains the property
 * of Koekiebox and its suppliers, if any. The intellectual and
 * technical concepts contained herein are proprietary to Koekiebox
 * and its suppliers and may be covered by South African and Foreign Patents,
 * patents in process, and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material is strictly
 * forbidden unless prior written permission is obtained from Koekiebox.
 */

package com.fluidbpm.program.api.vo.ws.auth;

import org.json.JSONException;
import org.json.JSONObject;

import com.fluidbpm.program.api.vo.ABaseFluidJSONObject;

/**
 * Request object for authorization.
 *
 * @author jasonbruwer
 * @since v1.0
 *
 * @see ABaseFluidJSONObject
 * @see TokenStatus
 * @see AppRequestToken
 * @see AuthResponse
 * @see AuthEncryptedData
 */
public class AuthRequest extends ABaseFluidJSONObject {

    public static final long serialVersionUID = 1L;

    private String username;
    private Long lifetime;

    /**
     * The JSON mapping for the {@code AuthRequest} object.
     */
    public static class JSONMapping {
        public static final String USERNAME = "username";
        public static final String LIFETIME = "lifetime";
    }

    /**
     * Gets the Username used for the Authorization request.
     *
     * @return Username for user authenticating.
     */
    public String getUsername() {
        return this.username;
    }

    /**
     * Sets the Username used for the Authorization request.
     *
     * @param username Username for user authenticating.
     */
    public void setUsername(String username) {
        this.username = username;
    }

    /**
     * Gets requested lifetime of the user session in seconds.
     *
     * The provided lifetime is not guaranteed.
     *
     * @return Lifetime of the session.
     */
    public Long getLifetime() {
        return this.lifetime;
    }

    /**
     * Sets requested lifetime of the user session in seconds.
     *
     * The provided {@code lifetimeParam} is not guaranteed.
     *
     * @param lifetimeParam The duration of the session in seconds.
     */
    public void setLifetime(Long lifetimeParam) {
        this.lifetime = lifetimeParam;
    }

    /**
     * Conversion to {@code JSONObject} from Java Object.
     *
     * @return {@code JSONObject} representation of {@code AuthRequest}
     * @throws JSONException If there is a problem with the JSON Body.
     *
     * @see ABaseFluidJSONObject#toJsonObject()
     */
    @Override
    public JSONObject toJsonObject() throws JSONException {

        JSONObject returnVal = super.toJsonObject();

        //Username...
        if (this.getUsername() != null) {
            returnVal.put(JSONMapping.USERNAME, this.getUsername());
        }

        //Lifetime...
        if (this.getLifetime() != null) {
            returnVal.put(JSONMapping.LIFETIME, this.getLifetime());
        }

        return returnVal;
    }
}