Class AuthCodeGrantImpl
java.lang.Object
org.glassfish.jersey.client.oauth2.AuthCodeGrantImpl
- All Implemented Interfaces:
OAuth2CodeGrantFlow
Default implementation of
OAuth2CodeGrantFlow
.- Since:
- 2.3
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static class
Builder implementation.(package private) static class
Nested classes/interfaces inherited from interface org.glassfish.jersey.client.oauth2.OAuth2CodeGrantFlow
OAuth2CodeGrantFlow.Phase
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final String
private final String
private final javax.ws.rs.client.Client
private final ClientIdentifier
private final String
private TokenResult
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
AuthCodeGrantImpl
(String authorizationUri, String accessTokenUri, String redirectUri, String refreshTokenUri, ClientIdentifier clientIdentifier, String scope, javax.ws.rs.client.Client client, Map<String, String> authorizationProperties, Map<String, String> accessTokenProperties, Map<String, String> refreshTokenProperties) -
Method Summary
Modifier and TypeMethodDescriptionprivate javax.ws.rs.client.Client
configureClient
(javax.ws.rs.client.Client client) Finish the authorization process and return theTokenResult
.javax.ws.rs.client.Client
Return the client configured for performing authorized requests to the Service Provider.javax.ws.rs.core.Feature
Return theoauth filter feature
that can be used to configureclient
instances to perform authenticated requests to the Service Provider.private void
initDefaultProperties
(String redirectUri, String scope) refreshAccessToken
(String refreshToken) Refresh the access token using a refresh token.private void
start()
Start the authorization process and return redirection URI on which the user should give a consent for our application to access resources.
-
Field Details
-
accessTokenUri
-
authorizationUri
-
refreshTokenUri
-
clientIdentifier
-
client
private final javax.ws.rs.client.Client client -
authorizationProperties
-
accessTokenProperties
-
refreshTokenProperties
-
tokenResult
-
-
Constructor Details
-
AuthCodeGrantImpl
private AuthCodeGrantImpl(String authorizationUri, String accessTokenUri, String redirectUri, String refreshTokenUri, ClientIdentifier clientIdentifier, String scope, javax.ws.rs.client.Client client, Map<String, String> authorizationProperties, Map<String, String> accessTokenProperties, Map<String, String> refreshTokenProperties)
-
-
Method Details
-
configureClient
private javax.ws.rs.client.Client configureClient(javax.ws.rs.client.Client client) -
setDefaultProperty
-
initDefaultProperties
-
start
Description copied from interface:OAuth2CodeGrantFlow
Start the authorization process and return redirection URI on which the user should give a consent for our application to access resources.- Specified by:
start
in interfaceOAuth2CodeGrantFlow
- Returns:
- URI to which user should be redirected.
-
finish
Description copied from interface:OAuth2CodeGrantFlow
Finish the authorization process and return theTokenResult
. The method must be called on the same instance after theOAuth2CodeGrantFlow.start()
method was called and user granted access to this application.The method makes a request to the Authorization Server in order to exchange
code
for access token.- Specified by:
finish
in interfaceOAuth2CodeGrantFlow
- Parameters:
authorizationCode
- Code received from the user authorization process.state
- State received from the user authorization response.- Returns:
- Token result.
-
refreshAccessToken
Description copied from interface:OAuth2CodeGrantFlow
Refresh the access token using a refresh token. This method can be called on newly created instance or on instance on which the authorization flow was already performed.- Specified by:
refreshAccessToken
in interfaceOAuth2CodeGrantFlow
- Parameters:
refreshToken
- Refresh token.- Returns:
- Token result.
-
getAuthorizedClient
public javax.ws.rs.client.Client getAuthorizedClient()Description copied from interface:OAuth2CodeGrantFlow
Return the client configured for performing authorized requests to the Service Provider. The authorization process must be successfully finished by instance by calling methodsOAuth2CodeGrantFlow.start()
andOAuth2CodeGrantFlow.finish(String, String)
.- Specified by:
getAuthorizedClient
in interfaceOAuth2CodeGrantFlow
- Returns:
- Client configured to add correct
Authorization
header to requests.
-
getOAuth2Feature
public javax.ws.rs.core.Feature getOAuth2Feature()Description copied from interface:OAuth2CodeGrantFlow
Return theoauth filter feature
that can be used to configureclient
instances to perform authenticated requests to the Service Provider.The authorization process must be successfully finished by instance by calling methods
OAuth2CodeGrantFlow.start()
andOAuth2CodeGrantFlow.finish(String, String)
.- Specified by:
getOAuth2Feature
in interfaceOAuth2CodeGrantFlow
- Returns:
- oauth filter feature configured with received
AccessToken
.
-