A B C D E F G H I J L O R S T V W X

A

AbstractToken - Class in com.sap.cloud.security.token

Decodes and parses encoded JSON Web Token (JWT) and provides access to token header parameters and claims.

AbstractToken(DecodedJwt) - Constructor for class com.sap.cloud.security.token.AbstractToken

AbstractToken(String) - Constructor for class com.sap.cloud.security.token.AbstractToken

Creates a Token object for simple access to the header parameters and its claims.

AbstractTokenAuthenticator - Class in com.sap.cloud.security.servlet

AbstractTokenAuthenticator() - Constructor for class com.sap.cloud.security.servlet.AbstractTokenAuthenticator

afterPropertiesSet() - Method in class com.sap.cloud.security.adapter.spring.SAPOfflineTokenServicesCloud

asJsonString() - Method in class com.sap.cloud.security.json.DefaultJsonObject

authenticated(Token) - Method in class com.sap.cloud.security.servlet.AbstractTokenAuthenticator

authenticated(Token) - Method in class com.sap.cloud.security.servlet.XsuaaTokenAuthenticator

B

build() - Method in class com.sap.cloud.security.config.OAuth2ServiceConfigurationBuilder

Builds an OAuth configuration (OAuth2ServiceConfiguration) based on the properties applied.

build() - Method in class com.sap.cloud.security.token.validation.validators.JwtValidatorBuilder

Builds the validators with the applied parameters.

C

CFEnvironment - Class in com.sap.cloud.security.config.cf

Loads the OAuth configuration (OAuth2ServiceConfiguration) of a supported identity Service in the SAP CP Cloud Foundry Environment by parsing the VCAP_SERVICES system environment variable.

checkLocalScope(String) - Method in class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

checkScope(String) - Method in class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

clear() - Static method in class com.sap.cloud.security.adapter.spring.SpringSecurityContext

Clears the context value from the current thread.

clearCache() - Method in class com.sap.cloud.security.token.validation.validators.OAuth2TokenKeyServiceWithCache

clearCache() - Method in class com.sap.cloud.security.token.validation.validators.OidcConfigurationServiceWithCache

com.sap.cloud.security.adapter.spring - package com.sap.cloud.security.adapter.spring

com.sap.cloud.security.adapter.xs - package com.sap.cloud.security.adapter.xs

com.sap.cloud.security.config - package com.sap.cloud.security.config

com.sap.cloud.security.config.cf - package com.sap.cloud.security.config.cf

com.sap.cloud.security.json - package com.sap.cloud.security.json

com.sap.cloud.security.servlet - package com.sap.cloud.security.servlet

com.sap.cloud.security.token - package com.sap.cloud.security.token

com.sap.cloud.security.token.validation - package com.sap.cloud.security.token.validation

com.sap.cloud.security.token.validation.validators - package com.sap.cloud.security.token.validation.validators

CombiningValidator<T> - Class in com.sap.cloud.security.token.validation

This is a special validator that combines several validators into one.

CombiningValidator(List<Validator<T>>) - Constructor for class com.sap.cloud.security.token.validation.CombiningValidator

CombiningValidator(Validator<T>...) - Constructor for class com.sap.cloud.security.token.validation.CombiningValidator

configureAnotherServiceInstance(OAuth2ServiceConfiguration) - Method in class com.sap.cloud.security.token.validation.validators.JwtValidatorBuilder

Allows to provide another service configuration, e.g.

contains(String) - Method in class com.sap.cloud.security.json.DefaultJsonObject

convert(Collection<String>) - Method in interface com.sap.cloud.security.token.ScopeConverter

convert(Collection<String>) - Method in class com.sap.cloud.security.token.XsuaaScopeConverter

createInvalid(String) - Static method in class com.sap.cloud.security.token.validation.ValidationResults

Creates an invalid ValidationResult that contains an error description.

createInvalid(String, Object...) - Static method in class com.sap.cloud.security.token.validation.ValidationResults

Works just like ValidationResults.createInvalid(String) but accepts a template string with placeholders "{}" that are substituted with the given arguments.

createPrincipalByName(String) - Method in class com.sap.cloud.security.token.AbstractToken

createValid() - Static method in class com.sap.cloud.security.token.validation.ValidationResults

Creates a valid ValidationResult, which is a ValidationResult that contains no errors.

D

DefaultJsonObject - Class in com.sap.cloud.security.json

Use this class to parse a Json String.

DefaultJsonObject(String) - Constructor for class com.sap.cloud.security.json.DefaultJsonObject

Create an instance

E

Environments - Class in com.sap.cloud.security.config

Central entry point to access the current SAP Cloud Platform Environment.

equals(Object) - Method in class com.sap.cloud.security.token.AbstractToken

equals(Object) - Method in class com.sap.cloud.security.token.validation.validators.XsuaaJwtIssuerValidator

extractFromHeader(String) - Method in class com.sap.cloud.security.servlet.AbstractTokenAuthenticator

Extracts the Token from the authorization header.

extractFromHeader(String) - Method in class com.sap.cloud.security.servlet.XsuaaTokenAuthenticator

F

forService(Service) - Static method in class com.sap.cloud.security.config.OAuth2ServiceConfigurationBuilder

Creates a builder for a dedicated identity (Service)

fromType(String) - Static method in enum com.sap.cloud.security.token.validation.validators.JwtSignatureAlgorithm

fromValue(String) - Static method in enum com.sap.cloud.security.token.validation.validators.JwtSignatureAlgorithm

G

getAccessToken() - Static method in class com.sap.cloud.security.adapter.spring.SpringSecurityContext

Returns the token using SecurityContextHolder.

getAdditionalAuthAttribute(String) - Method in class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

getAppToken() - Method in class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

getAsInstant(String) - Method in class com.sap.cloud.security.json.DefaultJsonObject

getAsList(String, Class<T>) - Method in class com.sap.cloud.security.json.DefaultJsonObject

getAsString(String) - Method in class com.sap.cloud.security.json.DefaultJsonObject

getAttribute(String) - Method in class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

getAudiences() - Method in class com.sap.cloud.security.token.AbstractToken

getAudiences() - Method in class com.sap.cloud.security.token.SapIdToken

getClaimAsJsonObject(String) - Method in class com.sap.cloud.security.token.AbstractToken

getClaimAsString(String) - Method in class com.sap.cloud.security.token.AbstractToken

getClaimAsStringList(String) - Method in class com.sap.cloud.security.token.AbstractToken

getClientId() - Method in class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

getCloneServiceInstanceId() - Method in class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

getCurrent() - Static method in class com.sap.cloud.security.config.Environments

Determines the current type of Environment.

getDBToken() - Method in class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

getEmail() - Method in class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

getErrorDescription() - Method in interface com.sap.cloud.security.token.validation.ValidationResult

The validation error that have been found.

getExpiration() - Method in class com.sap.cloud.security.token.AbstractToken

getFamilyName() - Method in class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

getGivenName() - Method in class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

getGrantType() - Method in class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

getGrantType() - Method in class com.sap.cloud.security.token.XsuaaToken

getHdbToken() - Method in class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

getHeaderParameterAsString(String) - Method in class com.sap.cloud.security.token.AbstractToken

getIasConfiguration() - Method in class com.sap.cloud.security.config.cf.CFEnvironment

getIdentityZone() - Method in class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

getInstance() - Static method in class com.sap.cloud.security.config.cf.CFEnvironment

getInstance(OAuth2ServiceConfiguration) - Static method in class com.sap.cloud.security.token.validation.validators.JwtValidatorBuilder

Creates a builder instance that can be configured further.

getInstance() - Static method in class com.sap.cloud.security.token.validation.validators.OAuth2TokenKeyServiceWithCache

Creates a new instance.

getInstance() - Static method in class com.sap.cloud.security.token.validation.validators.OidcConfigurationServiceWithCache

Creates a new instance.

getJsonObject(String) - Method in class com.sap.cloud.security.json.DefaultJsonObject

getJsonObjects(String) - Method in class com.sap.cloud.security.json.DefaultJsonObject

getJsonValue(String) - Method in class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

getKeyValueMap() - Method in class com.sap.cloud.security.json.DefaultJsonObject

getLogonName() - Method in class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

getNotBefore() - Method in class com.sap.cloud.security.token.AbstractToken

getNumberOfXsuaaConfigurations() - Method in class com.sap.cloud.security.config.cf.CFEnvironment

getOrigin() - Method in class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

getOrRetrieveEndpoints(URI) - Method in class com.sap.cloud.security.token.validation.validators.OidcConfigurationServiceWithCache

Returns the cached key by id and type or requests the keys from the jwks URI of the identity service.

getPrincipal() - Method in class com.sap.cloud.security.token.SapIdToken

getPrincipal() - Method in class com.sap.cloud.security.token.XsuaaToken

getPublicKey(JwtSignatureAlgorithm, String, URI) - Method in class com.sap.cloud.security.token.validation.validators.OAuth2TokenKeyServiceWithCache

Returns the cached key by id and type or requests the keys from the jwks URI of the identity service.

getScopes() - Method in class com.sap.cloud.security.token.XsuaaToken

getService() - Method in class com.sap.cloud.security.token.SapIdToken

getService() - Method in class com.sap.cloud.security.token.XsuaaToken

getServiceConfiguration() - Method in class com.sap.cloud.security.servlet.AbstractTokenAuthenticator

Return configured service configuration or Environments.getCurrent() if not configured.

getServiceConfiguration() - Method in class com.sap.cloud.security.servlet.XsuaaTokenAuthenticator

getSubaccountId() - Method in class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

getSubdomain() - Method in class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

getSystemAttribute(String) - Method in class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

getToken() - Static method in class com.sap.cloud.security.adapter.spring.SpringSecurityContext

Returns the token using SecurityContextHolder.

getToken(String, String) - Method in class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

getTokenValue() - Method in class com.sap.cloud.security.token.AbstractToken

getType() - Method in class com.sap.cloud.security.config.cf.CFEnvironment

getUniqueCacheKey(JwtSignatureAlgorithm, String, URI) - Static method in class com.sap.cloud.security.token.validation.validators.OAuth2TokenKeyServiceWithCache

getValidators() - Method in class com.sap.cloud.security.token.validation.CombiningValidator

getXsuaaConfiguration() - Method in class com.sap.cloud.security.config.cf.CFEnvironment

getXsuaaConfigurationForTokenExchange() - Method in class com.sap.cloud.security.config.cf.CFEnvironment

H

hasAttributes() - Method in class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

hasClaim(String) - Method in class com.sap.cloud.security.token.AbstractToken

hashCode() - Method in class com.sap.cloud.security.token.AbstractToken

hashCode() - Method in class com.sap.cloud.security.token.validation.validators.XsuaaJwtIssuerValidator

hasHeaderParameter(String) - Method in class com.sap.cloud.security.token.AbstractToken

hasLocalScope(String) - Method in class com.sap.cloud.security.token.XsuaaToken

Check if a local scope is available in the authentication token.

hasScope(String) - Method in class com.sap.cloud.security.token.XsuaaToken

httpClient - Variable in class com.sap.cloud.security.servlet.AbstractTokenAuthenticator

I

isEmpty() - Method in class com.sap.cloud.security.json.DefaultJsonObject

isErroneous() - Method in interface com.sap.cloud.security.token.validation.ValidationResult

Returns true if there is a validation error, false otherwise.

isExpired() - Method in class com.sap.cloud.security.token.AbstractToken

isInForeignMode() - Method in class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

Check if a token issued for another OAuth client has been forwarded to a different client,

isValid() - Method in interface com.sap.cloud.security.token.validation.ValidationResult

Returns true if there is no validation error, false otherwise.

J

javaSignature() - Method in enum com.sap.cloud.security.token.validation.validators.JwtSignatureAlgorithm

JwtAudienceValidator - Class in com.sap.cloud.security.token.validation.validators

Validates if the jwt access token is intended for the OAuth2 client of this application.

JwtIssuerValidator - Class in com.sap.cloud.security.token.validation.validators

Validates that the jwt token is issued by a trust worthy identity provider.

JwtSignatureAlgorithm - Enum in com.sap.cloud.security.token.validation.validators

This is represented by "kty" (Key Type) Parameter.

JwtSignatureValidator - Class in com.sap.cloud.security.token.validation.validators

Validates whether the jwt was signed with the public key of the trust-worthy identity service.

JwtTimestampValidator - Class in com.sap.cloud.security.token.validation.validators

Validates whether the jwt access token is used before the "expiration" (exp) time and if it is used after the "not before" (nbf) time.

jwtToken - Variable in class com.sap.cloud.security.token.AbstractToken

JwtValidatorBuilder - Class in com.sap.cloud.security.token.validation.validators

Class used to build a token validator for a oauth service configuration OAuth2ServiceConfiguration.

L

loadAuthentication(String) - Method in class com.sap.cloud.security.adapter.spring.SAPOfflineTokenServicesCloud

loadForServicePlan(Service, CFConstants.Plan) - Method in class com.sap.cloud.security.config.cf.CFEnvironment

Loads the configuration for a dedicated service plan.

logger - Variable in class com.sap.cloud.security.token.validation.validators.JwtIssuerValidator

logger - Variable in class com.sap.cloud.security.token.validation.validators.XsuaaJwtIssuerValidator

O

OAuth2ServiceConfigurationBuilder - Class in com.sap.cloud.security.config

Builds an OAuth configuration (OAuth2ServiceConfiguration) for a dedicated identity (Service) based on the properties applied.

OAuth2TokenKeyServiceWithCache - Class in com.sap.cloud.security.token.validation.validators

Decorates OAuth2TokenKeyService with a cache, which gets looked up before the identity service is requested via http.

OidcConfigurationServiceWithCache - Class in com.sap.cloud.security.token.validation.validators

Decorates OidcConfigurationService with a cache, which gets looked up before the identity service is requested via http.

onValidationError(ValidationResult) - Method in interface com.sap.cloud.security.token.validation.ValidationListener

onValidationSuccess() - Method in interface com.sap.cloud.security.token.validation.ValidationListener

R

readAccessToken(String) - Method in class com.sap.cloud.security.adapter.spring.SAPOfflineTokenServicesCloud

registerValidationListener(ValidationListener) - Method in class com.sap.cloud.security.token.validation.CombiningValidator

Components that are interested in the result of the token validation can register a validation listener which is called whenever a token is validated.

removeValidationListener(ValidationListener) - Method in class com.sap.cloud.security.token.validation.CombiningValidator

Use this method to remove a registered listener so that it is not called anymore.

requestToken(XSTokenRequest) - Method in class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

requestTokenForClient(String, String, String) - Method in class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

runInLegacyMode(boolean) - Method in class com.sap.cloud.security.config.OAuth2ServiceConfigurationBuilder

S

SapIdToken - Class in com.sap.cloud.security.token

You can get further token claims from here: TokenClaims.

SapIdToken(DecodedJwt) - Constructor for class com.sap.cloud.security.token.SapIdToken

SapIdToken(String) - Constructor for class com.sap.cloud.security.token.SapIdToken

SAPOfflineTokenServicesCloud - Class in com.sap.cloud.security.adapter.spring

This constructor requires a dependency to Spring-security oauth, which will be deprecated soon.

SAPOfflineTokenServicesCloud() - Constructor for class com.sap.cloud.security.adapter.spring.SAPOfflineTokenServicesCloud

Constructs an instance which is preconfigured for XSUAA service configuration from SAP CP Environment.

SAPOfflineTokenServicesCloud(OAuth2ServiceConfiguration) - Constructor for class com.sap.cloud.security.adapter.spring.SAPOfflineTokenServicesCloud

Constructs an instance with custom configuration.

SAPOfflineTokenServicesCloud(OAuth2ServiceConfiguration, RestOperations) - Constructor for class com.sap.cloud.security.adapter.spring.SAPOfflineTokenServicesCloud

Constructs an instance with custom configuration and rest template.

ScopeConverter - Interface in com.sap.cloud.security.token

serviceConfiguration - Variable in class com.sap.cloud.security.servlet.AbstractTokenAuthenticator

setLocalScopeAsAuthorities(boolean) - Method in class com.sap.cloud.security.adapter.spring.SAPOfflineTokenServicesCloud

This method allows to overwrite the default behavior of the authorities converter implementation.

SpringSecurityContext - Class in com.sap.cloud.security.adapter.spring

This is an alternative way of accessing jwt tokens of type Token or AccessToken in context of an application using spring-security-oauth2.

T

tokenBody - Variable in class com.sap.cloud.security.token.AbstractToken

tokenHeader - Variable in class com.sap.cloud.security.token.AbstractToken

toString() - Method in class com.sap.cloud.security.token.validation.CombiningValidator

type() - Method in enum com.sap.cloud.security.token.validation.validators.JwtSignatureAlgorithm

V

validate(T) - Method in class com.sap.cloud.security.token.validation.CombiningValidator

validate(T) - Method in interface com.sap.cloud.security.token.validation.Validator

Validates the given object.

validate(Token) - Method in class com.sap.cloud.security.token.validation.validators.JwtAudienceValidator

validate(Token) - Method in class com.sap.cloud.security.token.validation.validators.JwtIssuerValidator

validate(Token) - Method in class com.sap.cloud.security.token.validation.validators.JwtSignatureValidator

validate(Token) - Method in class com.sap.cloud.security.token.validation.validators.JwtTimestampValidator

validate(Token) - Method in class com.sap.cloud.security.token.validation.validators.XsuaaJwtIssuerValidator

validateRequest(ServletRequest, ServletResponse) - Method in class com.sap.cloud.security.servlet.AbstractTokenAuthenticator

ValidationListener - Interface in com.sap.cloud.security.token.validation

Implement this interface to register custom validation listener to the CombiningValidator.

ValidationResult - Interface in com.sap.cloud.security.token.validation

Captures the result of a validation.

ValidationResults - Class in com.sap.cloud.security.token.validation

This is a factory class to easily create ValidationResult objects.

Validator<T> - Interface in com.sap.cloud.security.token.validation

Generic validator interface over type T.

value() - Method in enum com.sap.cloud.security.token.validation.validators.JwtSignatureAlgorithm

valueOf(String) - Static method in enum com.sap.cloud.security.token.validation.validators.JwtSignatureAlgorithm

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.sap.cloud.security.token.validation.validators.JwtSignatureAlgorithm

Returns an array containing the constants of this enum type, in the order they are declared.

W

with(Validator<Token>) - Method in class com.sap.cloud.security.token.validation.validators.JwtValidatorBuilder

Adds a custom validator to the validation chain.

withAudienceValidator(Validator<Token>) - Method in class com.sap.cloud.security.token.validation.validators.JwtValidatorBuilder

Sets / overwrites the default audience validator.

withCacheSize(int) - Method in class com.sap.cloud.security.token.validation.validators.OAuth2TokenKeyServiceWithCache

Caches the Json web keys.

withCacheSize(int) - Method in class com.sap.cloud.security.token.validation.validators.OidcConfigurationServiceWithCache

Caches the Json web keys.

withCacheTime(int) - Method in class com.sap.cloud.security.token.validation.validators.OAuth2TokenKeyServiceWithCache

Caches the Json web keys.

withCacheTime(int) - Method in class com.sap.cloud.security.token.validation.validators.OidcConfigurationServiceWithCache

Caches the Json web keys.

withClientId(String) - Method in class com.sap.cloud.security.config.OAuth2ServiceConfigurationBuilder

Client id of identity service instance.

withClientSecret(String) - Method in class com.sap.cloud.security.config.OAuth2ServiceConfigurationBuilder

Client secret of identity service instance.

withHttpClient(CloseableHttpClient) - Method in class com.sap.cloud.security.servlet.AbstractTokenAuthenticator

withHttpClient(CloseableHttpClient) - Method in class com.sap.cloud.security.token.validation.validators.JwtValidatorBuilder

In case you want to configure the OidcConfigurationService and the the OAuth2TokenKeyService with your own Rest client.

withOAuth2TokenKeyService(OAuth2TokenKeyService) - Method in class com.sap.cloud.security.token.validation.validators.JwtValidatorBuilder

Deprecated.

for internal use only

withOidcConfigurationService(OidcConfigurationService) - Method in class com.sap.cloud.security.token.validation.validators.JwtValidatorBuilder

Deprecated.

for internal use only

withOidcConfigurationService(OidcConfigurationService) - Method in class com.sap.cloud.security.token.validation.validators.OidcConfigurationServiceWithCache

Overwrites the service to be used to request the oidc configuration.

withProperties(Map<String, String>) - Method in class com.sap.cloud.security.config.OAuth2ServiceConfigurationBuilder

withProperty(String, String) - Method in class com.sap.cloud.security.config.OAuth2ServiceConfigurationBuilder

withScopeConverter(ScopeConverter) - Method in class com.sap.cloud.security.token.XsuaaToken

Configures a scope converter, e.g.

withServiceConfiguration(OAuth2ServiceConfiguration) - Method in class com.sap.cloud.security.servlet.AbstractTokenAuthenticator

withTokenKeyService(OAuth2TokenKeyService) - Method in class com.sap.cloud.security.token.validation.validators.OAuth2TokenKeyServiceWithCache

Overwrites the service to be used to request the Json web keys.

withUrl(String) - Method in class com.sap.cloud.security.config.OAuth2ServiceConfigurationBuilder

Base URL of the OAuth2 identity service instance.

withValidationListener(ValidationListener) - Method in class com.sap.cloud.security.servlet.AbstractTokenAuthenticator

Adds the validation listener to the jwt validator that is being used by the authenticator to validate the tokens.

withValidatorListener(ValidationListener) - Method in class com.sap.cloud.security.token.validation.validators.JwtValidatorBuilder

Adds the validation listener to the jwt validator that is being built.

X

XsuaaJwtIssuerValidator - Class in com.sap.cloud.security.token.validation.validators

Validates that the jwt access token is issued by a trust worthy identity service.

XsuaaScopeConverter - Class in com.sap.cloud.security.token

This utility class translates XSUAA scopes that are specified in global form and prefixed with the "appId.", to local ones.

XsuaaScopeConverter(String) - Constructor for class com.sap.cloud.security.token.XsuaaScopeConverter

Creates an instance of the converter.

XsuaaToken - Class in com.sap.cloud.security.token

Decodes and parses encoded access token (JWT) for the Xsuaa identity service and provides access to token header parameters and claims.

XsuaaToken(DecodedJwt) - Constructor for class com.sap.cloud.security.token.XsuaaToken

Creates an instance.

XsuaaToken(String) - Constructor for class com.sap.cloud.security.token.XsuaaToken

Creates an instance.

XsuaaTokenAuthenticator - Class in com.sap.cloud.security.servlet

XsuaaTokenAuthenticator() - Constructor for class com.sap.cloud.security.servlet.XsuaaTokenAuthenticator

XSUserInfoAdapter - Class in com.sap.cloud.security.adapter.xs

XSUserInfoAdapter(Token) - Constructor for class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

XSUserInfoAdapter(AccessToken) - Constructor for class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

A B C D E F G H I J L O R S T V W X