UserService(Google App Engine API for Java)

com.google.appengine.api.users

インターフェース UserService



  • public interface UserService
    UserService は、ユーザーを強制的にログインまたはログアウトさせたり、現在ログインしているユーザーに関する情報を取得したりするために役立つ情報を提供します。
    • メソッドの概要

      すべてのメソッド インスタンス メソッド 抽象メソッド サポートが終了したメソッド 
      修飾子と型 メソッドと説明
      java.lang.String createLoginURL(java.lang.String destinationURL)
      ユーザーにログインページを表示するために使用できる URL を返します。
      java.lang.String createLoginURL(java.lang.String destinationURL, java.lang.String authDomain)
      ユーザーにログインページを表示するために使用できる URL を返します。
      java.lang.String createLoginURL(java.lang.String destinationURL, java.lang.String authDomain, java.lang.String federatedIdentity, java.util.Set<java.lang.String> attributesRequest)
      サポート終了。 
      federatedIdentity のサポートは終了しています。このパラメータを使用しないメソッドに呼び出しを変更してください。
      java.lang.String createLogoutURL(java.lang.String destinationURL)
      このアプリから現在のユーザーをログアウトさせるために使用できる URL を返します。
      java.lang.String createLogoutURL(java.lang.String destinationURL, java.lang.String authDomain)
      このアプリから現在のユーザーをログアウトさせるために使用できる URL を返します。
      User getCurrentUser()
      ユーザーがログインしている場合、このメソッドはそれらのユーザーに関する情報を含む User を返します。
      boolean isUserAdmin()
      このリクエストを行ったユーザーがこのアプリケーションの管理者である場合は true を返し、そうでない場合は false を返します。
      boolean isUserLoggedIn()
      ログインしているユーザーがいる場合は true を返し、そうでない場合は false を返します。
    • メソッドの詳細

      • createLoginURL

        java.lang.String createLoginURL(java.lang.String destinationURL)
        ユーザーにログインページを表示するために使用できる URL を返します。
        パラメータ:
        destinationURL - ユーザーのログイン後のリダイレクト先。
        戻り値:
        ログイン プロンプトを表示する URL。
        スロー:
        java.lang.IllegalArgumentException - destinationURL が無効な場合。
      • createLoginURL

        java.lang.String createLoginURL(java.lang.String destinationURL,
                                        java.lang.String authDomain)
        ユーザーにログインページを表示するために使用できる URL を返します。
        パラメータ:
        destinationURL - ユーザーのログイン後のリダイレクト先。
        authDomain - 使用されません。
        戻り値:
        ログイン プロンプトを表示する URL。
        スロー:
        java.lang.IllegalArgumentException - destinationURL が無効な場合。
      • createLoginURL

        @Deprecated
        java.lang.String createLoginURL(java.lang.String destinationURL,
                                                    java.lang.String authDomain,
                                                    java.lang.String federatedIdentity,
                                                    java.util.Set<java.lang.String> attributesRequest)
        サポート終了。 federatedIdentity のサポートは終了しています。このパラメータを使用しないメソッドに呼び出しを変更してください。
        連携ログインのためにユーザーをサードパーティにリダイレクトするために使用できる URL を返します。
        パラメータ:
        destinationURL - ユーザーのログイン後のリダイレクト先。
        authDomain - 使用されません。
        federatedIdentity - このパラメータを非 null 値に設定すると、IllegalArgumentException がスローされます。OpenID 2.0 のサポートは廃止されました。詳細は、https://cloud.google.com/appengine/docs/deprecations/open_id をご覧ください。
        attributesRequest - 使用されません。
        戻り値:
        ログイン プロンプトを表示する URL。
        スロー:
        java.lang.IllegalArgumentException - destinationURL が無効であるか、federatedIdentity が null でない場合
      • createLogoutURL

        java.lang.String createLogoutURL(java.lang.String destinationURL)
        このアプリから現在のユーザーをログアウトさせるために使用できる URL を返します。
        パラメータ:
        destinationURL - ユーザーのログアウト後のリダイレクト先。
        戻り値:
        ユーザーをログアウトさせる URL。
        スロー:
        java.lang.IllegalArgumentException - destinationURL が無効な場合。
      • createLogoutURL

        java.lang.String createLogoutURL(java.lang.String destinationURL,
                                         java.lang.String authDomain)
        このアプリから現在のユーザーをログアウトさせるために使用できる URL を返します。
        パラメータ:
        destinationURL - ユーザーのログアウト後のリダイレクト先。
        authDomain - 使用されません。
        戻り値:
        ユーザーをログアウトさせる URL。
        スロー:
        java.lang.IllegalArgumentException - destinationURL が無効な場合。
      • isUserLoggedIn

        boolean isUserLoggedIn()
        ログインしているユーザーがいる場合は true を返し、そうでない場合は false を返します。
      • isUserAdmin

        boolean isUserAdmin()
        このリクエストを行ったユーザーがこのアプリケーションの管理者である場合は true を返し、そうでない場合は false を返します。
        スロー:
        java.lang.IllegalStateException - 現在のユーザーがログインしていない場合。
      • getCurrentUser

        User getCurrentUser()
        ユーザーがログインしている場合、このメソッドはそれらのユーザーに関する情報を含む User を返します。繰り返し呼び出しを行った場合、必ずしも同じ User オブジェクトが返されるとは限らないので注意してください。
        戻り値:
        ユーザーがログインしている場合は User、そうでない場合は null。
このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

Java の App Engine スタンダード環境