Skip navigation links
A B C G H K R S T 

A

AccessToken - Interface in com.avaya.collaboration.authorization
Represents a token returned by the Authorization Service to a client.
AccessTokenProvider - Interface in com.avaya.collaboration.authorization
Interface to be implemented by Access Token Providers.
AuthorizationClientHelper - Class in com.avaya.collaboration.authorization
Helper used by clients of the Authorization Service that authenticates the client and returns the granted token.
AuthorizationClientHelper.Builder - Class in com.avaya.collaboration.authorization
Helps in the creation of an instance of AuthorizationClientHelper.
AuthorizationClientHelper.Builder.ClientHelperBuilder - Class in com.avaya.collaboration.authorization
 
AuthorizationClientHelper.Builder.ClientIdBuilder - Class in com.avaya.collaboration.authorization
 
AuthorizationClientHelper.Builder.KeyStoreBuilder - Class in com.avaya.collaboration.authorization
 
AuthorizationClientHelper.Builder.TrustStoreBuilder - Class in com.avaya.collaboration.authorization
 
AuthorizationHelperException - Exception in com.avaya.collaboration.authorization
Exception which indicates error conditions in the Authorization Helper APIs.
AuthorizationHelperException(String) - Constructor for exception com.avaya.collaboration.authorization.AuthorizationHelperException
 
AuthorizationHelperException(String, Throwable) - Constructor for exception com.avaya.collaboration.authorization.AuthorizationHelperException
 

B

build() - Method in class com.avaya.collaboration.authorization.AuthorizationClientHelper.Builder.ClientHelperBuilder
 
Builder() - Constructor for class com.avaya.collaboration.authorization.AuthorizationClientHelper.Builder
 

C

clientIdentifier(String) - Method in class com.avaya.collaboration.authorization.AuthorizationClientHelper.Builder.ClientIdBuilder
 
ClientParams - Class in com.avaya.collaboration.authorization
Holds Authorization and Keystore information specific to the client
ClientParams() - Constructor for class com.avaya.collaboration.authorization.ClientParams
 
com.avaya.collaboration.authorization - package com.avaya.collaboration.authorization
Provides Authorization Client Helper API classes to retrieve access tokens.

G

getAccessToken() - Method in interface com.avaya.collaboration.authorization.AccessTokenProvider
Authenticates the client with the Authorization Service and returns the token.
getAccessToken(List<String>) - Method in interface com.avaya.collaboration.authorization.AccessTokenProvider
Same function as above, but allows client to ask for specific scopes in the request
getAccessToken() - Method in class com.avaya.collaboration.authorization.AuthorizationClientHelper
Authenticates the client with the Authorization Service, obtains an access token and returns it.
getAccessToken(List<String>) - Method in class com.avaya.collaboration.authorization.AuthorizationClientHelper
Authenticates the client with the Authorization Service, obtains an access token and returns it; the client can request for specific scopes during authentication by using the "scopes" parameter.
getAccessToken() - Method in interface com.avaya.collaboration.authorization.TokenAggregate
 
getAccessTokenForUser(String, String) - Method in interface com.avaya.collaboration.authorization.AccessTokenProvider
Authenticates the client and the user with the Authorization Service and returns the token.
getAccessTokenForUser(String, String, List<String>) - Method in interface com.avaya.collaboration.authorization.AccessTokenProvider
Same function as above, but allows client to ask for specific scopes in the request
getAccessTokenForUser(ServletRequest) - Method in interface com.avaya.collaboration.authorization.AccessTokenProvider
 
getAccessTokenForUser(ServletRequest) - Method in class com.avaya.collaboration.authorization.AuthorizationClientHelper
Authenticates the client (along with the user's auth code) with the Authorization Service, obtains an access token and returns it.
getAccessTokenForUser(String, String) - Method in class com.avaya.collaboration.authorization.AuthorizationClientHelper
Authenticates the client and the end user with the Authorization Service, obtains an access token and returns it.
getAccessTokenForUser(String, String, List<String>) - Method in class com.avaya.collaboration.authorization.AuthorizationClientHelper
Authenticates the client and the end user with the Authorization Service, obtains an access token and returns it; the client can request for specific scopes during authentication by using the "scopes" parameter.
getClientId() - Method in class com.avaya.collaboration.authorization.ClientParams
 
getExpiresIn() - Method in interface com.avaya.collaboration.authorization.AccessToken
Returns the number of seconds in which the token will expire.
getKeyAlias() - Method in class com.avaya.collaboration.authorization.ClientParams
 
getKeyStore() - Method in class com.avaya.collaboration.authorization.ClientParams
 
getKeyStorePassword() - Method in class com.avaya.collaboration.authorization.ClientParams
 
getRefreshExpiresIn() - Method in interface com.avaya.collaboration.authorization.RefreshToken
 
getRefreshToken() - Method in interface com.avaya.collaboration.authorization.TokenAggregate
 
getScopes() - Method in interface com.avaya.collaboration.authorization.AccessToken
Returns a list of scopes associated with the token.
getStatusCode() - Method in exception com.avaya.collaboration.authorization.HttpResponseException
Returns the HTTP response status code
getStatusMessage() - Method in exception com.avaya.collaboration.authorization.HttpResponseException
Returns the HTTP response status message
getSubject() - Method in interface com.avaya.collaboration.authorization.AccessToken
Returns the subject of the token.
getTokenAggregate() - Method in interface com.avaya.collaboration.authorization.AccessTokenProvider
 
getTokenAggregate(List<String>) - Method in interface com.avaya.collaboration.authorization.AccessTokenProvider
 
getTokenAggregate(String) - Method in interface com.avaya.collaboration.authorization.AccessTokenProvider
 
getTokenAggregate() - Method in class com.avaya.collaboration.authorization.AuthorizationClientHelper
Authenticates the client with the Authorization Service and obtains a token aggregate.
getTokenAggregate(List<String>) - Method in class com.avaya.collaboration.authorization.AuthorizationClientHelper
Authenticates the client with the Authorization Service, obtains a token aggregate and returns it; the client can request for specific scopes during authentication by using the "scopes" parameter.
getTokenAggregate(String) - Method in class com.avaya.collaboration.authorization.AuthorizationClientHelper
Authenticates the client with the Authorization Service, obtains a token aggregate using a refresh token and returns it.
getTokenAggregateForUser(ServletRequest) - Method in interface com.avaya.collaboration.authorization.AccessTokenProvider
Authenticates the client (along with the user's auth code) with the Authorization Service and returns the token aggregate.
getTokenAggregateForUser(String, String) - Method in interface com.avaya.collaboration.authorization.AccessTokenProvider
Authenticates the client and the user with the Authorization Service and returns the token aggregate.
getTokenAggregateForUser(String, String, List<String>) - Method in interface com.avaya.collaboration.authorization.AccessTokenProvider
Authenticates the client and the user with the Authorization Service and returns the token aggregate.
getTokenAggregateForUser(ServletRequest) - Method in class com.avaya.collaboration.authorization.AuthorizationClientHelper
Authenticates the client (along with the user's auth code) with the Authorization Service, obtains a token aggregate and returns it.
getTokenAggregateForUser(String, String) - Method in class com.avaya.collaboration.authorization.AuthorizationClientHelper
Authenticates the client and the end user with the Authorization Service, obtains a token aggregate and returns it.
getTokenAggregateForUser(String, String, List<String>) - Method in class com.avaya.collaboration.authorization.AuthorizationClientHelper
Authenticates the client and the end user with the Authorization Service, obtains an access token and returns it; the client can request for specific scopes during authentication by using the "scopes" parameter.
getTokenEndpoint() - Method in class com.avaya.collaboration.authorization.ClientParams
 
getTokenType() - Method in interface com.avaya.collaboration.authorization.AccessToken
The token type provides the client with the information required to successfully utilize the access token to make a protected resource request.
getTrustStore() - Method in class com.avaya.collaboration.authorization.ClientParams
 

H

HttpResponseException - Exception in com.avaya.collaboration.authorization
Indicates HTTP error responses propagated by the Authorization Helper APIs.
HttpResponseException(int, String) - Constructor for exception com.avaya.collaboration.authorization.HttpResponseException
 

K

keyStore(KeyStore, String, String) - Method in class com.avaya.collaboration.authorization.AuthorizationClientHelper.Builder.KeyStoreBuilder
 

R

RefreshToken - Interface in com.avaya.collaboration.authorization
Represents a refresh token returned by the Authorization Service to a client.

S

setClientId(String) - Method in class com.avaya.collaboration.authorization.ClientParams
 
setKeyAlias(String) - Method in class com.avaya.collaboration.authorization.ClientParams
 
setKeyStore(KeyStore) - Method in class com.avaya.collaboration.authorization.ClientParams
 
setKeyStorePassword(String) - Method in class com.avaya.collaboration.authorization.ClientParams
 
setTokenEndpoint(String) - Method in class com.avaya.collaboration.authorization.ClientParams
 
setTrustStore(KeyStore) - Method in class com.avaya.collaboration.authorization.ClientParams
 
shutDown() - Method in interface com.avaya.collaboration.authorization.AccessTokenProvider
API to release any system resources associated.
shutdown() - Method in class com.avaya.collaboration.authorization.AuthorizationClientHelper
Shuts down the helper library and releases any system resources associated with it.

T

TokenAggregate - Interface in com.avaya.collaboration.authorization
Represents an aggregation of tokens returned by the Authorization Service to a client.
tokenEndpoint(String) - Method in class com.avaya.collaboration.authorization.AuthorizationClientHelper.Builder
 
trustStore(KeyStore) - Method in class com.avaya.collaboration.authorization.AuthorizationClientHelper.Builder.TrustStoreBuilder
 
A B C G H K R S T 
Skip navigation links

Copyright © 2023 Avaya. All rights reserved.