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

A C D E G H J L N O R S T V W

A

AuthToken - Class in com.sap.cloud.sdk.cloudplatform.security: Class providing access to the authorization token of a request on SAP Cloud Platform Cloud Foundry.
AuthToken(DecodedJWT) - Constructor for class com.sap.cloud.sdk.cloudplatform.security.AuthToken
AuthTokenAccessException - Exception in com.sap.cloud.sdk.cloudplatform.security.exception: Thrown if an authorization token cannot be accessed.
AuthTokenAccessException(String) - Constructor for exception com.sap.cloud.sdk.cloudplatform.security.exception.AuthTokenAccessException
AuthTokenAccessException(Throwable) - Constructor for exception com.sap.cloud.sdk.cloudplatform.security.exception.AuthTokenAccessException
AuthTokenAccessException(String, Throwable) - Constructor for exception com.sap.cloud.sdk.cloudplatform.security.exception.AuthTokenAccessException
AuthTokenAccessException() - Constructor for exception com.sap.cloud.sdk.cloudplatform.security.exception.AuthTokenAccessException
AuthTokenAccessor - Class in com.sap.cloud.sdk.cloudplatform.security: Accessor for retrieving the current AuthToken on SAP Cloud Platform Cloud Foundry.
AuthTokenAccessor() - Constructor for class com.sap.cloud.sdk.cloudplatform.security.AuthTokenAccessor
AuthTokenFacade - Class in com.sap.cloud.sdk.cloudplatform.security: Facade for retrieving the current AuthToken.
AuthTokenFacade() - Constructor for class com.sap.cloud.sdk.cloudplatform.security.AuthTokenFacade
AuthTokenRequestContextListener - Class in com.sap.cloud.sdk.cloudplatform.security: Implementation of AbstractRequestContextListener that obtain the current JWT bearer from the Authorization header of the current request when working with non-container managed threads on SAP Cloud Platform Cloud Foundry.
AuthTokenRequestContextListener() - Constructor for class com.sap.cloud.sdk.cloudplatform.security.AuthTokenRequestContextListener

C

canEqual(Object) - Method in class com.sap.cloud.sdk.cloudplatform.security.AuthToken
canEqual(Object) - Method in class com.sap.cloud.sdk.cloudplatform.security.principal.ScpCfPrincipal
canEqual(Object) - Method in class com.sap.cloud.sdk.cloudplatform.security.user.ScpCfUser
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
com.sap.cloud.sdk.cloudplatform.security.user - package com.sap.cloud.sdk.cloudplatform.security.user

D

DefaultLocalScopePrefixProvider - Class in com.sap.cloud.sdk.cloudplatform.security.user: This is the default strategy for determining the local scope prefix used by the SDK.
DefaultLocalScopePrefixProvider() - Constructor for class com.sap.cloud.sdk.cloudplatform.security.user.DefaultLocalScopePrefixProvider

E

equals(Object) - Method in class com.sap.cloud.sdk.cloudplatform.security.AuthToken
equals(Object) - Method in class com.sap.cloud.sdk.cloudplatform.security.principal.ScpCfPrincipal
equals(Object) - Method in class com.sap.cloud.sdk.cloudplatform.security.user.ScpCfUser

G

getAuthorizations() - Method in class com.sap.cloud.sdk.cloudplatform.security.principal.ScpCfPrincipal
getAuthorizations(Payload) - Method in class com.sap.cloud.sdk.cloudplatform.security.user.LocalScopePrefixExtractor: Extracts the authorizations from the given JWT.
getAuthTokenFacade() - Static method in class com.sap.cloud.sdk.cloudplatform.security.AuthTokenAccessor
getCurrentPrincipal() - Method in class com.sap.cloud.sdk.cloudplatform.security.principal.ScpCfPrincipalFacade
getCurrentToken() - Static method in class com.sap.cloud.sdk.cloudplatform.security.AuthTokenAccessor: Returns the current AuthToken, if present.
getCurrentToken() - Method in class com.sap.cloud.sdk.cloudplatform.security.AuthTokenFacade: Returns the current AuthToken, if present.
getId() - Method in class com.sap.cloud.sdk.cloudplatform.security.principal.ScpCfPrincipal
getJwt() - Method in class com.sap.cloud.sdk.cloudplatform.security.AuthToken: The DecodedJWT bearer contained in the Authorization header of the given request.
getKeyStoreIfPresent(String, SecretStore) - Method in class com.sap.cloud.sdk.cloudplatform.security.secret.ScpCfSecretStoreFacade
getLocalScopePrefix() - Method in class com.sap.cloud.sdk.cloudplatform.security.user.DefaultLocalScopePrefixProvider: Returns the local scope prefix determined by the given implementation.
getLocalScopePrefix() - Method in interface com.sap.cloud.sdk.cloudplatform.security.user.LocalScopePrefixProvider: Returns the local scope prefix determined by the given implementation.
getMockedUserAsFallback() - Method in class com.sap.cloud.sdk.cloudplatform.security.user.ScpCfUserFacade: Returns a mocked User as fallback, if the environment variable "ALLOW_MOCKED_AUTH_HEADER" is set to "true".
getPriority() - Method in class com.sap.cloud.sdk.cloudplatform.security.AuthTokenRequestContextListener
getProperties(RequestContext) - Method in class com.sap.cloud.sdk.cloudplatform.security.AuthTokenRequestContextListener
getRefreshToken(DecodedJWT) - Static method in class com.sap.cloud.sdk.cloudplatform.security.AuthTokenAccessor: Returns a future that resolves to a refresh token.
getSecret() - Method in class com.sap.cloud.sdk.cloudplatform.security.secret.ScpCfSecretStore
getSecretStoreClass() - Method in class com.sap.cloud.sdk.cloudplatform.security.secret.ScpCfSecretStoreFacade
getSecretStoreIfPresent(String) - Method in class com.sap.cloud.sdk.cloudplatform.security.secret.ScpCfSecretStoreFacade
getThis() - Method in class com.sap.cloud.sdk.cloudplatform.security.JwtBasedRequestContextExecutor
getUserByName(String) - Method in class com.sap.cloud.sdk.cloudplatform.security.user.ScpCfUserFacade
getUserClass() - Method in class com.sap.cloud.sdk.cloudplatform.security.user.ScpCfUserFacade
getXsuaaServiceToken() - Static method in class com.sap.cloud.sdk.cloudplatform.security.AuthTokenAccessor: Retrieves a validated authentication token from the bound XSUAA instance.
getXsuaaServiceToken() - Method in class com.sap.cloud.sdk.cloudplatform.security.AuthTokenFacade: Retrieves a validated authentication token from the bound XSUAA instance.

H

hashCode() - Method in class com.sap.cloud.sdk.cloudplatform.security.AuthToken
hashCode() - Method in class com.sap.cloud.sdk.cloudplatform.security.principal.ScpCfPrincipal
hashCode() - Method in class com.sap.cloud.sdk.cloudplatform.security.user.ScpCfUser

J

JwtBasedRequestContextExecutor - Class in com.sap.cloud.sdk.cloudplatform.security: JWT-based RequestContext executor which runs a given Callable or Executable as if it would have been invoked via a HttpServletRequest with the given JWT bearer as part of the "Authorization" header.
JwtBasedRequestContextExecutor() - Constructor for class com.sap.cloud.sdk.cloudplatform.security.JwtBasedRequestContextExecutor

L

LocalScopePrefixExtractor - Class in com.sap.cloud.sdk.cloudplatform.security.user: This class contains the logic to extract the values of the scope claim of a JWT and returns it as a Set of Authorizations.
LocalScopePrefixExtractor(LocalScopePrefixProvider) - Constructor for class com.sap.cloud.sdk.cloudplatform.security.user.LocalScopePrefixExtractor: 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.user: The interface representing the strategy used by the LocalScopePrefixExtractor to determine the local scope prefix (i.e.

N

newMockedUser() - Method in class com.sap.cloud.sdk.cloudplatform.security.user.ScpCfUserFacade

O

onBehalfOfTenant(String, String, String...) - Method in class com.sap.cloud.sdk.cloudplatform.security.JwtBasedRequestContextExecutor: Deprecated.
Use JwtBasedRequestContextExecutor.onBehalfOfTenant(String) or JwtBasedRequestContextExecutor.onBehalfOfTenant(String, String, Collection) instead.
onBehalfOfTenant(String) - Method in class com.sap.cloud.sdk.cloudplatform.security.JwtBasedRequestContextExecutor: A non-validated JWT is constructed based on tenant information.
onBehalfOfTenant(String, String, Collection<String>) - Method in class com.sap.cloud.sdk.cloudplatform.security.JwtBasedRequestContextExecutor: A non-validated JWT is constructed based on tenant information.

R

RefreshTokenFacade - Class in com.sap.cloud.sdk.cloudplatform.security: Facade for triggering the refresh token retrieval and subsequent access to it.
RefreshTokenFacade() - Constructor for class com.sap.cloud.sdk.cloudplatform.security.RefreshTokenFacade
resolveCurrentUser() - Method in class com.sap.cloud.sdk.cloudplatform.security.user.ScpCfUserFacade

S

ScopeAccessException - Exception in com.sap.cloud.sdk.cloudplatform.security.user: An exception that is thrown in case of any errors in the LocalScopePrefixExtractor.
ScopeAccessException(String, Throwable) - Constructor for exception com.sap.cloud.sdk.cloudplatform.security.user.ScopeAccessException: Creates a new ScopeAccessException with the given message and the given cause.
ScpCfPrincipal - Class in com.sap.cloud.sdk.cloudplatform.security.principal: An implementation of the Principal interface for SAP Cloud Platform Cloud Foundry.
ScpCfPrincipal(String, Set<Authorization>) - Constructor for class com.sap.cloud.sdk.cloudplatform.security.principal.ScpCfPrincipal
ScpCfPrincipalFacade - Class in com.sap.cloud.sdk.cloudplatform.security.principal: Facade providing access to Principal information on SAP Cloud Platform Cloud Foundry.
ScpCfPrincipalFacade(LocalScopePrefixProvider) - Constructor for class com.sap.cloud.sdk.cloudplatform.security.principal.ScpCfPrincipalFacade: Creates a new instance of this facade with the given prefix provider.
ScpCfPrincipalFacade() - Constructor for class com.sap.cloud.sdk.cloudplatform.security.principal.ScpCfPrincipalFacade: Default constructor with default strategies.
ScpCfSecretStore - Class in com.sap.cloud.sdk.cloudplatform.security.secret: Implementation of SecretStore for SAP Cloud Platform Cloud Foundry.
ScpCfSecretStore() - Constructor for class com.sap.cloud.sdk.cloudplatform.security.secret.ScpCfSecretStore: Creates a mocked ScpCfSecretStore.
ScpCfSecretStoreFacade - Class in com.sap.cloud.sdk.cloudplatform.security.secret: Implementation of SecretStoreFacade for SAP Cloud Platform Cloud Foundry.
ScpCfSecretStoreFacade() - Constructor for class com.sap.cloud.sdk.cloudplatform.security.secret.ScpCfSecretStoreFacade
ScpCfUser - Class in com.sap.cloud.sdk.cloudplatform.security.user: Implementation of User for SAP Cloud Platform Cloud Foundry.
ScpCfUser(String, Locale, Set<Authorization>, Map<String, UserAttribute>) - Constructor for class com.sap.cloud.sdk.cloudplatform.security.user.ScpCfUser: Creates a new ScpCfUser.
ScpCfUserFacade - Class in com.sap.cloud.sdk.cloudplatform.security.user: Facade providing access to user information on SAP Cloud Platform Cloud Foundry.
ScpCfUserFacade(LocalScopePrefixProvider) - Constructor for class com.sap.cloud.sdk.cloudplatform.security.user.ScpCfUserFacade: Use this constructor if you want to override the default strategy for determining the local scope prefix.
ScpCfUserFacade() - Constructor for class com.sap.cloud.sdk.cloudplatform.security.user.ScpCfUserFacade: Default constructor with default strategies.
setAuthTokenFacade(AuthTokenFacade) - Static method in class com.sap.cloud.sdk.cloudplatform.security.AuthTokenAccessor: Replaces the default AuthTokenFacade instance.
setIdExtractorFunction(String, CheckedFunction1<DecodedJWT, String>) - Method in class com.sap.cloud.sdk.cloudplatform.security.principal.ScpCfPrincipalFacade: This allows to set/override the way the Principal.getId() is obtained, given a grant_type in the AuthToken.
setRefreshTokenFacade(RefreshTokenFacade) - Static method in class com.sap.cloud.sdk.cloudplatform.security.AuthTokenAccessor: Replaces the default RefreshTokenFacade instance.

T

TokenRequestDeniedException - Exception in com.sap.cloud.sdk.cloudplatform.security.exception: Exception that is thrown in case the request to receive an authentication token fails due to authentication issues with the XSUAA service.
TokenRequestDeniedException(String) - Constructor for exception com.sap.cloud.sdk.cloudplatform.security.exception.TokenRequestDeniedException: Creates a new exception based on the given message.
TokenRequestFailedException - Exception in com.sap.cloud.sdk.cloudplatform.security.exception: Exception that is thrown in case the request to receive an authentication token fails for any reason that is not related with authentication issues with the XSUAA service.
TokenRequestFailedException(String) - Constructor for exception com.sap.cloud.sdk.cloudplatform.security.exception.TokenRequestFailedException: Creates a new exception based on the given message.
TokenRequestFailedException(Throwable) - Constructor for exception com.sap.cloud.sdk.cloudplatform.security.exception.TokenRequestFailedException: Creates a new exception based on the given causing exception.
TokenRequestFailedException(String, Throwable) - Constructor for exception com.sap.cloud.sdk.cloudplatform.security.exception.TokenRequestFailedException: Creates a new exception based on the given messagen and causing exception.
toString() - Method in class com.sap.cloud.sdk.cloudplatform.security.principal.ScpCfPrincipal
toString() - Method in class com.sap.cloud.sdk.cloudplatform.security.user.ScpCfUser

V

VARIABLE_ALLOW_MOCKED_AUTH_HEADER - Static variable in class com.sap.cloud.sdk.cloudplatform.security.user.ScpCfUserFacade

W

withJwt(String) - Method in class com.sap.cloud.sdk.cloudplatform.security.JwtBasedRequestContextExecutor: The given JWT is used to initialize the RequestContext as if it was called from HttpServletRequest.
withJwt(String, String) - Method in class com.sap.cloud.sdk.cloudplatform.security.JwtBasedRequestContextExecutor: The given JWT is used to initialize the RequestContext as if it was called from HttpServletRequest.
withXsuaaServiceJwt() - Method in class com.sap.cloud.sdk.cloudplatform.security.JwtBasedRequestContextExecutor: Retrieves a JWT from the bound XSUAA service and initialize this RequestContextExecutor with it.

A C D E G H J L N O R S T V W