com.sap.cloud.sdk.cloudplatform.connectivity

Class CustomTokenHttpDestination

java.lang.Object

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

com.sap.cloud.sdk.cloudplatform.connectivity.CustomTokenHttpDestination

All Implemented Interfaces:

DestinationProperties, HttpDestination, HttpDestinationProperties

public class CustomTokenHttpDestination
extends AbstractHttpDestination

HTTP destination that adds a custom access token as authorization header at runtime.

Constructor Summary

Constructors

Constructor and Description
CustomTokenHttpDestination(HttpDestinationProperties baseDestination, String accessToken) Creates a new HttpDestination on the basis of an existing HttpDestinationProperties with a custom access token to be used in the authorization header.

Method Summary

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

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

CustomTokenHttpDestination

public CustomTokenHttpDestination(@Nonnull
                                  HttpDestinationProperties baseDestination,
                                  @Nonnull
                                  String accessToken)

Creates a new HttpDestination on the basis of an existing HttpDestinationProperties with a custom access token to be used in the authorization header.

Parameters:

baseDestination - An HttpDestinationProperties as basis.

accessToken - A string representation of an access token to be used in the authorization header, e.g. "Bearer 1234abc..."

Method Detail

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