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

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

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

Represents an access token in the format of a JSON Web Token (not a short opaque token).

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

ALGORITHM - Static variable in class com.sap.cloud.security.token.TokenHeader

APP_ID - Static variable in class com.sap.cloud.security.config.cf.CFConstants.XSUAA

AUDIENCE - Static variable in class com.sap.cloud.security.token.TokenClaims

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

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

Constants that simplifies access to service configuration properties in the Cloud Foundry environment.

CFConstants.IAS - Class in com.sap.cloud.security.config.cf

Constants that are specific to the Ias identity service.

CFConstants.Plan - Enum in com.sap.cloud.security.config.cf

Represents the service plans on CF marketplace.

CFConstants.XSUAA - Class in com.sap.cloud.security.config.cf

Constants that are specific to the Xsuaa identity service.

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

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

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

clearToken() - Static method in class com.sap.cloud.security.token.SecurityContext

Clears the current Token from thread wide storage.

CLIENT_ID - Static variable in class com.sap.cloud.security.config.cf.CFConstants

CLIENT_ID - Static variable in class com.sap.cloud.security.token.TokenClaims.XSUAA

CLIENT_SECRET - Static variable in class com.sap.cloud.security.config.cf.CFConstants

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

contains(String) - Method in interface com.sap.cloud.security.json.JsonObject

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

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

createAuthenticated(Collection<String>, Token) - Static method in class com.sap.cloud.security.servlet.TokenAuthenticationResult

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

createUnauthenticated(String) - Static method in class com.sap.cloud.security.servlet.TokenAuthenticationResult

Creates an unauthenticated result with a reason.

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

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

CREDENTIALS - Static variable in class com.sap.cloud.security.config.cf.CFConstants

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

EMAIL - Static variable in class com.sap.cloud.security.token.TokenClaims

Environment - Interface in com.sap.cloud.security.config

Central entry point to access the OAuth configuration (OAuth2ServiceConfiguration) of a supported identity Service.

Environment.Type - Enum in com.sap.cloud.security.config

Represents a supported SAP CP environment.

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

EXPIRATION - Static variable in class com.sap.cloud.security.token.TokenClaims

EXTERNAL_ATTRIBUTE - Static variable in class com.sap.cloud.security.token.TokenClaims.XSUAA

EXTERNAL_ATTRIBUTE_ENHANCER - Static variable in class com.sap.cloud.security.token.TokenClaims.XSUAA

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

FAMILY_NAME - Static variable in class com.sap.cloud.security.token.TokenClaims

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

Creates a builder for a dedicated identity (Service)

from(String) - Static method in enum com.sap.cloud.security.config.cf.CFConstants.Plan

from(String) - Static method in enum com.sap.cloud.security.config.Environment.Type

from(String) - Static method in enum com.sap.cloud.security.token.GrantType

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.token.SecurityContext

Returns the token that is saved in thread wide storage.

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

getAsInstant(String) - Method in interface com.sap.cloud.security.json.JsonObject

Returns an Instant identified by the given property name.

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

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

Parses the json object for the given property name and returns a list of type T.

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

getAsString(String) - Method in interface com.sap.cloud.security.json.JsonObject

Returns the string identified by the given property name.

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

getAudiences() - Method in interface com.sap.cloud.security.token.Token

Returns the (empty) list of audiences the token is issued for.

getCFName() - Method in enum com.sap.cloud.security.config.Service

Returns the name of the identity service as it appears on Cloud Foundry marketplace.

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

getClaimAsJsonObject(String) - Method in interface com.sap.cloud.security.token.Token

Extracts the value of the given as a JsonObject.

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

getClaimAsString(String) - Method in interface com.sap.cloud.security.token.Token

Extracts the value as string for the given claim.

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

getClaimAsStringList(String) - Method in interface com.sap.cloud.security.token.Token

Extracts the value as a list of strings for the given claim.

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

getClientId() - Method in interface com.sap.cloud.security.config.OAuth2ServiceConfiguration

Client id of identity service instance.

getClientSecret() - Method in interface com.sap.cloud.security.config.OAuth2ServiceConfiguration

Client secret of identity service instance.

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

getExpiration() - Method in interface com.sap.cloud.security.token.Token

Returns the moment in time when the token will be expired.

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 interface com.sap.cloud.security.token.AccessToken

Returns the grant type of the jwt token.

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

getHeaderParameterAsString(String) - Method in interface com.sap.cloud.security.token.Token

Returns the header parameter value as string for the given header parameter name.

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

getJsonObject(String) - Method in interface com.sap.cloud.security.json.JsonObject

Returns a nested JSON object as @{link JsonObject} instance.

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

getJsonObjects(String) - Method in interface com.sap.cloud.security.json.JsonObject

Returns a nested array of JSON objects as list of JsonObject instances.

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

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

getKeyValueMap() - Method in interface com.sap.cloud.security.json.JsonObject

Returns a key-value map of the JSON properties.

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

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

getNotBefore() - Method in interface com.sap.cloud.security.token.Token

Returns the moment in time before which the token must not be accepted.

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

getNumberOfXsuaaConfigurations() - Method in interface com.sap.cloud.security.config.Environment

Returns number of Xsuaa identity service instances.

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.servlet.TokenAuthenticationResult

The principal associated with the request.

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

getPrincipal() - Method in interface com.sap.cloud.security.token.Token

Returns a principal, which can be used to represent any entity, such as an individual, a corporation, and a login id.

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

getProperty(String) - Method in interface com.sap.cloud.security.config.OAuth2ServiceConfiguration

Returns the value of the given property as string.

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.servlet.TokenAuthenticationResult

The authentication scopes.

getScopes() - Method in interface com.sap.cloud.security.token.AccessToken

Returns the list of the claim "scope".

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

getService() - Method in interface com.sap.cloud.security.config.OAuth2ServiceConfiguration

Returns the identity Service of this configuration.

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

getService() - Method in interface com.sap.cloud.security.token.Token

Returns the identity service, the token is issued by.

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(String, String) - Method in class com.sap.cloud.security.adapter.xs.XSUserInfoAdapter

getToken() - Method in class com.sap.cloud.security.servlet.TokenAuthenticationResult

The token that was checked for authentication.

getToken() - Static method in class com.sap.cloud.security.token.SecurityContext

Returns the token that is saved in thread wide storage.

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

getTokenValue() - Method in interface com.sap.cloud.security.token.Token

Get the encoded jwt token, e.g.

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

getType() - Method in interface com.sap.cloud.security.config.Environment

getUnauthenticatedReason() - Method in class com.sap.cloud.security.servlet.TokenAuthenticationResult

If not authenticated, this returns the reason why as text.

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

getUrl() - Method in interface com.sap.cloud.security.config.OAuth2ServiceConfiguration

Base URL of the OAuth2 identity service instance.

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

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

getXsuaaConfiguration() - Method in interface com.sap.cloud.security.config.Environment

Return OAuth service configuration of Xsuaa identity service instance.

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

getXsuaaConfigurationForTokenExchange() - Method in interface com.sap.cloud.security.config.Environment

In case there is only one Xsuaa identity service instance, this one gets returned.

GIVEN_NAME - Static variable in class com.sap.cloud.security.token.TokenClaims

GRANT_TYPE - Static variable in class com.sap.cloud.security.token.TokenClaims.XSUAA

GrantType - Enum in com.sap.cloud.security.token

Constants denoting the grant type of a Jwt access token as specified here: https://tools.ietf.org/html/rfc6749

H

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

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

hasClaim(String) - Method in interface com.sap.cloud.security.token.Token

Checks whether the token contains a given claim.

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

hasHeaderParameter(String) - Method in interface com.sap.cloud.security.token.Token

Checks whether the token contains a given header parameter.

hasLocalScope(String) - Method in interface com.sap.cloud.security.token.AccessToken

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

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

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

hasProperty(String) - Method in interface com.sap.cloud.security.config.OAuth2ServiceConfiguration

Returns true if the configuration contains the given property.

hasScope(String) - Method in interface com.sap.cloud.security.token.AccessToken

Checks if a scope is available in the access token.

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

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

I

IDENTITY_ZONE - Static variable in class com.sap.cloud.security.config.cf.CFConstants.XSUAA

isAuthenticated() - Method in class com.sap.cloud.security.servlet.TokenAuthenticationResult

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

isEmpty() - Method in interface com.sap.cloud.security.json.JsonObject

Method to check if the underlying json object is empty.

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

isExpired() - Method in interface com.sap.cloud.security.token.Token

Returns true if the token is expired.

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,

isLegacyMode() - Method in interface com.sap.cloud.security.config.OAuth2ServiceConfiguration

Returns true, in case of XSUAA service runs in legacy mode.

ISSUED_AT - Static variable in class com.sap.cloud.security.token.TokenClaims.XSUAA

ISSUER - Static variable in class com.sap.cloud.security.token.TokenClaims

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

JsonObject - Interface in com.sap.cloud.security.json

Interface used to expose JSON data.

JsonParsingException - Exception in com.sap.cloud.security.json

An extraordinary runtime exception during json parsing.

JsonParsingException(String) - Constructor for exception com.sap.cloud.security.json.JsonParsingException

JWKS_URL - Static variable in class com.sap.cloud.security.token.TokenHeader

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.

K

KEY_ID - Static variable in class com.sap.cloud.security.token.TokenHeader

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

N

NOT_BEFORE - Static variable in class com.sap.cloud.security.token.TokenClaims

O

OAuth2ServiceConfiguration - Interface in com.sap.cloud.security.config

Provides information of the identity Service.

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

ORIGIN - Static variable in class com.sap.cloud.security.token.TokenClaims.XSUAA

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 oauth.

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

SCOPES - Static variable in class com.sap.cloud.security.token.TokenClaims.XSUAA

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

Thread wide Token storage.

Service - Enum in com.sap.cloud.security.config

Represents a supported identity service.

SERVICE_PLAN - Static variable in class com.sap.cloud.security.config.cf.CFConstants

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.

setToken(Token) - Static method in class com.sap.cloud.security.token.SecurityContext

Saves the validated (!) token thread wide.

SUBJECT - Static variable in class com.sap.cloud.security.token.TokenClaims

T

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

Represents a JSON Web Token (JWT).

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

Class to collect the result of the authentication performed by a TokenAuthenticator.

TokenAuthenticator - Interface in com.sap.cloud.security.servlet

TokenAuthenticator is used to authenticate a user sending servlet requests to a service via token.

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

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

Constants denoting JWT claims as specified here: https://tools.ietf.org/html/rfc7519#section-4

TokenClaims.XSUAA - Class in com.sap.cloud.security.token

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

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

Constants denoting Jwt header parameters.

toString() - Method in enum com.sap.cloud.security.token.GrantType

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

TRUSTED_CLIENT_ID_SUFFIX - Static variable in class com.sap.cloud.security.token.TokenClaims.XSUAA

TYPE - Static variable in class com.sap.cloud.security.token.TokenHeader

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

U

UAA_DOMAIN - Static variable in class com.sap.cloud.security.config.cf.CFConstants.XSUAA

URL - Static variable in class com.sap.cloud.security.config.cf.CFConstants

USER_NAME - Static variable in class com.sap.cloud.security.token.TokenClaims

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

validateRequest(ServletRequest, ServletResponse) - Method in interface com.sap.cloud.security.servlet.TokenAuthenticator

Performs the authentication for the given request.

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.config.cf.CFConstants.Plan

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

valueOf(String) - Static method in enum com.sap.cloud.security.config.Environment.Type

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

valueOf(String) - Static method in enum com.sap.cloud.security.config.Service

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

valueOf(String) - Static method in enum com.sap.cloud.security.token.GrantType

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

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.config.cf.CFConstants.Plan

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

values() - Static method in enum com.sap.cloud.security.config.Environment.Type

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

values() - Static method in enum com.sap.cloud.security.config.Service

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

values() - Static method in enum com.sap.cloud.security.token.GrantType

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

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.

VCAP_APPLICATION - Static variable in class com.sap.cloud.security.config.cf.CFConstants

VCAP_SERVICES - Static variable in class com.sap.cloud.security.config.cf.CFConstants

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

Z

ZONE_ID - Static variable in class com.sap.cloud.security.token.TokenClaims.XSUAA

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