Class AbstractAuthorizationCodeGrantBuilder<T extends OAuth2CodeGrantFlow.Builder>

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      T accessTokenUri​(java.lang.String accessTokenUri)
      Set the access token URI on which the access token can be requested.
      T authorizationUri​(java.lang.String authorizationUri)
      Set the URI to which the user should be redirected to authorize our application.
      OAuth2CodeGrantFlow build()
      Build the OAuth2CodeGrantFlow instance.
      T client​(javax.ws.rs.client.Client client)
      Set the client that should be used internally by the OAuth1AuthorizationFlow to make requests to Authorization Server.
      T clientIdentifier​(ClientIdentifier consumerCredentials)
      Set client identifier of the application that should be authorized.
      T property​(OAuth2CodeGrantFlow.Phase phase, java.lang.String key, java.lang.String value)
      Set property (parameter) that will be added to requests or URIs as a query parameters during the Authorization Flow.
      T redirectUri​(java.lang.String redirectUri)
      Set the redirect URI to which the user (resource owner) should be redirected after he/she grants access to our application.
      T refreshTokenUri​(java.lang.String refreshTokenUri)
      Set the refresh token URI on which the access token can be refreshed using a refresh token.
      T scope​(java.lang.String scope)
      Set a scope to which the application will get authorization grant.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • authorizationUri

        public T authorizationUri​(java.lang.String authorizationUri)
        Description copied from interface: OAuth2CodeGrantFlow.Builder
        Set the URI to which the user should be redirected to authorize our application. The URI points to the authorization server and is defined by the Service Provider.
        Specified by:
        authorizationUri in interface OAuth2CodeGrantFlow.Builder<T extends OAuth2CodeGrantFlow.Builder>
        Parameters:
        authorizationUri - Authorization URI.
        Returns:
        Builder instance.
      • redirectUri

        public T redirectUri​(java.lang.String redirectUri)
        Description copied from interface: OAuth2CodeGrantFlow.Builder
        Set the redirect URI to which the user (resource owner) should be redirected after he/she grants access to our application. In most cases, the URI is under control of this application and request done on this URI will be used to extract query parameter code and state that will be used in OAuth2CodeGrantFlow.finish(String, String) method.

        If URI is not defined by this method, the default value urn:ietf:wg:oauth:2.0:oob will be used in the Authorization Flow which should cause that code will be passed to application in other way than request redirection (for example shown to the user using html page).

        Specified by:
        redirectUri in interface OAuth2CodeGrantFlow.Builder<T extends OAuth2CodeGrantFlow.Builder>
        Parameters:
        redirectUri - URI that should receive authorization response from the Service Provider.
        Returns:
        Builder instance.
      • scope

        public T scope​(java.lang.String scope)
        Description copied from interface: OAuth2CodeGrantFlow.Builder
        Set a scope to which the application will get authorization grant. Values of this parameter are defined by the Service Provider and defines usually subset of resource and operations available in the Service Provider.

        The parameter is optional but ServiceProvider might require it.

        Specified by:
        scope in interface OAuth2CodeGrantFlow.Builder<T extends OAuth2CodeGrantFlow.Builder>
        Parameters:
        scope - Scope string.
        Returns:
        Builder instance.
      • client

        public T client​(javax.ws.rs.client.Client client)
        Description copied from interface: OAuth2CodeGrantFlow.Builder
        Set the client that should be used internally by the OAuth1AuthorizationFlow to make requests to Authorization Server. If this method is not called, it is up to the implementation to create or get any private client instance to perform these requests. This method could be used mainly for performance reasons to avoid creation of new client instances and have control about created client instances used in the application.
        Specified by:
        client in interface OAuth2CodeGrantFlow.Builder<T extends OAuth2CodeGrantFlow.Builder>
        Parameters:
        client - Client instance.
        Returns:
        Builder instance.
      • refreshTokenUri

        public T refreshTokenUri​(java.lang.String refreshTokenUri)
        Description copied from interface: OAuth2CodeGrantFlow.Builder
        Set the refresh token URI on which the access token can be refreshed using a refresh token. The URI points to the authorization server and is defined by the Service Provider. If the URI is not defined by this method it will be the same as URI defined in OAuth2CodeGrantFlow.Builder.accessTokenUri(String) (which is the default value defined by the OAuth2 spec). Some providers do not support refreshing access tokens at all.
        Specified by:
        refreshTokenUri in interface OAuth2CodeGrantFlow.Builder<T extends OAuth2CodeGrantFlow.Builder>
        Parameters:
        refreshTokenUri - Refresh token URI.
        Returns:
        Builder instance.