C G H I R S T X

C

checkLocalScope(String) - Method in interface com.sap.xsa.security.container.XSUserInfo

Deprecated.

can be replaced with xsuaaToken.hasLocalScope(scope) from the com.sap.cloud.security.token package.

checkScope(String) - Method in interface com.sap.xsa.security.container.XSUserInfo

Deprecated.

can be replaced with xsuaaToken.hasScope(scope) from the com.sap.cloud.security.token package.

com.sap.xsa.security.container - package com.sap.xsa.security.container

G

getAdditionalAuthAttribute(String) - Method in interface com.sap.xsa.security.container.XSUserInfo

Return additional authentication attributes included by the OAuth client component.

getAdditionalAuthorizationAttributes() - Method in interface com.sap.xsa.security.container.XSTokenRequest

Returns the list of requested additional authorization attributes, or null if no additional authorization attributes have been set.

getAppToken() - Method in interface com.sap.xsa.security.container.XSUserInfo

Deprecated.

Can be replaced with token.getAccessToken() from the com.sap.cloud.security.token package.

getAttribute(String) - Method in interface com.sap.xsa.security.container.XSUserInfo

Return user attributes.

getClientId() - Method in interface com.sap.xsa.security.container.XSTokenRequest

Returns the OAuth 2.0 client ID, if set, that will be used to authenticate the client

getClientId() - Method in interface com.sap.xsa.security.container.XSUserInfo

Deprecated.

Can be replaced with token.getClaimAsString(TokenClaims.XSUAA.CLIENT_ID) from the com.sap.cloud.security.token package.

getClientSecret() - Method in interface com.sap.xsa.security.container.XSTokenRequest

Returns the OAuth 2.0 client secret, if set, that will be used to authenticate the client

getCloneServiceInstanceId() - Method in interface com.sap.xsa.security.container.XSUserInfo

In case of xsuaa broker plan tokens, it contains the service instance id Still Supported via XSUserInfoAdapter from the com.sap.cloud.security.adapter.xs package.

getDBToken() - Method in interface com.sap.xsa.security.container.XSUserInfo

Deprecated.

use XSUserInfo.getHdbToken() instead.

getEmail() - Method in interface com.sap.xsa.security.container.XSUserInfo

Deprecated.

Can be replaced with token.getClaimAsString(TokenClaims.EMAIL) from the com.sap.cloud.security.token package.

getFamilyName() - Method in interface com.sap.xsa.security.container.XSUserInfo

Deprecated.

Can be replaced with token.getClaimAsString(TokenClaims.FAMILY_NAME) from the com.sap.cloud.security.token package. Only if it is not an external attribute.

getGivenName() - Method in interface com.sap.xsa.security.container.XSUserInfo

Deprecated.

Can be replaced with token.getClaimAsString(TokenClaims.GIVEN_NAME) from the com.sap.cloud.security.token package. Only if it is not an external attribute.

getGrantType() - Method in interface com.sap.xsa.security.container.XSUserInfo

Deprecated.

can be replaced with token.getGrantType() from the com.sap.cloud.security.token package. This will give you a GrantType enum entry on which you can call toString to obtain the grant type as string, e.g. "client_credentials".

getHdbToken() - Method in interface com.sap.xsa.security.container.XSUserInfo

Still Supported via XSUserInfoAdapter from the com.sap.cloud.security.adapter.xs package.

getIdentityZone() - Method in interface com.sap.xsa.security.container.XSUserInfo

Deprecated.

Have to be replaced with XSUserInfo.getZoneId() or XSUserInfo.getSubaccountId().

getJsonValue(String) - Method in interface com.sap.xsa.security.container.XSUserInfo

Deprecated.

Can be replaced with token.getClaimAsString(attribute) from the com.sap.cloud.security.token package.

getLogonName() - Method in interface com.sap.xsa.security.container.XSUserInfo

Deprecated.

Can be replaced with token.getClaimAsString(TokenClaims.USER_NAME) from the com.sap.cloud.security.token package or with token.getPrincipal().

getOrigin() - Method in interface com.sap.xsa.security.container.XSUserInfo

Deprecated.

Can be replaced with token.getClaimAsString(TokenClaims.XSUAA.ORIGIN) from the com.sap.cloud.security.token package.

getSubaccountId() - Method in interface com.sap.xsa.security.container.XSUserInfo

Return subaccount identifier.

getSubdomain() - Method in interface com.sap.xsa.security.container.XSUserInfo

Supported via XSUserInfoAdapter from the com.sap.cloud.security.adapter.xs package.

getSystemAttribute(String) - Method in interface com.sap.xsa.security.container.XSUserInfo

Still Supported via XSUserInfoAdapter from the com.sap.cloud.security.adapter.xs package.

getToken(String, String) - Method in interface com.sap.xsa.security.container.XSUserInfo

Deprecated.

use XSUserInfo.getHdbToken() instead.

getTokenEndpoint() - Method in interface com.sap.xsa.security.container.XSTokenRequest

Returns the token exchange endpoint URI.

getType() - Method in interface com.sap.xsa.security.container.XSTokenRequest

Returns the type of the requested token

getZoneId() - Method in interface com.sap.xsa.security.container.XSUserInfo

Deprecated.

Can be replaced with token.getZoneId() from the com.sap.cloud.security.token package.

H

hasAttributes() - Method in interface com.sap.xsa.security.container.XSUserInfo

Check if the authentication token contains user attributes.

I

isInForeignMode() - Method in interface com.sap.xsa.security.container.XSUserInfo

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

isValid() - Method in interface com.sap.xsa.security.container.XSTokenRequest

Returns true if this object contains enough information to retrieve a token

R

requestToken(XSTokenRequest) - Method in interface com.sap.xsa.security.container.XSUserInfo

Deprecated.

can be replaced with token flows from the token-client library. Does not support mtls-based communication to XSUAA identity provider and will be removed with version 3.0.0.

requestTokenForClient(String, String, String) - Method in interface com.sap.xsa.security.container.XSUserInfo

Deprecated.

can be replaced with token flows from the token-client library. Does not support mtls-based communication to XSUAA identity provider and will be removed with version 3.0.0.

requestTokenForUser(String, String, String) - Method in interface com.sap.xsa.security.container.XSUserInfo

Deprecated.

can be replaced with token flows from the token-client library. Does not support mtls-based communication to XSUAA identity provider and will be removed with version 3.0.0.

S

setAdditionalAuthorizationAttributes(Map<String, String>) - Method in interface com.sap.xsa.security.container.XSTokenRequest

Sets the requested additional authorization attributes list for this token request.

setClientId(String) - Method in interface com.sap.xsa.security.container.XSTokenRequest

Sets the OAuth 2.0 client ID to be used for authentication during the token request

setClientSecret(String) - Method in interface com.sap.xsa.security.container.XSTokenRequest

Sets the OAuth 2.0 client secret to be used for authentication during the token request

setTokenEndpoint(URI) - Method in interface com.sap.xsa.security.container.XSTokenRequest

Set the token endpoint URI

setType(int) - Method in interface com.sap.xsa.security.container.XSTokenRequest

Set the requested token type

T

TYPE_CLIENT_CREDENTIALS_TOKEN - Static variable in interface com.sap.xsa.security.container.XSTokenRequest

TYPE_USER_TOKEN - Static variable in interface com.sap.xsa.security.container.XSTokenRequest

X

XSPrincipal - Interface in com.sap.xsa.security.container

deprecated with version 2.4.0 in favor of the new SAP Java Client library.

XSTokenRequest - Interface in com.sap.xsa.security.container

Represents a token exchange request.

XSUserInfo - Interface in com.sap.xsa.security.container

API for OAuth resource servers to extract authentication and authorization information from the OAuth token.

XSUserInfoException - Exception in com.sap.xsa.security.container

deprecated with version 2.4.0 in favor of the new SAP Java Client library.

XSUserInfoException(String) - Constructor for exception com.sap.xsa.security.container.XSUserInfoException

XSUserInfoException(String, Throwable) - Constructor for exception com.sap.xsa.security.container.XSUserInfoException

C G H I R S T X