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	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.
com.sap.cloud.sdk.cloudplatform.connectivity.AccessToken	retrieveAccessTokenViaClientCredentialsGrant(URI xsuaaUri, ClientCredentials credentials) Retrieves an AccessToken for a given pair of client credentials.
com.sap.cloud.sdk.cloudplatform.connectivity.AccessToken	retrieveAccessTokenViaUserTokenGrant(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).

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)
                                                                   throws TokenRequestFailedException,
                                                                          TokenRequestDeniedException

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.

retrieveAccessTokenViaClientCredentialsGrant

@Nonnull
public com.sap.cloud.sdk.cloudplatform.connectivity.AccessToken retrieveAccessTokenViaClientCredentialsGrant(@Nonnull
                                                                                                                      URI xsuaaUri,
                                                                                                                      @Nonnull
                                                                                                                      ClientCredentials credentials)
                                                                                                               throws TokenRequestFailedException,
                                                                                                                      TokenRequestDeniedException

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

retrieveAccessTokenHeaderViaUserTokenGrant

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

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.

retrieveAccessTokenViaUserTokenGrant

@Nonnull
public com.sap.cloud.sdk.cloudplatform.connectivity.AccessToken retrieveAccessTokenViaUserTokenGrant(@Nonnull
                                                                                                              URI xsuaaUri,
                                                                                                              @Nonnull
                                                                                                              ClientCredentials credentials)
                                                                                                       throws TokenRequestFailedException,
                                                                                                              TokenRequestDeniedException

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

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 User Token Grant