public interface AccessTokenProvider
Modifier and Type | Method and Description |
---|---|
AccessToken |
getAccessToken()
Authenticates the client with the Authorization Service and returns the token.
|
AccessToken |
getAccessToken(List<String> scopes)
Same function as above, but allows client to ask for specific scopes in the request
|
AccessToken |
getAccessTokenForUser(javax.servlet.ServletRequest servletRequest) |
AccessToken |
getAccessTokenForUser(String userName,
String userPassword)
Authenticates the client and the user with the Authorization Service and returns the token.
|
AccessToken |
getAccessTokenForUser(String userName,
String userPassword,
List<String> scopes)
Same function as above, but allows client to ask for specific scopes in the request
|
TokenAggregate |
getTokenAggregate() |
TokenAggregate |
getTokenAggregate(List<String> scopes) |
TokenAggregate |
getTokenAggregate(String refreshToken) |
TokenAggregate |
getTokenAggregateForUser(javax.servlet.ServletRequest servletRequest)
Authenticates the client (along with the user's auth code) with the Authorization Service and returns the token aggregate.
|
TokenAggregate |
getTokenAggregateForUser(String userName,
String userPassword)
Authenticates the client and the user with the Authorization Service and returns the token aggregate.
|
TokenAggregate |
getTokenAggregateForUser(String userName,
String userPassword,
List<String> scopes)
Authenticates the client and the user with the Authorization Service and returns the token aggregate.
|
void |
shutDown()
API to release any system resources associated.
|
AccessToken getAccessToken() throws AuthorizationHelperException, HttpResponseException
AuthorizationHelperException
- Indicates error conditions in the Authorization Helper APIs.HttpResponseException
- Indicates HTTP error responses propagated by the Authorization Helper APIs.AccessToken getAccessToken(List<String> scopes) throws AuthorizationHelperException, HttpResponseException
scopes
- The list of scopes the client wants to specify while making the token request.AuthorizationHelperException
- Indicates error conditions in the Authorization Helper APIs.HttpResponseException
- Indicates HTTP error responses propagated by the Authorization Helper APIs.AccessToken getAccessTokenForUser(String userName, String userPassword) throws AuthorizationHelperException, HttpResponseException
userName
- User nameuserPassword
- User passwordAuthorizationHelperException
- Indicates error conditions in the Authorization Helper APIs.HttpResponseException
- Indicates HTTP error responses propagated by the Authorization Helper APIs.AccessToken getAccessTokenForUser(String userName, String userPassword, List<String> scopes) throws AuthorizationHelperException, HttpResponseException
userName
- User nameuserPassword
- User passwordscopes
- The list of scopes the client wants to specify while making the token request.AuthorizationHelperException
- Indicates error conditions in the Authorization Helper APIs.HttpResponseException
- Indicates HTTP error responses propagated by the Authorization Helper APIs.AccessToken getAccessTokenForUser(javax.servlet.ServletRequest servletRequest) throws AuthorizationHelperException, HttpResponseException
servletRequest
- The ServletRequest which wraps the request made by the browser.HttpResponseException
- Indicates HTTP error responses propagated by the Authorization Helper APIs.AuthorizationHelperException
- Indicates error conditions in the Authorization Helper APIs.void shutDown() throws AuthorizationHelperException
AuthorizationHelperException
- Indicates error conditions in the Authorization Helper APIs.TokenAggregate getTokenAggregate() throws AuthorizationHelperException, HttpResponseException
TokenAggregate
AuthorizationHelperException
- Indicates error conditions in the Authorization Helper APIs.HttpResponseException
- Indicates HTTP error responses propagated by the Authorization Helper APIs.TokenAggregate getTokenAggregate(List<String> scopes) throws AuthorizationHelperException, HttpResponseException
scopes
- The list of scopes the client wants to specify while making the token request.TokenAggregate
AuthorizationHelperException
- Indicates error conditions in the Authorization Helper APIs.HttpResponseException
- Indicates HTTP error responses propagated by the Authorization Helper APIs.TokenAggregate getTokenAggregateForUser(javax.servlet.ServletRequest servletRequest) throws AuthorizationHelperException, HttpResponseException
servletRequest
- The authorization code granted to the user.TokenAggregate
AuthorizationHelperException
- Indicates error conditions in the Authorization Helper APIs.HttpResponseException
- Indicates HTTP error responses propagated by the Authorization Helper APIs.TokenAggregate getTokenAggregateForUser(String userName, String userPassword) throws AuthorizationHelperException, HttpResponseException
userName
- The user name for whom the token is being requested.userPassword
- The user's password.TokenAggregate
AuthorizationHelperException
- Indicates error conditions in the Authorization Helper APIs.HttpResponseException
- Indicates HTTP error responses propagated by the Authorization Helper APIs.TokenAggregate getTokenAggregateForUser(String userName, String userPassword, List<String> scopes) throws AuthorizationHelperException, HttpResponseException
userName
- The user name for whom the token is being requested.userPassword
- The user's password.scopes
- The list of scopes the client wants to specify while making the token request.TokenAggregate
AuthorizationHelperException
- Indicates error conditions in the Authorization Helper APIs.HttpResponseException
- Indicates HTTP error responses propagated by the Authorization Helper APIs.TokenAggregate getTokenAggregate(String refreshToken) throws AuthorizationHelperException, HttpResponseException
refreshToken
- A refresh token obtained previously by the client by calling getTokenAggregate()
or
getTokenAggregate(List)
TokenAggregate
AuthorizationHelperException
- Indicates error conditions in the Authorization Helper APIs.HttpResponseException
- Indicates HTTP error responses propagated by the Authorization Helper APIs.Copyright © 2023 Avaya. All rights reserved.