com.launchkey.sdk.domain.sse.ServiceUserSessionServerSentEventPackage 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
The newest version!
/**
 * Copyright 2016 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.domain.sse;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.launchkey.sdk.domain.service.AuthorizationResponse;

import java.util.Date;

/**
 * A Server Sent Event callback used to inform an application that the user has remotely logged out.
 */
@JsonIgnoreProperties(ignoreUnknown = true)
public class ServiceUserSessionServerSentEventPackage implements ServerSentEventPackage {
    /**
     * Unique user identifier that will match the user hash in {@link AuthorizationResponse#getServiceUserHash()}
     */
    private final String serviceUserHash;

    /**
     * The date and time the remote logout was requested. This value is to be used to ensure the user has not started
     * a new session since the logout was request and inadvertently ending their application session.
     */
    private final Date logoutRequested;

    /**
     *
     * @param logoutRequested The date and time the remote logout was requested. This value is to be used to ensure
     *                        the user has not started a new session since the logout was request and inadvertently
     *                        ending their application session.
     * @param serviceUserHash Unique user identifier that will match the user hash in {@link AuthorizationResponse#getServiceUserHash()}
     */
    @JsonCreator
    public ServiceUserSessionServerSentEventPackage(
            @JsonProperty("api_time") Date logoutRequested,
            @JsonProperty("service_user_hash") String serviceUserHash
    ) {
        this.logoutRequested = logoutRequested;
        this.serviceUserHash = serviceUserHash;
    }

    /**
     * Get the date and time the remote logout was requested. This value is to be used to ensure the user has not started
     * a new session since the logout was request and inadvertently ending their application session.
     * @return The date and time the remote logout was requested
     */
    public Date getLogoutRequested() {
        return this.logoutRequested;
    }

    /**
     * Get the unique user identifier that will match the user hash in {@link AuthorizationResponse#getServiceUserHash()}
     * @return Unique user identifier
     */
    public String getServiceUserHash() {
        return serviceUserHash;
    }

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

        ServiceUserSessionServerSentEventPackage that = (ServiceUserSessionServerSentEventPackage) o;

        if (logoutRequested != null ? !logoutRequested.equals(that.logoutRequested) : that.logoutRequested != null) return false;
        return !(serviceUserHash != null ? !serviceUserHash.equals(that.serviceUserHash) : that.serviceUserHash != null);

    }

    @Override
    public int hashCode() {
        int result = getServiceUserHash() != null ? getServiceUserHash().hashCode() : 0;
        result = 31 * result + (getLogoutRequested() != null ? getLogoutRequested().hashCode() : 0);
        return result;
    }

    @Override
    public String toString() {
        return "ServiceUserSessionServerSentEventPackage{" +
                "serviceUserHash='" + serviceUserHash + '\'' +
                ", logoutRequested=" + logoutRequested +
                '}';
    }
}