Skip navigation links
A C E F G H I J K N O S T U V Z 

A

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).
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
 
asJsonString() - Method in interface com.sap.cloud.security.json.JsonObject
Returns the json object as a json string.
AUDIENCE - Static variable in class com.sap.cloud.security.token.TokenClaims
 

C

CacheConfiguration - Interface in com.sap.cloud.security.config
Interface used for the configuration of caches.
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.
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.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
 
contains(String) - Method in interface com.sap.cloud.security.json.JsonObject
 
CREDENTIALS - Static variable in class com.sap.cloud.security.config.cf.CFConstants
 

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.
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
Deprecated.
EXTERNAL_ATTRIBUTE_SUBACCOUNTID - Static variable in class com.sap.cloud.security.token.TokenClaims.XSUAA
 
EXTERNAL_ATTRIBUTE_ZDN - Static variable in class com.sap.cloud.security.token.TokenClaims.XSUAA
 

F

FAMILY_NAME - Static variable in class com.sap.cloud.security.token.TokenClaims
 
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
 

G

getAccessToken() - Static method in class com.sap.cloud.security.token.SecurityContext
Returns the token that is saved in thread wide storage.
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 interface com.sap.cloud.security.json.JsonObject
Parses the json object for the given property name and returns a list of type T.
getAsLong(String) - Method in interface com.sap.cloud.security.json.JsonObject
Returns a Long identified by the given property name.
getAsString(String) - Method in interface com.sap.cloud.security.json.JsonObject
Returns the string identified by the given property name.
getAudiences() - Method in interface com.sap.cloud.security.token.Token
Returns the (empty) list of audiences the token is issued for.
getCacheDuration() - Method in interface com.sap.cloud.security.config.CacheConfiguration
Returns the duration of the expire after write property of the cache.
getCacheSize() - Method in interface com.sap.cloud.security.config.CacheConfiguration
Returns the number of elements the cache can hold.
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 interface com.sap.cloud.security.token.Token
Extracts the value of the given as a JsonObject.
getClaimAsString(String) - Method in interface com.sap.cloud.security.token.Token
Extracts the value as string for the given claim.
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 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.
getExpiration() - Method in interface com.sap.cloud.security.token.Token
Returns the moment in time when the token will be expired.
getGrantType() - Method in interface com.sap.cloud.security.token.AccessToken
Returns the grant type of the jwt token.
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 interface com.sap.cloud.security.config.Environment
Return OAuth service configuration of IAS identity service instance.
getJsonObject(String) - Method in interface com.sap.cloud.security.json.JsonObject
Returns a nested JSON object as @{link JsonObject} instance.
getJsonObjects(String) - Method in interface com.sap.cloud.security.json.JsonObject
Returns a nested array of JSON objects as list of JsonObject instances.
getKeyValueMap() - Method in interface com.sap.cloud.security.json.JsonObject
Returns a key-value map of the JSON properties.
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 interface com.sap.cloud.security.config.Environment
Returns number of Xsuaa identity service instances.
getPrincipal() - Method in interface com.sap.cloud.security.servlet.TokenAuthenticationResult
The principal associated with the request.
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.
getProperty(String) - Method in interface com.sap.cloud.security.config.OAuth2ServiceConfiguration
Returns the value of the given property as string.
getScopes() - Method in interface 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".
getService() - Method in interface com.sap.cloud.security.config.OAuth2ServiceConfiguration
Returns the identity Service of this configuration.
getService() - Method in interface com.sap.cloud.security.token.Token
Returns the identity service, the token is issued by.
getToken() - Method in interface 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 interface com.sap.cloud.security.token.Token
Get the encoded jwt token, e.g.
getType() - Method in interface com.sap.cloud.security.config.Environment
 
getUnauthenticatedReason() - Method in interface com.sap.cloud.security.servlet.TokenAuthenticationResult
If not authenticated, this returns the reason why as text.
getUrl() - Method in interface com.sap.cloud.security.config.OAuth2ServiceConfiguration
Base URL of the OAuth2 identity service instance.
getXsuaaConfiguration() - Method in interface com.sap.cloud.security.config.Environment
Return OAuth service configuration of Xsuaa identity service instance.
getXsuaaConfigurationForTokenExchange() - Method in interface com.sap.cloud.security.config.Environment
In case there is only one Xsuaa identity service instance, this one gets returned.
getZoneId() - Method in interface com.sap.cloud.security.token.Token
Returns the Zone identifier, which can be used as tenant discriminator (tenant guid).
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

hasClaim(String) - Method in interface com.sap.cloud.security.token.Token
Checks whether the token contains a given claim.
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.
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.

I

IDENTITY_ZONE - Static variable in class com.sap.cloud.security.config.cf.CFConstants.XSUAA
 
isAuthenticated() - Method in interface com.sap.cloud.security.servlet.TokenAuthenticationResult
 
isCacheDisabled() - Method in interface com.sap.cloud.security.config.CacheConfiguration
Caching is disabled when this returns true.
isEmpty() - Method in interface com.sap.cloud.security.json.JsonObject
Method to check if the underlying json object is empty.
isExpired() - Method in interface com.sap.cloud.security.token.Token
Returns true if the token is expired.
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
 

J

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
 

K

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

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.
ORIGIN - Static variable in class com.sap.cloud.security.token.TokenClaims.XSUAA
 

S

SAP_GLOBAL_USER_ID - Static variable in class com.sap.cloud.security.token.TokenClaims
 
SAP_GLOBAL_ZONE_ID - Static variable in class com.sap.cloud.security.token.TokenClaims
 
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
 
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 - Interface in com.sap.cloud.security.servlet
Class that represents the result of the authentication check 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.
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 - Class in com.sap.cloud.security.token
Constants denoting Jwt header parameters.
toString() - Method in enum com.sap.cloud.security.token.GrantType
 
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
 

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

validateRequest(ServletRequest, ServletResponse) - Method in interface com.sap.cloud.security.servlet.TokenAuthenticator
Performs the authentication for the given request.
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.
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.
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
 

Z

ZONE_ID - Static variable in class com.sap.cloud.security.token.TokenClaims.XSUAA
 
A C E F G H I J K N O S T U V Z 
Skip navigation links

Copyright © 2020. All rights reserved.