Index (token-client 2.12.2 API)

A B C D E G H I M O P R S T U V W X Z

A

AbstractOAuth2TokenService - Class in com.sap.cloud.security.xsuaa.client
AbstractOAuth2TokenService() - Constructor for class com.sap.cloud.security.xsuaa.client.AbstractOAuth2TokenService
AbstractOAuth2TokenService(TokenCacheConfiguration) - Constructor for class com.sap.cloud.security.xsuaa.client.AbstractOAuth2TokenService: Constructor used to overwrite the default cache configuration.
ACCEPT - Static variable in class com.sap.cloud.security.xsuaa.http.HttpHeaders
ACCESS_TOKEN - Static variable in class com.sap.cloud.security.xsuaa.client.OAuth2TokenServiceConstants
assertHasText(String, String) - Static method in class com.sap.cloud.security.xsuaa.Assertions
ASSERTION - Static variable in class com.sap.cloud.security.xsuaa.client.OAuth2TokenServiceConstants
Assertions - Class in com.sap.cloud.security.xsuaa
assertNotEmpty(List<?>, String) - Static method in class com.sap.cloud.security.xsuaa.Assertions
assertNotNull(Object, String) - Static method in class com.sap.cloud.security.xsuaa.Assertions
attributes(Map<String, String>) - Method in class com.sap.cloud.security.xsuaa.tokenflows.ClientCredentialsTokenFlow: Adds additional authorization attributes to the request.
attributes(Map<String, String>) - Method in class com.sap.cloud.security.xsuaa.tokenflows.UserTokenFlow: Adds additional authorization attributes to the request.
AUTHORITIES - Static variable in class com.sap.cloud.security.xsuaa.client.OAuth2TokenServiceConstants
AUTHORIZATION - Static variable in class com.sap.cloud.security.xsuaa.http.HttpHeaders

B

Base64JwtDecoder - Class in com.sap.cloud.security.xsuaa.jwt
Base64JwtDecoder() - Constructor for class com.sap.cloud.security.xsuaa.jwt.Base64JwtDecoder: Deprecated.
in favor of the method and will become private with version 3.0.0
build() - Method in class com.sap.cloud.security.xsuaa.client.OAuth2ServiceException.Builder
builder(String) - Static method in exception com.sap.cloud.security.xsuaa.client.OAuth2ServiceException: Creates an exception.
Builder(String) - Constructor for class com.sap.cloud.security.xsuaa.client.OAuth2ServiceException.Builder

C

Cacheable - Interface in com.sap.cloud.security.xsuaa.tokenflows: Interface for components that manage a cache configured with CacheConfiguration.
cacheDisabled() - Static method in class com.sap.cloud.security.xsuaa.tokenflows.TokenCacheConfiguration: The default cache configuration.
clearCache() - Method in class com.sap.cloud.security.xsuaa.client.AbstractOAuth2TokenService
clearCache() - Method in interface com.sap.cloud.security.xsuaa.tokenflows.Cacheable: Clears the cache of the component.
CLIENT_ID - Static variable in class com.sap.cloud.security.xsuaa.client.OAuth2TokenServiceConstants
CLIENT_SECRET - Static variable in class com.sap.cloud.security.xsuaa.client.OAuth2TokenServiceConstants
ClientCredentials - Class in com.sap.cloud.security.xsuaa.client: Deprecated.
ClientCredentials(String, String) - Constructor for class com.sap.cloud.security.xsuaa.client.ClientCredentials: Deprecated.

Specifies the OAuth 2.0 client.
ClientCredentialsTokenFlow - Class in com.sap.cloud.security.xsuaa.tokenflows: A client credentials flow builder class.
clientCredentialsTokenFlow() - Method in class com.sap.cloud.security.xsuaa.tokenflows.XsuaaTokenFlows: Creates a new Client Credentials Flow builder object.
com.sap.cloud.security.client - package com.sap.cloud.security.client
com.sap.cloud.security.mtls - package com.sap.cloud.security.mtls
com.sap.cloud.security.xsuaa - package com.sap.cloud.security.xsuaa
com.sap.cloud.security.xsuaa.client - package com.sap.cloud.security.xsuaa.client
com.sap.cloud.security.xsuaa.http - package com.sap.cloud.security.xsuaa.http
com.sap.cloud.security.xsuaa.jwt - package com.sap.cloud.security.xsuaa.jwt
com.sap.cloud.security.xsuaa.tokenflows - package com.sap.cloud.security.xsuaa.tokenflows
com.sap.cloud.security.xsuaa.util - package com.sap.cloud.security.xsuaa.util
CONTENT_TYPE - Static variable in class com.sap.cloud.security.xsuaa.http.HttpHeaders
create(ClientIdentity) - Static method in interface com.sap.cloud.security.client.HttpClientFactory: Don't close the HTTPClient when you've provided it to TokenAuthenticator or XsuaaTokenFlows instance.
create(String, String) - Method in class com.sap.cloud.security.mtls.SSLContextFactory: Creates a SSLContext which can be used to parameterize your Rest client, in order to support mutual TLS.
create(ClientIdentity) - Method in class com.sap.cloud.security.mtls.SSLContextFactory: Creates a SSLContext which can be used to parameterize your Rest client, in order to support mutual TLS.
createClient(ClientIdentity) - Method in class com.sap.cloud.security.client.DefaultHttpClientFactory
createClient(ClientIdentity) - Method in interface com.sap.cloud.security.client.HttpClientFactory: Provides CloseableHttpClient based on ClientIdentity details.
createKeyStore(ClientIdentity) - Method in class com.sap.cloud.security.mtls.SSLContextFactory: Initializes a KeyStore which can be used to parameterize your Rest client, in order to support mutual TLS.
createWithAuthorizationBearerHeader(String) - Static method in class com.sap.cloud.security.xsuaa.http.HttpHeadersFactory: Adds the Authorization: Bearer <token> header to the set of headers.
createWithoutAuthorizationHeader() - Static method in class com.sap.cloud.security.xsuaa.http.HttpHeadersFactory: Creates the set of HTTP headers with client-credentials basic authentication header.

D

decode(String) - Method in class com.sap.cloud.security.xsuaa.jwt.Base64JwtDecoder: Decodes the Json Web token (jwt).
DecodedJwt - Interface in com.sap.cloud.security.xsuaa.jwt: A Jwt token consists of three parts, separated by ".": header.payload.signature Use Base64JwtDecoder.getInstance().decode(token) to get a DecodedJwt instance.
DEFAULT_HTTP_CLIENT_FACTORY - Static variable in interface com.sap.cloud.security.client.HttpClientFactory
defaultConfiguration() - Static method in class com.sap.cloud.security.xsuaa.tokenflows.TokenCacheConfiguration: A special cache configuration used to disable caching.
DefaultHttpClientFactory - Class in com.sap.cloud.security.client: Creates a CloseableHttpClient instance.
DefaultHttpClientFactory() - Constructor for class com.sap.cloud.security.client.DefaultHttpClientFactory
DefaultOAuth2TokenKeyService - Class in com.sap.cloud.security.xsuaa.client
DefaultOAuth2TokenKeyService() - Constructor for class com.sap.cloud.security.xsuaa.client.DefaultOAuth2TokenKeyService
DefaultOAuth2TokenKeyService(CloseableHttpClient) - Constructor for class com.sap.cloud.security.xsuaa.client.DefaultOAuth2TokenKeyService
DefaultOAuth2TokenService - Class in com.sap.cloud.security.xsuaa.client
DefaultOAuth2TokenService() - Constructor for class com.sap.cloud.security.xsuaa.client.DefaultOAuth2TokenService: Deprecated.
in favor of DefaultOAuth2TokenService(CloseableHttpClient) as it doesn't support certificate based communication. Will be deleted with version 3.0.0.
DefaultOAuth2TokenService(CloseableHttpClient) - Constructor for class com.sap.cloud.security.xsuaa.client.DefaultOAuth2TokenService
DefaultOAuth2TokenService(TokenCacheConfiguration) - Constructor for class com.sap.cloud.security.xsuaa.client.DefaultOAuth2TokenService: Deprecated.
in favor of DefaultOAuth2TokenService(CloseableHttpClient, TokenCacheConfiguration) as it doesn't support certificate based communication. Will be deleted with version 3.0.0.
DefaultOAuth2TokenService(CloseableHttpClient, TokenCacheConfiguration) - Constructor for class com.sap.cloud.security.xsuaa.client.DefaultOAuth2TokenService
DefaultOidcConfigurationService - Class in com.sap.cloud.security.xsuaa.client: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationRequest
DefaultOidcConfigurationService() - Constructor for class com.sap.cloud.security.xsuaa.client.DefaultOidcConfigurationService
DefaultOidcConfigurationService(CloseableHttpClient) - Constructor for class com.sap.cloud.security.xsuaa.client.DefaultOidcConfigurationService
disableCache(boolean) - Method in class com.sap.cloud.security.xsuaa.tokenflows.ClientCredentialsTokenFlow: Can be used to disable the cache for the flow.
disableCache(boolean) - Method in class com.sap.cloud.security.xsuaa.tokenflows.PasswordTokenFlow: Can be used to disable the cache for the flow.
disableCache(boolean) - Method in class com.sap.cloud.security.xsuaa.tokenflows.RefreshTokenFlow: Can be used to disable the cache for the flow.
disableCache(boolean) - Method in class com.sap.cloud.security.xsuaa.tokenflows.UserTokenFlow: Can be used to disable the cache for the flow.
DISCOVERY_ENDPOINT_DEFAULT - Static variable in interface com.sap.cloud.security.xsuaa.client.OidcConfigurationService

E

equals(Object) - Method in class com.sap.cloud.security.xsuaa.http.HttpHeader
equals(Object) - Method in class com.sap.cloud.security.xsuaa.http.HttpHeaders
equals(Object) - Method in class com.sap.cloud.security.xsuaa.tokenflows.TokenCacheConfiguration
execute() - Method in class com.sap.cloud.security.xsuaa.tokenflows.ClientCredentialsTokenFlow: Executes the token flow and returns a JWT token from XSUAA.
execute() - Method in class com.sap.cloud.security.xsuaa.tokenflows.PasswordTokenFlow: Executes this flow against the XSUAA endpoint.
execute() - Method in class com.sap.cloud.security.xsuaa.tokenflows.RefreshTokenFlow: Executes the refresh token flow against XSUAA.
execute() - Method in class com.sap.cloud.security.xsuaa.tokenflows.UserTokenFlow: Executes this flow against the XSUAA endpoint.
expandPath(URI, String) - Static method in class com.sap.cloud.security.xsuaa.util.UriUtil: Utility method that expands the path of the URI.
EXPIRES_IN - Static variable in class com.sap.cloud.security.xsuaa.client.OAuth2TokenServiceConstants
extractResponseBodyAsString(HttpResponse) - Static method in class com.sap.cloud.security.xsuaa.util.HttpClientUtil

G

getAccessToken() - Method in class com.sap.cloud.security.xsuaa.client.OAuth2TokenResponse: An OAuth2 access token.
getAuthorizeEndpoint() - Method in interface com.sap.cloud.security.xsuaa.client.OAuth2ServiceEndpointsProvider: Returns authorize endpoint URI.
getAuthorizeEndpoint() - Method in class com.sap.cloud.security.xsuaa.client.XsuaaDefaultEndpoints
getCacheConfiguration() - Method in class com.sap.cloud.security.xsuaa.client.AbstractOAuth2TokenService
getCacheConfiguration() - Method in interface com.sap.cloud.security.xsuaa.tokenflows.Cacheable: Provides the cache configuration of the component.
getCacheDuration() - Method in class com.sap.cloud.security.xsuaa.tokenflows.TokenCacheConfiguration
getCacheSize() - Method in class com.sap.cloud.security.xsuaa.tokenflows.TokenCacheConfiguration
getCacheStatistics() - Method in class com.sap.cloud.security.xsuaa.client.AbstractOAuth2TokenService
getCacheStatistics() - Method in interface com.sap.cloud.security.xsuaa.tokenflows.Cacheable: This returns an implementation specific statistics object if the underlying cache supports it and cache statistics have been enabled in the CacheConfiguration.
getClock() - Method in class com.sap.cloud.security.xsuaa.client.AbstractOAuth2TokenService: By default Clock.systemUTC() is used to determine of a cached token has reached its expiration (exp) point in time.
getDecodedAccessToken() - Method in class com.sap.cloud.security.xsuaa.client.OAuth2TokenResponse: A decoded OAuth2 access token.
getDiscoveryEndpointUri(String) - Static method in class com.sap.cloud.security.xsuaa.client.DefaultOidcConfigurationService
getEncodedToken() - Method in interface com.sap.cloud.security.xsuaa.jwt.DecodedJwt: Get the original encoded access token.
getExpiredAt() - Method in class com.sap.cloud.security.xsuaa.client.OAuth2TokenResponse: Returns the moment in time when the token will be expired.
getExpiredAtDate() - Method in class com.sap.cloud.security.xsuaa.client.OAuth2TokenResponse: Deprecated.
use OAuth2TokenResponse.getExpiredAt().
getHeader() - Method in interface com.sap.cloud.security.xsuaa.jwt.DecodedJwt: Get the base64 decoded header of the jwt as UTF-8 String.
getHeaders() - Method in class com.sap.cloud.security.xsuaa.http.HttpHeaders
getHttpStatusCode() - Method in exception com.sap.cloud.security.xsuaa.client.OAuth2ServiceException: Returns the HTTP status code of the failed OAuth2 service request or 0 e.g.
getInstance() - Static method in class com.sap.cloud.security.mtls.SSLContextFactory
getInstance() - Static method in class com.sap.cloud.security.xsuaa.jwt.Base64JwtDecoder
getInstance(Duration, int, Duration) - Static method in class com.sap.cloud.security.xsuaa.tokenflows.TokenCacheConfiguration: Creates a new TokenCacheConfiguration instance with the given properties.
getInstance(Duration, int, Duration, boolean) - Static method in class com.sap.cloud.security.xsuaa.tokenflows.TokenCacheConfiguration: Creates a new TokenCacheConfiguration instance with the given properties.
getJwksUri() - Method in interface com.sap.cloud.security.xsuaa.client.OAuth2ServiceEndpointsProvider: Returns Jwt Key Set URI (JWKS) as specified in /.well-known/openid-configuration.
getJwksUri() - Method in class com.sap.cloud.security.xsuaa.client.XsuaaDefaultEndpoints
getName() - Method in class com.sap.cloud.security.xsuaa.http.HttpHeader
getPayload() - Method in interface com.sap.cloud.security.xsuaa.jwt.DecodedJwt: Get the base64 decoded payload of the jwt as UTF-8 String.
getRefreshToken() - Method in class com.sap.cloud.security.xsuaa.client.OAuth2TokenResponse: An OAuth2 refresh token.
getSignature() - Method in interface com.sap.cloud.security.xsuaa.jwt.DecodedJwt: Get the encoded signature of the jwt.
getTokenEndpoint() - Method in interface com.sap.cloud.security.xsuaa.client.OAuth2ServiceEndpointsProvider: Returns token endpoint URI.
getTokenEndpoint() - Method in class com.sap.cloud.security.xsuaa.client.XsuaaDefaultEndpoints
getTokenExpirationDelta() - Method in class com.sap.cloud.security.xsuaa.tokenflows.TokenCacheConfiguration: If a cached token expires because its expiration time (exp) has been reached, it should not be retrieved from the cache.
getTokenType() - Method in class com.sap.cloud.security.xsuaa.client.OAuth2TokenResponse
getValue() - Method in class com.sap.cloud.security.xsuaa.http.HttpHeader
GRANT_TYPE - Static variable in class com.sap.cloud.security.xsuaa.client.OAuth2TokenServiceConstants
GRANT_TYPE_AUTHORIZATION_CODE - Static variable in class com.sap.cloud.security.xsuaa.client.OAuth2TokenServiceConstants
GRANT_TYPE_CLIENT_CREDENTIALS - Static variable in class com.sap.cloud.security.xsuaa.client.OAuth2TokenServiceConstants
GRANT_TYPE_CLIENT_X509 - Static variable in class com.sap.cloud.security.xsuaa.client.OAuth2TokenServiceConstants: Deprecated.
SAP proprietary grant type.
GRANT_TYPE_JWT_BEARER - Static variable in class com.sap.cloud.security.xsuaa.client.OAuth2TokenServiceConstants
GRANT_TYPE_PASSWORD - Static variable in class com.sap.cloud.security.xsuaa.client.OAuth2TokenServiceConstants
GRANT_TYPE_REFRESH_TOKEN - Static variable in class com.sap.cloud.security.xsuaa.client.OAuth2TokenServiceConstants
GRANT_TYPE_USER_TOKEN - Static variable in class com.sap.cloud.security.xsuaa.client.OAuth2TokenServiceConstants: Deprecated.
in favor of OAuth2TokenServiceConstants.GRANT_TYPE_JWT_BEARER.

H

hashCode() - Method in class com.sap.cloud.security.xsuaa.http.HttpHeader
hashCode() - Method in class com.sap.cloud.security.xsuaa.http.HttpHeaders
hashCode() - Method in class com.sap.cloud.security.xsuaa.tokenflows.TokenCacheConfiguration
HttpClientException - Exception in com.sap.cloud.security.client: Thrown to signal issues during a http client initialization.
HttpClientException(String) - Constructor for exception com.sap.cloud.security.client.HttpClientException: Instantiates a new Service client exception.
HttpClientFactory - Interface in com.sap.cloud.security.client: Represents a CloseableHttpClient creation interface.
HttpClientUtil - Class in com.sap.cloud.security.xsuaa.util
HttpHeader - Class in com.sap.cloud.security.xsuaa.http
HttpHeader(String, String) - Constructor for class com.sap.cloud.security.xsuaa.http.HttpHeader
HttpHeaders - Class in com.sap.cloud.security.xsuaa.http
HttpHeaders(HttpHeader...) - Constructor for class com.sap.cloud.security.xsuaa.http.HttpHeaders
HttpHeaders(Collection<HttpHeader>) - Constructor for class com.sap.cloud.security.xsuaa.http.HttpHeaders
HttpHeadersFactory - Class in com.sap.cloud.security.xsuaa.http

I

isCacheStatisticsEnabled() - Method in class com.sap.cloud.security.xsuaa.tokenflows.TokenCacheConfiguration

M

MediaType - Enum in com.sap.cloud.security.xsuaa.http

O

OAuth2ServiceEndpointsProvider - Interface in com.sap.cloud.security.xsuaa.client
OAuth2ServiceException - Exception in com.sap.cloud.security.xsuaa.client: Exception thrown to signal issues during communication with OAuth2 server.
OAuth2ServiceException(String) - Constructor for exception com.sap.cloud.security.xsuaa.client.OAuth2ServiceException
OAuth2ServiceException(String, Integer) - Constructor for exception com.sap.cloud.security.xsuaa.client.OAuth2ServiceException: Creates an exception.
OAuth2ServiceException.Builder - Class in com.sap.cloud.security.xsuaa.client
OAuth2TokenKeyService - Interface in com.sap.cloud.security.xsuaa.client: Service that targets Identity service (xsuaa and identity) to request Json Web Keys.
OAuth2TokenResponse - Class in com.sap.cloud.security.xsuaa.client
OAuth2TokenResponse(String, long, String) - Constructor for class com.sap.cloud.security.xsuaa.client.OAuth2TokenResponse
OAuth2TokenResponse(String, long, String, String) - Constructor for class com.sap.cloud.security.xsuaa.client.OAuth2TokenResponse
OAuth2TokenService - Interface in com.sap.cloud.security.xsuaa.client: Retrieves OAuth2 Access Tokens as documented here: https://docs.cloudfoundry.org/api/uaa/version/4.31.0/index.html#token
OAuth2TokenServiceConstants - Class in com.sap.cloud.security.xsuaa.client
OidcConfigurationService - Interface in com.sap.cloud.security.xsuaa.client
optionalParameters(Map<String, String>) - Method in class com.sap.cloud.security.xsuaa.tokenflows.PasswordTokenFlow: Adds additional authorization attributes to the request.

P

PARAMETER_CLIENT_ID - Static variable in class com.sap.cloud.security.xsuaa.client.OAuth2TokenServiceConstants
PASSWORD - Static variable in class com.sap.cloud.security.xsuaa.client.OAuth2TokenServiceConstants
password(String) - Method in class com.sap.cloud.security.xsuaa.tokenflows.PasswordTokenFlow: The password for the user trying to get a token.
PasswordTokenFlow - Class in com.sap.cloud.security.xsuaa.tokenflows
PasswordTokenFlow(OAuth2TokenService, OAuth2ServiceEndpointsProvider, ClientIdentity) - Constructor for class com.sap.cloud.security.xsuaa.tokenflows.PasswordTokenFlow
passwordTokenFlow() - Method in class com.sap.cloud.security.xsuaa.tokenflows.XsuaaTokenFlows: Creates a new Refresh Token Flow builder object.
Token, authorize and key set endpoints will be derived relative to the base URI.

R

REFRESH_TOKEN - Static variable in class com.sap.cloud.security.xsuaa.client.OAuth2TokenServiceConstants
refreshToken(String) - Method in class com.sap.cloud.security.xsuaa.tokenflows.RefreshTokenFlow: Sets the mandatory refresh token to be exchanged for a (refreshed) JWT.
RefreshTokenFlow - Class in com.sap.cloud.security.xsuaa.tokenflows: A refresh token flow builder.
refreshTokenFlow() - Method in class com.sap.cloud.security.xsuaa.tokenflows.XsuaaTokenFlows: Creates a new Refresh Token Flow builder object.
Token, authorize and key set endpoints will be derived relative to the base URI.
replaceSubdomain(URI, String) - Static method in class com.sap.cloud.security.xsuaa.util.UriUtil: Utility method that replaces the subdomain of the URI with the given subdomain.
requestAccessToken(URI, HttpHeaders, Map<String, String>) - Method in class com.sap.cloud.security.xsuaa.client.AbstractOAuth2TokenService: Implements the HTTP client specific logic to perform an HTTP request and handle the response.
requestAccessToken(URI, HttpHeaders, Map<String, String>) - Method in class com.sap.cloud.security.xsuaa.client.DefaultOAuth2TokenService
requestAccessToken(URI, HttpHeaders, Map<String, String>) - Method in class com.sap.cloud.security.xsuaa.client.XsuaaOAuth2TokenService
retrieveAccessTokenViaClientCredentialsGrant(URI, ClientIdentity, String, String, Map<String, String>, boolean) - Method in class com.sap.cloud.security.xsuaa.client.AbstractOAuth2TokenService
retrieveAccessTokenViaClientCredentialsGrant(URI, ClientIdentity, String, Map<String, String>, boolean) - Method in interface com.sap.cloud.security.xsuaa.client.OAuth2TokenService: Deprecated.
gets removed in favor of OAuth2TokenService.retrieveAccessTokenViaClientCredentialsGrant(URI, ClientIdentity, String, String, Map, boolean) with next major version 3.0.0
retrieveAccessTokenViaClientCredentialsGrant(URI, ClientIdentity, String, String, Map<String, String>, boolean) - Method in interface com.sap.cloud.security.xsuaa.client.OAuth2TokenService: Requests access token from OAuth Server with client credentials.
retrieveAccessTokenViaClientCredentialsGrant(URI, ClientIdentity, String, Map<String, String>) - Method in interface com.sap.cloud.security.xsuaa.client.OAuth2TokenService: Deprecated.
gets removed in favor of OAuth2TokenService.retrieveAccessTokenViaClientCredentialsGrant(URI, ClientIdentity, String, Map, boolean) with next major version 3.0.0
retrieveAccessTokenViaJwtBearerTokenGrant(URI, ClientIdentity, String, String, Map<String, String>, boolean) - Method in class com.sap.cloud.security.xsuaa.client.AbstractOAuth2TokenService
retrieveAccessTokenViaJwtBearerTokenGrant(URI, ClientIdentity, String, Map<String, String>, boolean, String) - Method in class com.sap.cloud.security.xsuaa.client.AbstractOAuth2TokenService
retrieveAccessTokenViaJwtBearerTokenGrant(URI, ClientIdentity, String, String, Map<String, String>, boolean) - Method in interface com.sap.cloud.security.xsuaa.client.OAuth2TokenService
retrieveAccessTokenViaJwtBearerTokenGrant(URI, ClientIdentity, String, String, Map<String, String>) - Method in interface com.sap.cloud.security.xsuaa.client.OAuth2TokenService: Deprecated.
gets removed in favor of OAuth2TokenService.retrieveAccessTokenViaJwtBearerTokenGrant(URI, ClientIdentity, String, String, Map, boolean) with next major version 3.0.0
retrieveAccessTokenViaJwtBearerTokenGrant(URI, ClientIdentity, String, Map<String, String>, boolean, String) - Method in interface com.sap.cloud.security.xsuaa.client.OAuth2TokenService
retrieveAccessTokenViaPasswordGrant(URI, ClientIdentity, String, String, String, Map<String, String>, boolean) - Method in class com.sap.cloud.security.xsuaa.client.AbstractOAuth2TokenService
retrieveAccessTokenViaPasswordGrant(URI, ClientIdentity, String, String, String, Map<String, String>, boolean) - Method in interface com.sap.cloud.security.xsuaa.client.OAuth2TokenService: Requests access token from OAuth Server with user / password.
retrieveAccessTokenViaPasswordGrant(URI, ClientIdentity, String, String, String, Map<String, String>) - Method in interface com.sap.cloud.security.xsuaa.client.OAuth2TokenService: Deprecated.
gets removed in favor of OAuth2TokenService.retrieveAccessTokenViaPasswordGrant(URI, ClientIdentity, String, String, String, Map, boolean) with next major version 3.0.0
retrieveAccessTokenViaRefreshToken(URI, ClientIdentity, String, String, boolean) - Method in class com.sap.cloud.security.xsuaa.client.AbstractOAuth2TokenService
retrieveAccessTokenViaRefreshToken(URI, ClientIdentity, String, String, boolean) - Method in interface com.sap.cloud.security.xsuaa.client.OAuth2TokenService: Requests access token from OAuth Server with refresh-token.
retrieveAccessTokenViaRefreshToken(URI, ClientIdentity, String, String) - Method in interface com.sap.cloud.security.xsuaa.client.OAuth2TokenService: Deprecated.
gets removed in favor of OAuth2TokenService.retrieveAccessTokenViaRefreshToken(URI, ClientIdentity, String, String, boolean) with next major version 3.0.0
retrieveAccessTokenViaUserTokenGrant(URI, ClientIdentity, String, String, Map<String, String>) - Method in class com.sap.cloud.security.xsuaa.client.AbstractOAuth2TokenService
retrieveAccessTokenViaUserTokenGrant(URI, ClientIdentity, String, String, Map<String, String>) - Method in interface com.sap.cloud.security.xsuaa.client.OAuth2TokenService: Deprecated.
instead use jwt bearer {OAuth2TokenService.retrieveAccessTokenViaJwtBearerTokenGrant(URI, ClientIdentity, String, String, Map)}.
retrieveEndpoints(URI) - Method in class com.sap.cloud.security.xsuaa.client.DefaultOidcConfigurationService
retrieveEndpoints(URI) - Method in interface com.sap.cloud.security.xsuaa.client.OidcConfigurationService: Requests an OpenID Provider Configuration Document from OAuth Server.
retrieveEndpoints(URI) - Method in class com.sap.cloud.security.xsuaa.client.SpringOidcConfigurationService
retrieveTokenKeys(URI, String) - Method in class com.sap.cloud.security.xsuaa.client.DefaultOAuth2TokenKeyService
retrieveTokenKeys(URI) - Method in interface com.sap.cloud.security.xsuaa.client.OAuth2TokenKeyService: Deprecated.
gets removed in favor of OAuth2TokenKeyService.retrieveTokenKeys(URI, String) with next major version 3.0.0
retrieveTokenKeys(URI, String) - Method in interface com.sap.cloud.security.xsuaa.client.OAuth2TokenKeyService: Requests token web key set from OAuth Server.
retrieveTokenKeys(URI, String) - Method in class com.sap.cloud.security.xsuaa.client.SpringOAuth2TokenKeyService

S

SCOPE - Static variable in class com.sap.cloud.security.xsuaa.client.OAuth2TokenServiceConstants
scopes(String...) - Method in class com.sap.cloud.security.xsuaa.tokenflows.ClientCredentialsTokenFlow: Sets the scope attribute for the token request.
scopes(String...) - Method in class com.sap.cloud.security.xsuaa.tokenflows.UserTokenFlow: Sets the scope attribute for the token request.
services - Static variable in interface com.sap.cloud.security.client.HttpClientFactory
SpringOAuth2TokenKeyService - Class in com.sap.cloud.security.xsuaa.client
SpringOAuth2TokenKeyService(RestOperations) - Constructor for class com.sap.cloud.security.xsuaa.client.SpringOAuth2TokenKeyService
SpringOidcConfigurationService - Class in com.sap.cloud.security.xsuaa.client
SpringOidcConfigurationService(RestOperations) - Constructor for class com.sap.cloud.security.xsuaa.client.SpringOidcConfigurationService
SSLContextFactory - Class in com.sap.cloud.security.mtls: Creates a SSLContext (without Bouncy Castle crypto lib).
subdomain(String) - Method in class com.sap.cloud.security.xsuaa.tokenflows.ClientCredentialsTokenFlow: Sets the subdomain (tenant) the token is requested for.
subdomain(String) - Method in class com.sap.cloud.security.xsuaa.tokenflows.PasswordTokenFlow: Set the Subdomain the token is requested for.
subdomain(String) - Method in class com.sap.cloud.security.xsuaa.tokenflows.RefreshTokenFlow: Sets the subdomain (tenant) the token is requested for.
subdomain(String) - Method in class com.sap.cloud.security.xsuaa.tokenflows.UserTokenFlow: Sets the subdomain (tenant) the token is requested for.

T

token(String) - Method in class com.sap.cloud.security.xsuaa.tokenflows.UserTokenFlow: Sets the JWT token that should be exchanged for another JWT token.
token(Token) - Method in class com.sap.cloud.security.xsuaa.tokenflows.UserTokenFlow: Sets the JWT token that should be exchanged for another JWT token.
TOKEN_TYPE - Static variable in class com.sap.cloud.security.xsuaa.client.OAuth2TokenServiceConstants
TOKEN_TYPE_OPAQUE - Static variable in class com.sap.cloud.security.xsuaa.client.OAuth2TokenServiceConstants
TokenCacheConfiguration - Class in com.sap.cloud.security.xsuaa.tokenflows: Data class to capture configuration options of token caches.
TokenFlowException - Exception in com.sap.cloud.security.xsuaa.tokenflows: Exception thrown to signal issues during a token flow execution.
TokenFlowException() - Constructor for exception com.sap.cloud.security.xsuaa.tokenflows.TokenFlowException: Creates a new exception instances.
TokenFlowException(String, Throwable) - Constructor for exception com.sap.cloud.security.xsuaa.tokenflows.TokenFlowException: Creates a new exception instances.
TokenFlowException(String) - Constructor for exception com.sap.cloud.security.xsuaa.tokenflows.TokenFlowException: Creates a new exception instances.
TokenFlowException(Throwable) - Constructor for exception com.sap.cloud.security.xsuaa.tokenflows.TokenFlowException: Creates a new exception instances.
toString() - Method in class com.sap.cloud.security.xsuaa.client.OAuth2TokenResponse
toString() - Method in class com.sap.cloud.security.xsuaa.http.HttpHeader
toString() - Method in class com.sap.cloud.security.xsuaa.http.HttpHeaders
toString() - Method in class com.sap.cloud.security.xsuaa.tokenflows.TokenCacheConfiguration

U

UriUtil - Class in com.sap.cloud.security.xsuaa.util
USERNAME - Static variable in class com.sap.cloud.security.xsuaa.client.OAuth2TokenServiceConstants
username(String) - Method in class com.sap.cloud.security.xsuaa.tokenflows.PasswordTokenFlow: The username for the user trying to get a token.
UserTokenFlow - Class in com.sap.cloud.security.xsuaa.tokenflows: A user token flow builder class.
userTokenFlow() - Method in class com.sap.cloud.security.xsuaa.tokenflows.XsuaaTokenFlows: Creates a new User Token Flow builder object.

V

value() - Method in enum com.sap.cloud.security.xsuaa.http.MediaType
valueOf(String) - Static method in enum com.sap.cloud.security.xsuaa.http.MediaType: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.sap.cloud.security.xsuaa.http.MediaType: Returns an array containing the constants of this enum type, in the order they are declared.

W

withHeader(String, String) - Method in class com.sap.cloud.security.xsuaa.http.HttpHeaders
withHeaders(String...) - Method in class com.sap.cloud.security.xsuaa.client.OAuth2ServiceException.Builder
withResponseBody(String) - Method in class com.sap.cloud.security.xsuaa.client.OAuth2ServiceException.Builder
withStatusCode(int) - Method in class com.sap.cloud.security.xsuaa.client.OAuth2ServiceException.Builder: Parameterizes the Exception with a HTTP status code.
withUri(URI) - Method in class com.sap.cloud.security.xsuaa.client.OAuth2ServiceException.Builder

X

X_ZID - Static variable in class com.sap.cloud.security.xsuaa.http.HttpHeaders
X_ZONE_UUID - Static variable in class com.sap.cloud.security.xsuaa.http.HttpHeaders
XsuaaDefaultEndpoints - Class in com.sap.cloud.security.xsuaa.client
XsuaaDefaultEndpoints(URI) - Constructor for class com.sap.cloud.security.xsuaa.client.XsuaaDefaultEndpoints: Deprecated.
gets removed with the major release 3.0.0 Use instead XsuaaDefaultEndpoints(String, String)
XsuaaDefaultEndpoints(String, String) - Constructor for class com.sap.cloud.security.xsuaa.client.XsuaaDefaultEndpoints: Creates a new XsuaaDefaultEndpoints.
XsuaaDefaultEndpoints(OAuth2ServiceConfiguration) - Constructor for class com.sap.cloud.security.xsuaa.client.XsuaaDefaultEndpoints: Creates a new XsuaaDefaultEndpoints.
XsuaaDefaultEndpoints(String) - Constructor for class com.sap.cloud.security.xsuaa.client.XsuaaDefaultEndpoints: Deprecated.
gets removed with the major release 3.0.0 Use instead XsuaaDefaultEndpoints(String, String)
XsuaaOAuth2TokenService - Class in com.sap.cloud.security.xsuaa.client: Implementation for Spring applications, that uses RestOperations.
XsuaaOAuth2TokenService() - Constructor for class com.sap.cloud.security.xsuaa.client.XsuaaOAuth2TokenService: Deprecated.
In favor of {XsuaaOAuth2TokenService(RestOperations) gets removed with the version 3.0.0, does not support certificate based authentication
XsuaaOAuth2TokenService(TokenCacheConfiguration) - Constructor for class com.sap.cloud.security.xsuaa.client.XsuaaOAuth2TokenService: Deprecated.
In favor of {XsuaaOAuth2TokenService(RestOperations) gets removed with the version 3.0.0, does not support certificate based authentication
XsuaaOAuth2TokenService(RestOperations) - Constructor for class com.sap.cloud.security.xsuaa.client.XsuaaOAuth2TokenService
XsuaaOAuth2TokenService(RestOperations, TokenCacheConfiguration) - Constructor for class com.sap.cloud.security.xsuaa.client.XsuaaOAuth2TokenService
XsuaaTokenFlows - Class in com.sap.cloud.security.xsuaa.tokenflows: A bean that can be @Autowired by applications to get access to token flow builders.
XsuaaTokenFlows(OAuth2TokenService, OAuth2ServiceEndpointsProvider, ClientCredentials) - Constructor for class com.sap.cloud.security.xsuaa.tokenflows.XsuaaTokenFlows: Deprecated.
in favor of XsuaaTokenFlows(OAuth2TokenService, OAuth2ServiceEndpointsProvider, ClientIdentity)
XsuaaTokenFlows(OAuth2TokenService, OAuth2ServiceEndpointsProvider, ClientIdentity) - Constructor for class com.sap.cloud.security.xsuaa.tokenflows.XsuaaTokenFlows: Create a new instance of this bean with the given RestTemplate.

Z

zoneId(String) - Method in class com.sap.cloud.security.xsuaa.tokenflows.ClientCredentialsTokenFlow: Sets the zone Id of the tenant

A B C D E G H I M O P R S T U V W X Z