com.handywedge.context

インタフェース FWRESTContext

既知のサブインタフェースのリスト:

FWFullRESTContext

public interface FWRESTContext

REST API内の実装で使用するコンテキストです。
REST APIではセッションコンテキストにアクセスできないため、トークンで認証されたユーザー情報などはこのインターフェースを通じて取得します。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
String	getApplicationId() アプリケーションIDを返します。
String	getContextPath() アプリケーションのコンテキストパスを返します。
String	getHostName() 実行中のサーバーのホスト名を返します。
String	getRequestId() リクエストIDを返します。
Date	getRequestStartTime() リクエスト開始時間を返します。
String	getToken() リクエストで認証されたAPIトークンを返します。
String	getUserId() ユーザーIDを返します。
Locale	getUserLocale() ユーザーのロケール情報を返します。
String	getUserName() ユーザー名を返します。
String	getUserRole() ユーザーに設定されているロールコードを返します。
String	getUserRoleName() ユーザーに設定されているロールを返します。
boolean	isRest() リクエストがREST APIの場合はtrueを返します。

メソッドの詳細

getUserId

String getUserId()

ユーザーIDを返します。

戻り値:

ユーザーID

getUserName

String getUserName()

ユーザー名を返します。

戻り値:

ユーザー名

getUserLocale

Locale getUserLocale()

ユーザーのロケール情報を返します。

戻り値:

ロケール情報

getUserRole

String getUserRole()

ユーザーに設定されているロールコードを返します。
ロールコードの設定がない場合はnullとなります。

戻り値:

ロール

getUserRoleName

String getUserRoleName()

ユーザーに設定されているロールを返します。
ロール名の設定がない場合はロールコードとなります。

戻り値:

ロール名もしくはロールコード

isRest

boolean isRest()

リクエストがREST APIの場合はtrueを返します。

戻り値:

リクエストがREST APIの場合はtrue

getToken

String getToken()

リクエストで認証されたAPIトークンを返します。

戻り値:

APIトークン

getRequestId

String getRequestId()

リクエストIDを返します。

戻り値:

リクエストID

getRequestStartTime

Date getRequestStartTime()

リクエスト開始時間を返します。

戻り値:

リクエスト開始時間

getHostName

String getHostName()

実行中のサーバーのホスト名を返します。

戻り値:

実行中のサーバーの名称

getApplicationId

String getApplicationId()

アプリケーションIDを返します。

戻り値:

アプリケーションID

getContextPath

String getContextPath()

アプリケーションのコンテキストパスを返します。

戻り値:

コンテキストパス