Index (java-security 3.0.0 API)

A B C D E F G H I J N O R S T V W X
All Classes and Interfaces|All Packages|Serialized Form

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
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.token.validation.validators.JwtValidatorBuilder: Builds the validators with the applied parameters.

C

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.OidcConfigurationServiceWithCache
com.sap.cloud.security.adapter.spring - package com.sap.cloud.security.adapter.spring
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
com.sap.cloud.security.x509 - package com.sap.cloud.security.x509
CombiningValidator<T> - Class in com.sap.cloud.security.token.validation: This is a special validator that combines several validators into one.
CombiningValidator(Validator<T>...) - Constructor for class com.sap.cloud.security.token.validation.CombiningValidator
CombiningValidator(List<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.
convert(Collection<String>) - Method in interface com.sap.cloud.security.token.ScopeConverter
convert(Collection<String>) - Method in class com.sap.cloud.security.token.XsuaaScopeConverter
create(String) - Method in class com.sap.cloud.security.servlet.HybridTokenFactory: Determines whether the JWT token is issued by XSUAA or IAS identity service, and creates a Token for it.
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

disableTenantIdCheck() - Method in class com.sap.cloud.security.token.validation.validators.JwtValidatorBuilder: Disables tenant id check for JwtSignatureValidator.

E

equals(Object) - Method in class com.sap.cloud.security.token.AbstractToken
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.IasTokenAuthenticator
extractFromHeader(String) - Method in class com.sap.cloud.security.servlet.XsuaaTokenAuthenticator

F

fromType(String) - Static method in enum class com.sap.cloud.security.token.validation.validators.JwtSignatureAlgorithm
fromValue(String) - Static method in enum class 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.
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
getClaims() - Method in class com.sap.cloud.security.token.AbstractToken
getClientId() - Method in class com.sap.cloud.security.token.XsuaaToken
getCnfX509Thumbprint() - Method in class com.sap.cloud.security.token.SapIdToken
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
getGrantType() - Method in class com.sap.cloud.security.token.XsuaaToken
getHeaderParameterAsString(String) - Method in class com.sap.cloud.security.token.AbstractToken
getHeaders() - Method in class com.sap.cloud.security.token.AbstractToken
getInstance() - Static method in class com.sap.cloud.security.token.validation.validators.OidcConfigurationServiceWithCache: Creates a new instance.
getInstance(OAuth2ServiceConfiguration) - Static method in class com.sap.cloud.security.token.validation.validators.JwtValidatorBuilder: Creates a builder instance that can be configured further.
getIssuer() - Method in class com.sap.cloud.security.token.SapIdToken: Gets the token issuer domain that is required to check trust in the issuing identity service.
getNotBefore() - Method in class com.sap.cloud.security.token.AbstractToken
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.
getOtherServiceConfiguration() - Method in class com.sap.cloud.security.servlet.AbstractTokenAuthenticator: Return other configured service configurations or null if not configured.
getOtherServiceConfiguration() - Method in class com.sap.cloud.security.servlet.IasTokenAuthenticator
getOtherServiceConfiguration() - Method in class com.sap.cloud.security.servlet.XsuaaTokenAuthenticator
getPrincipal() - Method in class com.sap.cloud.security.token.SapIdToken
getPrincipal() - Method in class com.sap.cloud.security.token.XsuaaToken
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.IasTokenAuthenticator
getServiceConfiguration() - Method in class com.sap.cloud.security.servlet.XsuaaTokenAuthenticator
getSubaccountId() - Method in class com.sap.cloud.security.token.XsuaaToken
getSubdomain() - Method in class com.sap.cloud.security.token.XsuaaToken: Returns the value of the subdomain (zdn) from the external attribute ext_attr (ext_attr) claim.
getSubjectDN() - Method in class com.sap.cloud.security.x509.X509Certificate
getSubjectDNMap() - Method in class com.sap.cloud.security.x509.X509Certificate
getThumbprint() - Method in class com.sap.cloud.security.x509.X509Certificate
getToken() - Static method in class com.sap.cloud.security.adapter.spring.SpringSecurityContext: Returns the token using SecurityContextHolder.
getTokenValue() - Method in class com.sap.cloud.security.token.AbstractToken
getTrustedClientIds() - Method in class com.sap.cloud.security.token.validation.validators.JwtAudienceValidator
getValidators() - Method in class com.sap.cloud.security.token.validation.CombiningValidator
getZoneId() - Method in class com.sap.cloud.security.token.AbstractToken
getZoneId() - Method in class com.sap.cloud.security.token.XsuaaToken

H

hasClaim(String) - Method in class com.sap.cloud.security.token.AbstractToken
hashCode() - Method in class com.sap.cloud.security.token.AbstractToken
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
HybridTokenFactory - Class in com.sap.cloud.security.servlet: Creates a Token instance.
HybridTokenFactory() - Constructor for class com.sap.cloud.security.servlet.HybridTokenFactory

I

IasTokenAuthenticator - Class in com.sap.cloud.security.servlet
IasTokenAuthenticator() - Constructor for class com.sap.cloud.security.servlet.IasTokenAuthenticator
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
isValid() - Method in interface com.sap.cloud.security.token.validation.ValidationResult: Returns true if there is no validation error, false otherwise.
isXsuaaToken() - Method in class com.sap.cloud.security.token.AbstractToken

J

javaSignature() - Method in enum class 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.
JwtSignatureAlgorithm - Enum Class in com.sap.cloud.security.token.validation.validators: This is represented by "kty" (Key Type) Parameter.
JwtValidatorBuilder - Class in com.sap.cloud.security.token.validation.validators: Class used to build a token validator for an OAuth service configuration OAuth2ServiceConfiguration.
JwtX5tValidator - Class in com.sap.cloud.security.token.validation.validators: Validates if the jwt access token is intended for the OAuth2 client of this application, in certificate based authentication scenario.
JwtX5tValidator(OAuth2ServiceConfiguration) - Constructor for class com.sap.cloud.security.token.validation.validators.JwtX5tValidator

N

newCertificate(String) - Static method in class com.sap.cloud.security.x509.X509Certificate: Creates a new instance of X.509 certificate.

O

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

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.
RS256 - Enum constant in enum class com.sap.cloud.security.token.validation.validators.JwtSignatureAlgorithm

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
ScopeConverter - Interface in com.sap.cloud.security.token
serviceConfiguration - Variable in class com.sap.cloud.security.servlet.AbstractTokenAuthenticator
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.AbstractToken
toString() - Method in class com.sap.cloud.security.token.validation.CombiningValidator
type() - Method in enum class com.sap.cloud.security.token.validation.validators.JwtSignatureAlgorithm

V

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.JwtX5tValidator: Validates the cnf thumbprint of X509 certificate against trusted certificate's thumbprint.
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.
validateRequest(ServletRequest, ServletResponse) - Method in class com.sap.cloud.security.servlet.AbstractTokenAuthenticator
validateRequest(ServletRequest, ServletResponse) - Method in class com.sap.cloud.security.servlet.IasTokenAuthenticator
validateRequest(ServletRequest, ServletResponse) - Method in class com.sap.cloud.security.servlet.XsuaaTokenAuthenticator
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 Validator.
value() - Method in enum class com.sap.cloud.security.token.validation.validators.JwtSignatureAlgorithm
valueOf(String) - Static method in enum class com.sap.cloud.security.token.validation.validators.JwtSignatureAlgorithm: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.sap.cloud.security.token.validation.validators.JwtSignatureAlgorithm: Returns an array containing the constants of this enum class, 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.
withCacheConfiguration(CacheConfiguration) - Method in class com.sap.cloud.security.servlet.AbstractTokenAuthenticator: Use to configure the token key cache.
withCacheConfiguration(CacheConfiguration) - Method in class com.sap.cloud.security.token.validation.validators.JwtValidatorBuilder: Use to configure the token key cache.
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.OidcConfigurationServiceWithCache: Caches the Json web keys.
withHttpClient(CloseableHttpClient) - Method in class com.sap.cloud.security.servlet.AbstractTokenAuthenticator: Use to configure the HttpClient that is used to retrieve token keys or to perform a token-exchange.
withHttpClient(CloseableHttpClient) - Method in class com.sap.cloud.security.servlet.XsuaaTokenAuthenticator
withHttpClient(CloseableHttpClient) - Method in class com.sap.cloud.security.token.validation.validators.JwtValidatorBuilder: In case you want to configure the OidcConfigurationService and 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.
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: Use to override the service configuration used.
withServiceConfiguration(OAuth2ServiceConfiguration) - Method in class com.sap.cloud.security.servlet.XsuaaTokenAuthenticator
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

X509Certificate - Class in com.sap.cloud.security.x509: The X.509 certificate
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

A B C D E F G H I J N O R S T V W X
All Classes and Interfaces|All Packages|Serialized Form