Index (Cloud Platform - Security SAP CP Cloud Foundry 4.32.0 API)

A B C D E F G H I K L O P R S T U
All Classes and Interfaces|All Packages|Serialized Form

A

afterInitialize(ThreadContext) - Method in class com.sap.cloud.sdk.cloudplatform.security.AuthTokenThreadContextListener
afterInitialize(ThreadContext) - Method in class com.sap.cloud.sdk.cloudplatform.security.BasicAuthenticationThreadContextListener
authorizePath(String) - Method in class com.sap.cloud.sdk.cloudplatform.security.OAuth2ServiceSettings.OAuth2ServiceSettingsBuilder
AuthTokenBuilder - Class in com.sap.cloud.sdk.cloudplatform.security: Deprecated.
AuthTokenBuilder() - Constructor for class com.sap.cloud.sdk.cloudplatform.security.AuthTokenBuilder: Deprecated.
AuthTokenBuilder.FluentHelperBuild - Interface in com.sap.cloud.sdk.cloudplatform.security: Deprecated.

Fluent helper to chain operations.
AuthTokenBuilder.FluentHelperRefreshToken - Class in com.sap.cloud.sdk.cloudplatform.security: Deprecated.

Fluent helper to chain operations.
AuthTokenBuilder.FluentHelperUnsignedJwt - Class in com.sap.cloud.sdk.cloudplatform.security: Deprecated.
AuthTokenThreadContextListener - Class in com.sap.cloud.sdk.cloudplatform.security: Implementation of ThreadContextListener that ensures the correct initialization of AuthTokens when working with non-container managed threads on all supported Cloud platforms.
AuthTokenThreadContextListener() - Constructor for class com.sap.cloud.sdk.cloudplatform.security.AuthTokenThreadContextListener: Default constructor.
AuthTokenThreadContextListener(AuthToken) - Constructor for class com.sap.cloud.sdk.cloudplatform.security.AuthTokenThreadContextListener: Constructor for providing a AuthToken to be returned by this listener.

B

baseUri(URI) - Method in class com.sap.cloud.sdk.cloudplatform.security.OAuth2ServiceSettings.OAuth2ServiceSettingsBuilder
BasicAuthenticationAccessException - Exception in com.sap.cloud.sdk.cloudplatform.security.exception: Thrown if the BasicAuthentication credentials cannot be accessed.
BasicAuthenticationAccessException() - Constructor for exception com.sap.cloud.sdk.cloudplatform.security.exception.BasicAuthenticationAccessException
BasicAuthenticationAccessException(String) - Constructor for exception com.sap.cloud.sdk.cloudplatform.security.exception.BasicAuthenticationAccessException: Creates a new exception based on the given message.
BasicAuthenticationAccessException(String, Throwable) - Constructor for exception com.sap.cloud.sdk.cloudplatform.security.exception.BasicAuthenticationAccessException: Creates a new exception based on the given message.
BasicAuthenticationAccessor - Class in com.sap.cloud.sdk.cloudplatform.security: Static accessor to retrieve the BasicCredentials of the currently incoming request.
BasicAuthenticationFacade - Interface in com.sap.cloud.sdk.cloudplatform.security: Facade for retrieving the current BasicCredentials.
BasicAuthenticationThreadContextListener - Class in com.sap.cloud.sdk.cloudplatform.security: ThreadContextListener implementation reading the Basic Authentication Header from the incoming request and storing it in the current ThreadContext.
BasicAuthenticationThreadContextListener() - Constructor for class com.sap.cloud.sdk.cloudplatform.security.BasicAuthenticationThreadContextListener
build() - Method in interface com.sap.cloud.sdk.cloudplatform.security.AuthTokenBuilder.FluentHelperBuild: Deprecated.

Builds the AuthToken.
build() - Method in class com.sap.cloud.sdk.cloudplatform.security.AuthTokenBuilder.FluentHelperRefreshToken: Deprecated.
build() - Method in interface com.sap.cloud.sdk.cloudplatform.security.OAuth2ServiceProvider.OAuth2ServiceProviderBuilder: Deprecated.

Finilize builder, instantiate the object.
build() - Method in class com.sap.cloud.sdk.cloudplatform.security.OAuth2ServiceSettings.OAuth2ServiceSettingsBuilder
builder() - Static method in interface com.sap.cloud.sdk.cloudplatform.security.OAuth2ServiceProvider: Deprecated.

Instantiate a new builder.

C

canEqual(Object) - Method in class com.sap.cloud.sdk.cloudplatform.security.OAuth2ServiceSettings
canEqual(Object) - Method in class com.sap.cloud.sdk.cloudplatform.security.principal.ScpCfPrincipal: Deprecated.
com.sap.cloud.sdk.cloudplatform.security - package com.sap.cloud.sdk.cloudplatform.security
com.sap.cloud.sdk.cloudplatform.security.exception - package com.sap.cloud.sdk.cloudplatform.security.exception
com.sap.cloud.sdk.cloudplatform.security.principal - package com.sap.cloud.sdk.cloudplatform.security.principal
com.sap.cloud.sdk.cloudplatform.security.secret - package com.sap.cloud.sdk.cloudplatform.security.secret
create() - Static method in interface com.sap.cloud.sdk.cloudplatform.security.OAuth2TokenServiceCache: Create an empty cache.
create(Map<ClientIdentity, OAuth2TokenService>) - Static method in interface com.sap.cloud.sdk.cloudplatform.security.OAuth2TokenServiceCache: Create a new cache based on an existing Map instance.

D

decodedJwt(DecodedJWT) - Method in class com.sap.cloud.sdk.cloudplatform.security.AuthTokenBuilder: Deprecated.

Use a DecodedJWT for constructing the AuthToken.
decorateCallable(Callable<T>) - Method in class com.sap.cloud.sdk.cloudplatform.security.SecurityContextThreadContextDecorator
DefaultBasicAuthenticationFacade - Class in com.sap.cloud.sdk.cloudplatform.security: Default implementation of the BasicAuthenticationAccessor reading the username and password from the current ThreadContext or, after that, from the currently incoming request and returning it as a BasicCredentials object.
DefaultBasicAuthenticationFacade() - Constructor for class com.sap.cloud.sdk.cloudplatform.security.DefaultBasicAuthenticationFacade
DefaultLocalScopePrefixProvider - Class in com.sap.cloud.sdk.cloudplatform.security.principal: Deprecated.
To be removed without replacement. Please refer to release notes for more information.
DefaultLocalScopePrefixProvider() - Constructor for class com.sap.cloud.sdk.cloudplatform.security.principal.DefaultLocalScopePrefixProvider: Deprecated.

E

encodedJwt(String) - Method in class com.sap.cloud.sdk.cloudplatform.security.AuthTokenBuilder: Deprecated.

Use an encoded JWT for constructing the AuthToken.
equals(Object) - Method in class com.sap.cloud.sdk.cloudplatform.security.OAuth2ServiceSettings
equals(Object) - Method in class com.sap.cloud.sdk.cloudplatform.security.principal.ScpCfPrincipal: Deprecated.
executeWithAuthToken(AuthToken, Callable<T>) - Method in class com.sap.cloud.sdk.cloudplatform.security.ScpCfAuthTokenFacade

F

FluentHelperRefreshToken(String) - Constructor for class com.sap.cloud.sdk.cloudplatform.security.AuthTokenBuilder.FluentHelperRefreshToken: Deprecated.
FluentHelperUnsignedJwt() - Constructor for class com.sap.cloud.sdk.cloudplatform.security.AuthTokenBuilder.FluentHelperUnsignedJwt: Deprecated.

G

getAuthorizations(Payload) - Method in class com.sap.cloud.sdk.cloudplatform.security.principal.LocalScopePrefixExtractor: Deprecated.

Extracts the authorizations from the given JWT.
getAuthorizePath() - Method in class com.sap.cloud.sdk.cloudplatform.security.OAuth2ServiceSettings
getBaseUri() - Method in class com.sap.cloud.sdk.cloudplatform.security.OAuth2ServiceSettings
getBasicAuthenticationFacade() - Static method in class com.sap.cloud.sdk.cloudplatform.security.BasicAuthenticationAccessor: The actual implementation used to forward the business logic calls to.
getKeysetPath() - Method in class com.sap.cloud.sdk.cloudplatform.security.OAuth2ServiceSettings
getLocalScopePrefix() - Method in class com.sap.cloud.sdk.cloudplatform.security.principal.DefaultLocalScopePrefixProvider: Deprecated.
getLocalScopePrefix() - Method in interface com.sap.cloud.sdk.cloudplatform.security.principal.LocalScopePrefixProvider: Deprecated.

Returns the local scope prefix determined by the given implementation.
getPriority() - Method in class com.sap.cloud.sdk.cloudplatform.security.AuthTokenThreadContextListener
getPriority() - Method in class com.sap.cloud.sdk.cloudplatform.security.BasicAuthenticationThreadContextListener
getPriority() - Method in class com.sap.cloud.sdk.cloudplatform.security.SecurityContextThreadContextDecorator
getRefreshToken(DecodedJWT) - Method in class com.sap.cloud.sdk.cloudplatform.security.ScpCfAuthTokenFacade: Deprecated.
Please leverage the security library directly instead.
getSecret() - Method in class com.sap.cloud.sdk.cloudplatform.security.secret.ScpCfSecretStore: Deprecated.
getTokenPath() - Method in class com.sap.cloud.sdk.cloudplatform.security.OAuth2ServiceSettings
getTokenService(ClientIdentity) - Method in class com.sap.cloud.sdk.cloudplatform.security.OAuth2TokenServiceCache.Default
getTokenService(ClientIdentity) - Method in interface com.sap.cloud.sdk.cloudplatform.security.OAuth2TokenServiceCache: Get the token service.
getXsuaaTokenFlows() - Method in interface com.sap.cloud.sdk.cloudplatform.security.OAuth2ServiceProvider: Deprecated.

Shortcut method to instantiate an XSUAA request builder from the security library.

H

hashCode() - Method in class com.sap.cloud.sdk.cloudplatform.security.OAuth2ServiceSettings
hashCode() - Method in class com.sap.cloud.sdk.cloudplatform.security.principal.ScpCfPrincipal: Deprecated.

I

invalidateCache() - Method in class com.sap.cloud.sdk.cloudplatform.security.OAuth2TokenServiceCache.Default
invalidateCache() - Method in interface com.sap.cloud.sdk.cloudplatform.security.OAuth2TokenServiceCache: Invalidate the cache.

K

keysetPath(String) - Method in class com.sap.cloud.sdk.cloudplatform.security.OAuth2ServiceSettings.OAuth2ServiceSettingsBuilder

L

LocalScopePrefixExtractor - Class in com.sap.cloud.sdk.cloudplatform.security.principal: Deprecated.
To be removed without replacement. Please refer to release notes for more information.
LocalScopePrefixExtractor(LocalScopePrefixProvider) - Constructor for class com.sap.cloud.sdk.cloudplatform.security.principal.LocalScopePrefixExtractor: Deprecated.

Creates a new instance with the given LocalScopePrefixProvider which provides the prefix of the scopes to be used.
LocalScopePrefixProvider - Interface in com.sap.cloud.sdk.cloudplatform.security.principal: Deprecated.
To be removed without replacement. Please refer to release notes for more information.

O

OAuth2ServiceProvider - Interface in com.sap.cloud.sdk.cloudplatform.security: Deprecated.
Please directly use the token client library instead.
OAuth2ServiceProvider.OAuth2ServiceProviderBuilder - Interface in com.sap.cloud.sdk.cloudplatform.security: Deprecated.

Builder type to customize OAuth2 service specific settings.
OAuth2ServiceSettings - Class in com.sap.cloud.sdk.cloudplatform.security: Settings about the Authorization Server.
OAuth2ServiceSettings(URI, String, String, String) - Constructor for class com.sap.cloud.sdk.cloudplatform.security.OAuth2ServiceSettings
OAuth2ServiceSettings.OAuth2ServiceSettingsBuilder - Class in com.sap.cloud.sdk.cloudplatform.security
OAuth2TokenServiceCache - Interface in com.sap.cloud.sdk.cloudplatform.security: The cache to store instances of OAuth2TokenService according to ClientIdentity.
OAuth2TokenServiceCache.Default - Class in com.sap.cloud.sdk.cloudplatform.security: Default implementation of the interface.
ofBaseUri(URI) - Static method in class com.sap.cloud.sdk.cloudplatform.security.OAuth2ServiceSettings: Invoke a builder for this type.
ofTenant(String, String) - Method in class com.sap.cloud.sdk.cloudplatform.security.AuthTokenBuilder.FluentHelperUnsignedJwt: Deprecated.

A non-validated JWT is constructed based on tenant information (xsappname and issuer URL of subscriber in VCAP_SERVICES environment variable).
ofTenant(String, URI, Collection<String>) - Method in class com.sap.cloud.sdk.cloudplatform.security.AuthTokenBuilder.FluentHelperUnsignedJwt: Deprecated.

A non-validated JWT is constructed based on tenant information.

P

platform(CloudPlatform) - Method in interface com.sap.cloud.sdk.cloudplatform.security.OAuth2ServiceProvider.OAuth2ServiceProviderBuilder: Deprecated.

Set a static platform object.
PROPERTY_AUTH_TOKEN - Static variable in class com.sap.cloud.sdk.cloudplatform.security.AuthTokenThreadContextListener: The ThreadContext key.
PROPERTY_BASIC_AUTH_HEADER - Static variable in class com.sap.cloud.sdk.cloudplatform.security.BasicAuthenticationThreadContextListener: The key of the stored BasicCredentials in the current ThreadContext.

R

refreshToken(String) - Method in class com.sap.cloud.sdk.cloudplatform.security.AuthTokenBuilder.FluentHelperRefreshToken: Deprecated.

Specifies to use the given refresh token to refresh the encoded JWT, if expired.

S

ScpCfAuthTokenFacade - Class in com.sap.cloud.sdk.cloudplatform.security: Facade for retrieving the current AuthToken.
ScpCfAuthTokenFacade() - Constructor for class com.sap.cloud.sdk.cloudplatform.security.ScpCfAuthTokenFacade: Default constructor.
ScpCfAuthTokenFacade(OAuth2TokenService, OAuth2ServiceConfiguration) - Constructor for class com.sap.cloud.sdk.cloudplatform.security.ScpCfAuthTokenFacade: Deprecated.
Token validation will be removed with the next major release. Please leverage the security library directly instead.
ScpCfPrincipal - Class in com.sap.cloud.sdk.cloudplatform.security.principal: Deprecated.
Please use DefaultPrincipal instead.
ScpCfPrincipal() - Constructor for class com.sap.cloud.sdk.cloudplatform.security.principal.ScpCfPrincipal: Deprecated.

Creates a ScpCfPrincipal with an empty principal identifier, no authorizations, and no attributes.
ScpCfPrincipal(String, Set<Authorization>, Map<String, PrincipalAttribute>) - Constructor for class com.sap.cloud.sdk.cloudplatform.security.principal.ScpCfPrincipal: Deprecated.

Creates a new ScpCfPrincipal.
ScpCfPrincipalFacade - Class in com.sap.cloud.sdk.cloudplatform.security.principal: Deprecated.
Please use DefaultPrincipalFacade instead.
ScpCfPrincipalFacade() - Constructor for class com.sap.cloud.sdk.cloudplatform.security.principal.ScpCfPrincipalFacade: Deprecated.

Default constructor with default strategies.
ScpCfPrincipalFacade(LocalScopePrefixProvider) - Constructor for class com.sap.cloud.sdk.cloudplatform.security.principal.ScpCfPrincipalFacade: Deprecated.

Creates a new instance of this facade with the given prefix provider.
ScpCfSecretStore - Class in com.sap.cloud.sdk.cloudplatform.security.secret: Deprecated.
without replacement.
ScpCfSecretStore() - Constructor for class com.sap.cloud.sdk.cloudplatform.security.secret.ScpCfSecretStore: Deprecated.

Creates a mocked ScpCfSecretStore.
ScpCfSecretStoreFacade - Class in com.sap.cloud.sdk.cloudplatform.security.secret: Deprecated.
without replacement.
ScpCfSecretStoreFacade() - Constructor for class com.sap.cloud.sdk.cloudplatform.security.secret.ScpCfSecretStoreFacade: Deprecated.
SecurityContextThreadContextDecorator - Class in com.sap.cloud.sdk.cloudplatform.security: Implementation of ThreadContextDecorator that ensures the correct initialization of Tokens when working with non-container managed threads on Cloud Foundry.
SecurityContextThreadContextDecorator() - Constructor for class com.sap.cloud.sdk.cloudplatform.security.SecurityContextThreadContextDecorator
serviceSettings(OAuth2ServiceSettings) - Method in interface com.sap.cloud.sdk.cloudplatform.security.OAuth2ServiceProvider.OAuth2ServiceProviderBuilder: Deprecated.

Set custom OAuth service settings.
setBasicAuthenticationFacade(BasicAuthenticationFacade) - Static method in class com.sap.cloud.sdk.cloudplatform.security.BasicAuthenticationAccessor: Overrides the currently set facade with the given one, potentially changing the behavior of all following calls to the BasicAuthenticationAccessor.
setIdExtractorFunction(String, CheckedFunction1<DecodedJWT, String>) - Method in class com.sap.cloud.sdk.cloudplatform.security.principal.ScpCfPrincipalFacade: Deprecated.

This allows to set/override the way the Principal.getPrincipalId() is obtained, given a grant_type in the AuthToken.
single(OAuth2TokenService) - Static method in interface com.sap.cloud.sdk.cloudplatform.security.OAuth2TokenServiceCache: Create ab immutable cache instance, with a single entry that is being returned for any provided client identity.
staticAccessToken(DecodedJWT) - Method in interface com.sap.cloud.sdk.cloudplatform.security.OAuth2ServiceProvider.OAuth2ServiceProviderBuilder: Deprecated.

Set a static access token.
staticCredentials(Credentials) - Method in interface com.sap.cloud.sdk.cloudplatform.security.OAuth2ServiceProvider.OAuth2ServiceProviderBuilder: Deprecated.

Set a static credentials object.

T

tokenPath(String) - Method in class com.sap.cloud.sdk.cloudplatform.security.OAuth2ServiceSettings.OAuth2ServiceSettingsBuilder
tokenServiceCache(OAuth2TokenServiceCache) - Method in interface com.sap.cloud.sdk.cloudplatform.security.OAuth2ServiceProvider.OAuth2ServiceProviderBuilder: Deprecated.

Set a token service cache.
toOAuth2Endpoints() - Method in class com.sap.cloud.sdk.cloudplatform.security.OAuth2ServiceSettings: Helps in constructing the OAuth2 endpoints; the tokenEndpoint, authorize and key set URI (JWKS) from the baseUri.
toString() - Method in class com.sap.cloud.sdk.cloudplatform.security.OAuth2ServiceSettings.OAuth2ServiceSettingsBuilder
toString() - Method in class com.sap.cloud.sdk.cloudplatform.security.OAuth2ServiceSettings
toString() - Method in class com.sap.cloud.sdk.cloudplatform.security.principal.ScpCfPrincipal: Deprecated.
tryGetBasicCredentials() - Method in interface com.sap.cloud.sdk.cloudplatform.security.BasicAuthenticationFacade: Retrieves the username password pair and returns them as Try.Success.
tryGetBasicCredentials() - Method in class com.sap.cloud.sdk.cloudplatform.security.DefaultBasicAuthenticationFacade
tryGetCurrentBasicCredentials() - Static method in class com.sap.cloud.sdk.cloudplatform.security.BasicAuthenticationAccessor: Getter to retrieve the basic credentials given by the currently incoming request.
tryGetCurrentPrincipal() - Method in class com.sap.cloud.sdk.cloudplatform.security.principal.ScpCfPrincipalFacade: Deprecated.
tryGetCurrentToken() - Method in class com.sap.cloud.sdk.cloudplatform.security.ScpCfAuthTokenFacade
tryGetKeyStore(String, SecretStore) - Method in class com.sap.cloud.sdk.cloudplatform.security.secret.ScpCfSecretStoreFacade: Deprecated.
tryGetSecretStore(String) - Method in class com.sap.cloud.sdk.cloudplatform.security.secret.ScpCfSecretStoreFacade: Deprecated.
tryGetXsuaaServiceToken() - Method in class com.sap.cloud.sdk.cloudplatform.security.ScpCfAuthTokenFacade: Deprecated.
Please leverage the XSUAA Security Library directly instead.

U

unsignedJwt() - Method in class com.sap.cloud.sdk.cloudplatform.security.AuthTokenBuilder: Deprecated.

Use an non-validated, unsigned JWT for constructing the AuthToken.

A B C D E F G H I K L O P R S T U
All Classes and Interfaces|All Packages|Serialized Form