Package org.glassfish.jersey.client.oauth2

Class AuthCodeGrantImpl.Builder

    • Field Detail

      • accessTokenUri

        private java.lang.String accessTokenUri

      • refreshTokenUri

        private java.lang.String refreshTokenUri

      • authorizationUri

        private java.lang.String authorizationUri

      • callbackUri

        private java.lang.String callbackUri

      • client

        private javax.ws.rs.client.Client client

      • scope

        private java.lang.String scope

      • authorizationProperties

        private java.util.Map<java.lang.String,​java.lang.String> authorizationProperties

      • accessTokenProperties

        private java.util.Map<java.lang.String,​java.lang.String> accessTokenProperties

      • refreshTokenProperties

        private java.util.Map<java.lang.String,​java.lang.String> refreshTokenProperties

    • Constructor Detail

      • Builder

        public Builder()
        Create a new builder.

      • Builder

        public Builder​(ClientIdentifier clientIdentifier,
               java.lang.String authorizationUri,
               java.lang.String accessTokenUri)
        Create a new builder with defined URIs and client id.

      • Builder

        public Builder​(ClientIdentifier clientIdentifier,
               java.lang.String authorizationUri,
               java.lang.String accessTokenUri,
               java.lang.String callbackUri)
        Create a new builder with defined URIs and client id and callback uri.

    • Method Detail

      • accessTokenUri

        public AuthCodeGrantImpl.Builder accessTokenUri​(java.lang.String accessTokenUri)
        Description copied from interface: OAuth2CodeGrantFlow.Builder
        Set the access token URI on which the access token can be requested. The URI points to the authorization server and is defined by the Service Provider.
        Specified by:
        accessTokenUri in interface OAuth2CodeGrantFlow.Builder
        Parameters:
        accessTokenUri - Access token URI.
        Returns:
        Builder instance.

      • authorizationUri

        public AuthCodeGrantImpl.Builder 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
        Parameters:
        authorizationUri - Authorization URI.
        Returns:
        Builder instance.

      • redirectUri

        public AuthCodeGrantImpl.Builder 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
        Parameters:
        redirectUri - URI that should receive authorization response from the Service Provider.
        Returns:
        Builder instance.

      • scope

        public AuthCodeGrantImpl.Builder 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
        Parameters:
        scope - Scope string.
        Returns:
        Builder instance.

      • client

        public AuthCodeGrantImpl.Builder 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
        Parameters:
        client - Client instance.
        Returns:
        Builder instance.

      • refreshTokenUri

        public AuthCodeGrantImpl.Builder 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
        Parameters:
        refreshTokenUri - Refresh token URI.
        Returns:
        Builder instance.

      • getAccessTokenUri

        java.lang.String getAccessTokenUri()

      • getRefreshTokenUri

        java.lang.String getRefreshTokenUri()

      • getAuthorizationUri

        java.lang.String getAuthorizationUri()

      • getScope

        java.lang.String getScope()

      • getCallbackUri

        java.lang.String getCallbackUri()

      • getClient

        javax.ws.rs.client.Client getClient()

      • getAuthorizationProperties

        java.util.Map<java.lang.String,​java.lang.String> getAuthorizationProperties()

      • getAccessTokenProperties

        java.util.Map<java.lang.String,​java.lang.String> getAccessTokenProperties()

      • getRefreshTokenProperties

        java.util.Map<java.lang.String,​java.lang.String> getRefreshTokenProperties()