OAuthService(Google App Engine API for Java)

com.google.appengine.api.oauth

インターフェース OAuthService



  • public interface OAuthService
    OAuthService は、OAuth リクエストの検証に役立つメソッドを提供します。
    関連情報:
    OAuth の仕様は、RFC 5849 をご覧ください。
    • メソッドの概要

      すべてのメソッド インスタンス メソッド 抽象メソッド サポートが終了したメソッド 
      修飾子と型 メソッドと説明
      java.lang.String[] getAuthorizedScopes(java.lang.String... scopes)
      入力スコープから承認されたスコープを返します。
      java.lang.String getClientId(java.lang.String... scopes)
      oauth2 リクエストから client_id を返します。
      java.lang.String getClientId(java.lang.String scope)
      oauth2 リクエストから client_id を返します。
      User getCurrentUser()
      ユーザーの代理として行われたリクエストについて、そのユーザー(User)を返します。
      User getCurrentUser(java.lang.String... scopes)
      ユーザーの代理として行われたリクエストについて、そのユーザー(User)を返します。
      User getCurrentUser(java.lang.String scope)
      ユーザーの代理として行われたリクエストについて、そのユーザー(User)を返します。
      java.lang.String getOAuthConsumerKey()
      サポート終了。 
      OAuth1 のサポートは終了しました。
      boolean isUserAdmin()
      ユーザーの代理として行われたリクエストについて、そのユーザーがこのアプリケーションの管理者である場合は true を返し、そうでない場合は false を返します。
      boolean isUserAdmin(java.lang.String... scopes)
      ユーザーの代理として行われたリクエストについて、そのユーザーがこのアプリケーションの管理者である場合は true を返し、そうでない場合は false を返します。
      boolean isUserAdmin(java.lang.String scope)
      ユーザーの代理として行われたリクエストについて、そのユーザーがこのアプリケーションの管理者である場合は true を返し、そうでない場合は false を返します。
    • メソッドの詳細

      • getCurrentUser

        User getCurrentUser(java.lang.String scope)
                     throws OAuthRequestException
        ユーザーの代理として行われたリクエストについて、そのユーザー(User)を返します。
        パラメータ:
        scope - 受け入れられるカスタム OAuth スコープ。
        スロー:
        OAuthRequestException - リクエストが有効な OAuth リクエストでなかった場合。
        OAuthServiceFailureException - 不明な OAuth エラーが発生した場合。
      • getCurrentUser

        User getCurrentUser(java.lang.String... scopes)
                     throws OAuthRequestException
        ユーザーの代理として行われたリクエストについて、そのユーザー(User)を返します。
        パラメータ:
        scopes - そのうち少なくとも 1 つが受け入れられる、複数のカスタム OAuth スコープ。
        スロー:
        OAuthRequestException - リクエストが有効な OAuth リクエストでなかった場合。
        OAuthServiceFailureException - 不明な OAuth エラーが発生した場合。
      • isUserAdmin

        boolean isUserAdmin()
                     throws OAuthRequestException
        ユーザーの代理として行われたリクエストについて、そのユーザーがこのアプリケーションの管理者である場合は true を返し、そうでない場合は false を返します。
        スロー:
        OAuthRequestException - リクエストが有効な OAuth リクエストでなかった場合。
        OAuthServiceFailureException - 不明な OAuth エラーが発生した場合。
      • isUserAdmin

        boolean isUserAdmin(java.lang.String scope)
                     throws OAuthRequestException
        ユーザーの代理として行われたリクエストについて、そのユーザーがこのアプリケーションの管理者である場合は true を返し、そうでない場合は false を返します。
        パラメータ:
        scope - 受け入れられるカスタム OAuth スコープ。
        スロー:
        OAuthRequestException - リクエストが有効な OAuth リクエストでなかった場合。
        OAuthServiceFailureException - 不明な OAuth エラーが発生した場合。
        使用開始:
        App Engine 1.7.3。
      • isUserAdmin

        boolean isUserAdmin(java.lang.String... scopes)
                     throws OAuthRequestException
        ユーザーの代理として行われたリクエストについて、そのユーザーがこのアプリケーションの管理者である場合は true を返し、そうでない場合は false を返します。
        パラメータ:
        scopes - そのうち少なくとも 1 つが受け入れられる、複数のカスタム OAuth スコープ。
        スロー:
        OAuthRequestException - リクエストが有効な OAuth リクエストでなかった場合。
        OAuthServiceFailureException - 不明な OAuth エラーが発生した場合。
      • getOAuthConsumerKey

        @Deprecated
        java.lang.String getOAuthConsumerKey()
                                                  throws OAuthRequestException
        サポート終了。 OAuth1 のサポートは終了しました。
        OAuthRequestException がスローされます。
        スロー:
        OAuthRequestException
      • getClientId

        java.lang.String getClientId(java.lang.String... scopes)
                              throws OAuthRequestException
        oauth2 リクエストから client_id を返します。
        パラメータ:
        scopes - そのうち少なくとも 1 つが受け入れられる、複数のカスタム OAuth スコープ。
        スロー:
        OAuthRequestException - リクエストが有効な OAuth2 リクエストでなかった場合。
        OAuthServiceFailureException - 不明な OAuth エラーが発生した場合。
      • getAuthorizedScopes

        java.lang.String[] getAuthorizedScopes(java.lang.String... scopes)
                                        throws OAuthRequestException
        入力スコープから承認されたスコープを返します。
        パラメータ:
        scopes - そのうち少なくとも 1 つが受け入れられる、複数のカスタム OAuth スコープ。
        スロー:
        OAuthRequestException - リクエストが有効な OAuth2 リクエストでなかった場合。
        OAuthServiceFailureException - 不明な OAuth エラーが発生した場合。
このページは役立ちましたか?評価をお願いいたします。

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

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