com.launchkey.sdk.transport.v1.domain.PollRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of launchkey-sdk Show documentation
SDK for interacting with the LaunchKey distributed authentication and authorization platform
There is a newer version: 4.0.0
/**
 * Copyright 2015 LaunchKey, Inc.  All rights reserved.
 * 
 * Licensed under the MIT License.
 * You may not use this file except in compliance with the License.
 * A copy of the License is located in the "LICENSE.txt" file accompanying
 * this file. This file 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.launchkey.sdk.transport.v1.domain;

/**
 * Request data for a "poll" call
 */
public class PollRequest {

    /**
     * The unique ID of the authentication request
     */
    private final String authRequest;

    /**
     * Application Key of your Application. This is found on the Keys tab of your Application details in the Dashboard.
     */
    private final long appKey;

    /**
     * Base64 encoded secret JSON string containing these attributes:
     *     secret:   Secret Key of the Application whose key is included in the current request.
     *     stamped:  LaunchKey formatted Date representing the current time of the request.
     */
    private final String secretKey;

    /**
     * Base64 encoded RSA Signature of the base64 decoded secretKey value.
     */
    private final String signature;

    /**
     *
     * @param authRequest The unique ID of the authentication request. This value should have been returned by a
     *                     success "auths" request.
     *                     @see AuthsResponse
     * @param appKey Application Key of your Application. This is found on the Keys tab of your Application details in
     *               the Dashboard.
     * @param secretKey Base64 encoded secret JSON string containing these attributes:
     *                      secret:   Secret Key of the Application whose key is included in the current request.
     *                      stamped:  LaunchKey formatted Date representing the current time of the request.
     * @param signature Base64 encoded RSA Signature of the base64 decoded secretKey value.
     */
    public PollRequest(String authRequest, long appKey, String secretKey, String signature) {
        this.authRequest = authRequest;
        this.appKey = appKey;
        this.secretKey = secretKey;
        this.signature = signature;
    }

    /**
     * Get the unique ID of the authentication request. This value should have been returned by a successful
     * "auths" request.
     * @see AuthsResponse
     * @return Unique ID
     */
    public String getAuthRequest() {
        return authRequest;
    }

    /**
     * Get the Application Key of the Application associate with this request
     * @return Application Key
     * @deprecated Use {@link #getAppKey()}
     */
    @Deprecated
    public long getRocketKey() {
        return getAppKey();
    }

    /**
     * Get the Application Key of the Application associate with this request
     * @return Application Key
     */
    public long getAppKey() {
        return appKey;
    }

    /**
     * Get the Base64 encoded secret JSON string containing these attributes:
     *      secret:   Secret Key of the Application whose key is included in the current request.
     *      stamped:  LaunchKey formatted Date representing the current time of the request.
     * @return Base64 encoded secret JSON string
     */
    public String getSecretKey() {
        return secretKey;
    }

    /**
     *  Get the Base64 encoded RSA Signature of the base64 decoded secretKey value.
     * @return Base64 encoded RSA Signature
     */
    public String getSignature() {
        return signature;
    }

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

        PollRequest that = (PollRequest) o;

        if (appKey != that.appKey) return false;
        if (authRequest != null ? !authRequest.equals(that.authRequest) : that.authRequest != null) return false;
        if (secretKey != null ? !secretKey.equals(that.secretKey) : that.secretKey != null) return false;
        return !(signature != null ? !signature.equals(that.signature) : that.signature != null);

    }

    @Override
    public int hashCode() {
        int result = authRequest != null ? authRequest.hashCode() : 0;
        result = 31 * result + (int) (appKey ^ (appKey >>> 32));
        result = 31 * result + (secretKey != null ? secretKey.hashCode() : 0);
        result = 31 * result + (signature != null ? signature.hashCode() : 0);
        return result;
    }

    @Override
    public String toString() {
        return "PollRequest{" +
                "authRequest='" + authRequest + '\'' +
                ", appKey=" + appKey +
                ", secretKey='" + secretKey + '\'' +
                ", signature='" + signature + '\'' +
                '}';
    }
}