FlatServe Transition Check Plugin
1.0

com.small_it_office.flatserve.transition
注釈タイプ AllowedTokens


@Documented
@Retention(value=RUNTIME)
@Target(value=METHOD)
public @interface AllowedTokens

対象のHTTPサービスメソッドを実行する際に、保存されたトークンとして許可される条件を指定するアノテーションです。 Tokenアノテーションによって直前に保存されたトークンの文字列が、tokens要素に記述した文字列のうちのどれか、 またはtokensStartsWith要素に指定したいずれかの文字列で始まっている場合に、HTTPサービスメソッドの実行が許可されます。

以下の例は、トークン"foo"が保存されている場合のみ実行可能なHTTPサービスメソッドを表します。

 @HttpService
 @AllowedTokens(tokens = "foo")
 public HtmlTextResponse serviceMethod1() {
     ...
 

tokensは、複数指定することもできます。この場合、指定されたうちの文字列のどれか1つが、保存されたトークンに 一致すれば、HTTPサービスメソッドの実行が許可されます。

 @HttpService
 @AllowedTokens(tokens = {"foo", "bar"})
 public HtmlTextResponse serviceMethod2() {
     ...
 

トークンの文字列比較を完全一致ではなく、前方一致で行うこともできます。 "hoge"、"hogehoge"、"fugafuga"といったトークンは、いずれも以下の指定の条件に一致します。

 @HttpService
 @AllowedTokens(tokensStartsWith = {"hoge", "fuga"})
 public HtmlTextResponse serviceMethod3() {
     ...
 

tokens要素とtokensStartsWith要素は同時に指定することができます。 両方の要素を省略した場合、保存されているトークンにかかわらず 必ず不正な遷移とみなされてしまいます。


任意要素の概要
 java.lang.String[] tokens
          保存されているトークンの候補を指定します。
 java.lang.String[] tokensStartsWith
          保存されているトークンの最初の文字列を指定します。
 

tokens

public abstract java.lang.String[] tokens
保存されているトークンの候補を指定します。 保存されているトークンがここで指定した文字列のいずれかに一致すれば、正しい遷移とみなされます。

デフォルト:
{}

tokensStartsWith

public abstract java.lang.String[] tokensStartsWith
保存されているトークンの最初の文字列を指定します。 保存されているトークンが、ここで指定した文字列のいずれかで始まっていれば、正しい遷移とみなされます。

デフォルト:
{}

FlatServe Transition Check Plugin
1.0