com.sap.cloud.sdk.cloudplatform.connectivity

Class ClientCredentialsHttpDestination

java.lang.Object

com.sap.cloud.sdk.cloudplatform.connectivity.AbstractHttpDestination

com.sap.cloud.sdk.cloudplatform.connectivity.ClientCredentialsHttpDestination

All Implemented Interfaces:

DestinationProperties, HttpDestination, HttpDestinationProperties

public final class ClientCredentialsHttpDestination
extends AbstractHttpDestination

HttpDestination implementation automatically adding an authentication header retrieved from an XSUAA service with client credentials.

Constructor Summary

Constructors

Constructor and Description
ClientCredentialsHttpDestination(HttpDestinationProperties baseDestination, ClientCredentials clientCredentials, ClientCredentialsGrantType grantType, URI xsuaaUri, XsuaaService xsuaaService) Wraps the given destination and adds the authentication header retrieved from the given XSUAA service with the given credentials via the given grant type.
ClientCredentialsHttpDestination(HttpDestinationProperties baseDestination, ClientCredentials clientCredentials, URI xsuaaUri, XsuaaService xsuaaService) Wraps the given destination and adds the authentication header retrieved from the given XSUAA service with the given credentials via the ClientCredentialsGrantType.CLIENT_CREDENTIALS grant type.

Method Summary

Modifier and Type	Method and Description
AuthenticationType	getAuthenticationType() Returns the authentication type to be expected when authenticating at the remote system.
ClientCredentials	getClientCredentials() Returns the credentials to be used to retrieve the AuthToken.
Collection<Header>	getHeaders(URI requestUri) Getter for a collection of header that should be added to the outgoing request for this destination.
URI	getXsuaaUri() Returns the URI to be used to retrieve the AuthToken.

Methods inherited from class com.sap.cloud.sdk.cloudplatform.connectivity.AbstractHttpDestination

get, get, get, get, getBasicCredentials, getKeyStore, getKeyStorePassword, getPropertyNames, getProxyConfiguration, getProxyType, getTlsVersion, getTrustStore, getTrustStorePassword, getUri, isTrustingAllCertificates

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sap.cloud.sdk.cloudplatform.connectivity.HttpDestination

decorate

Constructor Detail

ClientCredentialsHttpDestination

public ClientCredentialsHttpDestination(@Nonnull
                                        HttpDestinationProperties baseDestination,
                                        @Nonnull
                                        ClientCredentials clientCredentials,
                                        @Nonnull
                                        URI xsuaaUri,
                                        @Nonnull
                                        XsuaaService xsuaaService)

Wraps the given destination and adds the authentication header retrieved from the given XSUAA service with the given credentials via the ClientCredentialsGrantType.CLIENT_CREDENTIALS grant type.

Parameters:

baseDestination - The destination to wrap.

clientCredentials - The credentials to be used to retrieve the AuthToken.

xsuaaUri - The URI of the XSUAA service to retrieve the AuthToken from.

xsuaaService - XsuaaService instance to be used to retrieve the AuthToken.

ClientCredentialsHttpDestination

public ClientCredentialsHttpDestination(@Nonnull
                                        HttpDestinationProperties baseDestination,
                                        @Nonnull
                                        ClientCredentials clientCredentials,
                                        @Nullable
                                        ClientCredentialsGrantType grantType,
                                        @Nonnull
                                        URI xsuaaUri,
                                        @Nonnull
                                        XsuaaService xsuaaService)

Wraps the given destination and adds the authentication header retrieved from the given XSUAA service with the given credentials via the given grant type.

Parameters:

baseDestination - The destination to wrap.

clientCredentials - The credentials to be used to retrieve the AuthToken.

grantType - The grant type to retrieve the access token with.

xsuaaUri - The URI of the XSUAA service to retrieve the AuthToken from.

xsuaaService - XsuaaService instance to be used to retrieve the AuthToken.

Method Detail

getXsuaaUri

@Nonnull
public URI getXsuaaUri()

Returns the URI to be used to retrieve the AuthToken.

Returns:

The URI provided on creation time.

getClientCredentials

@Nonnull
public ClientCredentials getClientCredentials()

Returns the credentials to be used to retrieve the AuthToken.

Returns:

The credentials provided on creation time.

getAuthenticationType

@Nonnull
public AuthenticationType getAuthenticationType()

Returns the authentication type to be expected when authenticating at the remote system.

Specified by:

getAuthenticationType in interface HttpDestinationProperties

Overrides:

getAuthenticationType in class AbstractHttpDestination

Returns:

This destination authentication type.

getHeaders

@Nonnull
public Collection<Header> getHeaders(@Nonnull
                                              URI requestUri)
                                       throws DestinationAccessException

Getter for a collection of header that should be added to the outgoing request for this destination.

Specified by:

getHeaders in interface HttpDestinationProperties

Overrides:

getHeaders in class AbstractHttpDestination

Parameters:

requestUri - The target URI of a request to which HTTP headers should be added.

Returns:

A collection with all headers to be used when communicating with the target of the destination.

Throws:

DestinationAccessException