io.gs2.auth

クラス Gs2AuthClient

java.lang.Object

io.gs2.AbstractGs2Client<Gs2AuthClient>

io.gs2.auth.Gs2AuthClient

public class Gs2AuthClient
extends AbstractGs2Client<Gs2AuthClient>

GS2 Auth APIクライアント。

作成者:

Game Server Services, Inc.

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static String	ENDPOINT
static String	VARIATION

クラスから継承されたフィールド io.gs2.AbstractGs2Client

credential, region

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
Gs2AuthClient(IGs2Credential credential) コンストラクタ。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
LoginResult	login(LoginRequest request) ログイン。

クラスから継承されたメソッド io.gs2.AbstractGs2Client

createHttpDelete, createHttpGet, createHttpPost, createHttpPut, doRequest, getRegion, setRegion, withRegion

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

ENDPOINT

public static String ENDPOINT

VARIATION

public static String VARIATION

コンストラクタの詳細

Gs2AuthClient

public Gs2AuthClient(IGs2Credential credential)

コンストラクタ。

パラメータ:

credential - 認証情報

メソッドの詳細

login

public LoginResult login(LoginRequest request)
                  throws BadRequestException,
                         UnauthorizedException,
                         InternalServerErrorException

ログイン。 GS2のサービスを利用するにあたってユーザの認証に必要となるアクセストークンを発行します。
アクセストークンの発行には以下の情報が必要となります。

• ユーザID
• サービスID

ユーザID には ログインするユーザのIDを指定してください。
GS2 はアカウント管理機能を持ちませんので、ユーザID は別途アカウント管理システムで発行したIDを指定する必要があります。
アカウントIDの文字種などには制限はありません。

サービスID には任意の文字列を指定できます。
ここで指定したサービスIDにもとづいて、その後アクセストークンで利用できるGSIを制限するのに利用します。

サービスの制限は GSI(AWSのIAMのようなもの) のセキュリティポリシーで設定することができます。
例えば、GSIに設定されたセキュリティポリシーが service-0001 によるアクセスを許可する。という設定の場合、
service-0002 というサービスIDで発行されたアクセストークンとGSIの組み合わせでリクエストを出してもリジェクトされるようになります。

これによって、下記のようなアクセスコントロールを同一アカウント内で実現できます。

• GSI(A) 許可するアクション(GS2Inbox:*) 許可するサービス(service-0001)
• GSI(B) 許可するアクション(GS2Stamina:*) 許可するサービス(service-0002)

この場合、service-0001 向けに発行されたアクセストークンと GSI(B) の組み合わせではサービスを利用することはできません。
そのため、service-0001 向けのアクセストークンでは GS2-Stamina を利用することはできないことになります。

パラメータ:

request - リクエストパラメータ

戻り値:

ログイン結果

例外:

BadRequestException - リクエストパラーメータに誤りがある場合にスローされます

UnauthorizedException - 認証に失敗した場合にスローされます

InternalServerErrorException - 未知のサーバエラーが発生した場合にスローされます