com.sap.cloud.sdk.cloudplatform.connectivity

Class XsuaaService

java.lang.Object

com.sap.cloud.sdk.cloudplatform.connectivity.XsuaaService

public class XsuaaService
extends Object

This class handles the communication (and the caching of the responses) with an XSUAA service instance.

Constructor Summary

Constructors

Constructor and Description
XsuaaService() Creates a new XsuaaService instance, caching up to 100.000 responses for 60 minutes.

Method Summary

Modifier and Type	Method and Description
Header	retrieveAccessTokenHeaderViaClientCredentialsGrant(URI xsuaaUri, ClientCredentials credentials) Retrieves an AccessToken for a given pair of client credentials and returns it as part of an Authorization header.
Header	retrieveAccessTokenHeaderViaUserTokenExchange(URI xsuaaUri, ClientCredentials credentials) Retrieves a AccessToken for a given pair of client credentials in the name of an authenticated user (to be found in the JWT of the current request) with Refresh Token based authentication and returns the token as part of an Authorization header.
Header	retrieveAccessTokenHeaderViaUserTokenGrant(URI xsuaaUri, ClientCredentials credentials) Retrieves an AccessToken for a given pair of client credentials in the name of an authenticated user (to be found in the JWT of the current request) and returns it as part of an Authorization header.
AccessToken	retrieveAccessTokenViaClientCredentialsGrant(URI xsuaaUri, ClientCredentials credentials) Retrieves an AccessToken for a given pair of client credentials.
AccessToken	retrieveAccessTokenViaUserTokenExchange(URI xsuaaUri, ClientCredentials credentials) Retrieves an AccessToken through User Token Exchange for the currently active user token and the given pair of client credentials.
AccessToken	retrieveAccessTokenViaUserTokenGrant(URI xsuaaUri, ClientCredentials credentials) Retrieves an AccessToken for the currently active user token and the client id.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XsuaaService

public XsuaaService()

Creates a new XsuaaService instance, caching up to 100.000 responses for 60 minutes.

Method Detail

retrieveAccessTokenHeaderViaClientCredentialsGrant

@Nonnull
public Header retrieveAccessTokenHeaderViaClientCredentialsGrant(@Nonnull
                                                                          URI xsuaaUri,
                                                                          @Nonnull
                                                                          ClientCredentials credentials)

Retrieves an AccessToken for a given pair of client credentials and returns it as part of an Authorization header.

Parameters:

xsuaaUri - The xsuaa service URI to retrieve the token from.

credentials - The client credentials to retrieve the token for.

Returns:

A HttpHeaders.AUTHORIZATION header with the retrieved access token.

Throws:

TokenRequestFailedException - When the token cannot be requested or correctly parsed.

TokenRequestDeniedException - When the authorization for the token request was rejected.

See Also:

retrieveAccessTokenViaClientCredentialsGrant(java.net.URI, com.sap.cloud.sdk.cloudplatform.security.ClientCredentials)

retrieveAccessTokenHeaderViaUserTokenGrant

@Nonnull
public Header retrieveAccessTokenHeaderViaUserTokenGrant(@Nonnull
                                                                  URI xsuaaUri,
                                                                  @Nonnull
                                                                  ClientCredentials credentials)

Retrieves an AccessToken for a given pair of client credentials in the name of an authenticated user (to be found in the JWT of the current request) and returns it as part of an Authorization header.

Parameters:

xsuaaUri - The xsuaa service URI to retrieve the token from.

credentials - The client credentials to retrieve the token for.

Returns:

A HttpHeaders.AUTHORIZATION header with the retrieved access token.

Throws:

TokenRequestFailedException - When the token cannot be requested or correctly parsed.

TokenRequestDeniedException - When the authorization for the token request was rejected.

See Also:

retrieveAccessTokenViaUserTokenGrant(java.net.URI, com.sap.cloud.sdk.cloudplatform.security.ClientCredentials), retrieveAccessTokenViaUserTokenExchange(java.net.URI, com.sap.cloud.sdk.cloudplatform.security.ClientCredentials)

retrieveAccessTokenHeaderViaUserTokenExchange

@Nonnull
public Header retrieveAccessTokenHeaderViaUserTokenExchange(@Nonnull
                                                                     URI xsuaaUri,
                                                                     @Nonnull
                                                                     ClientCredentials credentials)

Retrieves a AccessToken for a given pair of client credentials in the name of an authenticated user (to be found in the JWT of the current request) with Refresh Token based authentication and returns the token as part of an Authorization header.

Parameters:

xsuaaUri - The xsuaa service URI to retrieve the token from.

credentials - The client credentials to retrieve the token for.

Returns:

A HttpHeaders.AUTHORIZATION header with the retrieved access token.

Throws:

TokenRequestFailedException - When the token cannot be requested or correctly parsed.

TokenRequestDeniedException - When the authorization for the token request was rejected.

See Also:

retrieveAccessTokenViaUserTokenExchange(java.net.URI, com.sap.cloud.sdk.cloudplatform.security.ClientCredentials)

retrieveAccessTokenViaClientCredentialsGrant

@Nonnull
public AccessToken retrieveAccessTokenViaClientCredentialsGrant(@Nonnull
                                                                         URI xsuaaUri,
                                                                         @Nonnull
                                                                         ClientCredentials credentials)

Retrieves an AccessToken for a given pair of client credentials.

Parameters:

xsuaaUri - The xsuaa service URI to retrieve the token from.

credentials - The client credentials to retrieve the token for.

Returns:

The AccessToken for the given client credentials received from the given xsuaa service.

Throws:

TokenRequestFailedException - When the token cannot be requested or correctly parsed.

TokenRequestDeniedException - When the authorization for the token request was rejected.

See Also:

Cloud Foundry UAA Client Credentials Grant

retrieveAccessTokenViaUserTokenGrant

@Nonnull
public AccessToken retrieveAccessTokenViaUserTokenGrant(@Nonnull
                                                                 URI xsuaaUri,
                                                                 @Nonnull
                                                                 ClientCredentials credentials)

Retrieves an AccessToken for the currently active user token and the client id.

Parameters:

xsuaaUri - The xsuaa service URI to retrieve the token from.

credentials - The client id is part of the credentials.

Returns:

The AccessToken for the active user token received from the given xsuaa service.

Throws:

TokenRequestFailedException - When the token cannot be requested or correctly parsed.

TokenRequestDeniedException - When the authorization for the token request was rejected.

See Also:

Cloud Foundry UAA JWT Bearer Token Grant

retrieveAccessTokenViaUserTokenExchange

@Nonnull
public AccessToken retrieveAccessTokenViaUserTokenExchange(@Nonnull
                                                                    URI xsuaaUri,
                                                                    @Nonnull
                                                                    ClientCredentials credentials)

Retrieves an AccessToken through User Token Exchange for the currently active user token and the given pair of client credentials.

Parameters:

xsuaaUri - The xsuaa service URI to retrieve the token from.

credentials - The client credentials to retrieve the token for.

Returns:

The AccessToken for the active user token received from the given xsuaa service.

Throws:

TokenRequestFailedException - When the token cannot be requested or correctly parsed.

TokenRequestDeniedException - When the authorization for the token request was rejected.

See Also:

Cloud Foundry UAA Refresh Token