io.gs2.account.request.AuthenticationRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gs2-java-sdk-account Show documentation
Game Server Services GS2-Account SDK for Java
The newest version!
/*
 * Copyright 2016 Game Server Services, Inc. or its affiliates. All Rights
 * Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * or in the "license" 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 io.gs2.account.request;

import org.json.JSONObject;
import java.util.List;
import java.util.Map;
import io.gs2.account.model.*;
import io.gs2.control.Gs2BasicRequest;

/**
 * ゲームプレイヤーアカウントを認証 のリクエストモデル
 *
 * @author Game Server Services, Inc.
 */
@SuppressWarnings("serial")
public class AuthenticationRequest extends Gs2BasicRequest {

    /** ネームスペース名 */
    private String namespaceName;

    /**
     * ネームスペース名を取得
     *
     * @return ゲームプレイヤーアカウントを認証
     */
    public String getNamespaceName() {
        return namespaceName;
    }

    /**
     * ネームスペース名を設定
     *
     * @param namespaceName ゲームプレイヤーアカウントを認証
     */
    public void setNamespaceName(String namespaceName) {
        this.namespaceName = namespaceName;
    }

    /**
     * ネームスペース名を設定
     *
     * @param namespaceName ゲームプレイヤーアカウントを認証
     * @return this
     */
    public AuthenticationRequest withNamespaceName(String namespaceName) {
        setNamespaceName(namespaceName);
        return this;
    }

    /** アカウントID */
    private String userId;

    /**
     * アカウントIDを取得
     *
     * @return ゲームプレイヤーアカウントを認証
     */
    public String getUserId() {
        return userId;
    }

    /**
     * アカウントIDを設定
     *
     * @param userId ゲームプレイヤーアカウントを認証
     */
    public void setUserId(String userId) {
        this.userId = userId;
    }

    /**
     * アカウントIDを設定
     *
     * @param userId ゲームプレイヤーアカウントを認証
     * @return this
     */
    public AuthenticationRequest withUserId(String userId) {
        setUserId(userId);
        return this;
    }

    /** 認証トークンの暗号化に使用する暗号鍵 のGRN */
    private String keyId;

    /**
     * 認証トークンの暗号化に使用する暗号鍵 のGRNを取得
     *
     * @return ゲームプレイヤーアカウントを認証
     */
    public String getKeyId() {
        return keyId;
    }

    /**
     * 認証トークンの暗号化に使用する暗号鍵 のGRNを設定
     *
     * @param keyId ゲームプレイヤーアカウントを認証
     */
    public void setKeyId(String keyId) {
        this.keyId = keyId;
    }

    /**
     * 認証トークンの暗号化に使用する暗号鍵 のGRNを設定
     *
     * @param keyId ゲームプレイヤーアカウントを認証
     * @return this
     */
    public AuthenticationRequest withKeyId(String keyId) {
        setKeyId(keyId);
        return this;
    }

    /** パスワード */
    private String password;

    /**
     * パスワードを取得
     *
     * @return ゲームプレイヤーアカウントを認証
     */
    public String getPassword() {
        return password;
    }

    /**
     * パスワードを設定
     *
     * @param password ゲームプレイヤーアカウントを認証
     */
    public void setPassword(String password) {
        this.password = password;
    }

    /**
     * パスワードを設定
     *
     * @param password ゲームプレイヤーアカウントを認証
     * @return this
     */
    public AuthenticationRequest withPassword(String password) {
        setPassword(password);
        return this;
    }

    /** 重複実行回避機能に使用するID */
    private String xGs2DuplicationAvoider;

    /**
     * 重複実行回避機能に使用するIDを取得
     *
     * @return ゲームプレイヤーアカウントを認証
     */
    public String getDuplicationAvoider() {
        return xGs2DuplicationAvoider;
    }

    /**
     * 重複実行回避機能に使用するIDを設定
     *
     * @param duplicationAvoider ゲームプレイヤーアカウントを認証
     */
    public void setDuplicationAvoider(String duplicationAvoider) {
        this.xGs2DuplicationAvoider = duplicationAvoider;
    }

    /**
     * 重複実行回避機能に使用するIDを設定
     *
     * @param duplicationAvoider ゲームプレイヤーアカウントを認証
     * @return this
     */
    public AuthenticationRequest withDuplicationAvoider(String duplicationAvoider) {
        setDuplicationAvoider(duplicationAvoider);
        return this;
    }

}