Package com.sap.cloud.sdk.cloudplatform.connectivity

Class TransparentProxyDestination.AbstractBuilder<B extends TransparentProxyDestination.AbstractBuilder<B>>

java.lang.Object

com.sap.cloud.sdk.cloudplatform.connectivity.TransparentProxyDestination.AbstractBuilder<B>

Type Parameters:

B - The type of the builder subclass, used for fluent method chaining.

Direct Known Subclasses:

TransparentProxyDestination.Builder, TransparentProxyDestination.GatewayBuilder

Enclosing class:

TransparentProxyDestination

public abstract static class TransparentProxyDestination.AbstractBuilder<B extends TransparentProxyDestination.AbstractBuilder<B>>
extends Object

Abstract base class for builders to share common functionality like adding headers and properties.

Constructor Summary

Constructors

Constructor	Description
AbstractBuilder()

Method Summary

Modifier and Type	Method	Description
B	actorToken(String actorToken)	Adds an actor token header to the destination.
B	actorTokenType(String actorTokenType)	Adds an actor token type header to the destination.
B	authorization(String authorization)	Adds an authorization header to the destination.
TransparentProxyDestination	build()	Finally creates the TransparentProxyDestination with the properties retrieved via the property(String, Object) method.
B	chainName(String chainName)	Sets the chain name header for the destination.
B	chainVarSamlProviderDestinationName(String samlProviderDestinationName)	Sets the chain variable SAML provider destination name header for the destination.
B	chainVarSubjectToken(String subjectToken)	Sets the chain variable subject token header for the destination.
B	chainVarSubjectTokenType(String subjectTokenType)	Sets the chain variable subject token type header for the destination.
B	clientAssertion(String clientAssertion)	Adds a client assertion header to the destination.
B	clientAssertionDestinationName(String clientAssertionDestinationName)	Adds a client assertion destination name header to the destination.
B	clientAssertionType(String clientAssertionType)	Adds a client assertion type header to the destination.
B	codeVerifier(String codeVerifier)	Adds a code verifier header to the destination.
protected abstract B	getThis()	Returns the current builder instance.
B	header(Header header)	Adds the given header to the list of headers added to every outgoing request for this destination.
B	header(String headerName, String headerValue)	Adds a header given by the headerName and headerValue to the list of headers added to every outgoing request for this destination.
B	headers(Collection<Header> headers)	Adds the given headers to the list of headers added to every outgoing request for this destination.
<ValueT> B	property(DestinationPropertyKey<ValueT> key, ValueT value)	Adds the given key-value pair to the destination to be created.
B	property(String key, Object value)	Adds the given key-value pair to the destination to be created.
B	redirectUri(String redirectUri)	Adds a redirect URI header to the destination.
B	subjectTokenType(String subjectTokenType)	Adds a subject token type header to the destination.
B	tenantId(String tenantId)	Adds a tenant ID header to the destination.
B	tenantSubdomain(String tenantSubdomain)	Adds a tenant subdomain header to the destination.
B	tokenServiceTenant(String tokenServiceTenant)	Adds a token service tenant header to the destination.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractBuilder

public AbstractBuilder()

Method Details

getThis

protected abstract B getThis()

Returns the current builder instance.

This method is used to support fluent method chaining in subclasses of AbstractBuilder.

Returns:

the current builder instance

property

@Nonnull
public B property(@Nonnull
 String key,
 @Nonnull
 Object value)

Adds the given key-value pair to the destination to be created. This will overwrite any property already assigned to the key.

Parameters:

key - The key to assign a property for.

value - The property value to be assigned.

Returns:

This builder.

Since:

5.22.0

property

@Nonnull
public <ValueT> B property(@Nonnull
 DestinationPropertyKey<ValueT> key,
 @Nonnull
 ValueT value)

Adds the given key-value pair to the destination to be created. This will overwrite any property already assigned to the key.

Type Parameters:

ValueT - The type of the property value.

Parameters:

key - The DestinationPropertyKey to assign a property for.

value - The property value to be assigned.

Returns:

This builder.

Since:

5.22.0

headers

@Nonnull
public B headers(@Nonnull
 Collection<Header> headers)

Adds the given headers to the list of headers added to every outgoing request for this destination.

Parameters:

headers - Headers to add to outgoing requests.

Returns:

This builder.

header

@Nonnull
public B header(@Nonnull
 Header header)

Adds the given header to the list of headers added to every outgoing request for this destination.

Parameters:

header - A header to add to outgoing requests.

Returns:

This builder.

header

@Nonnull
public B header(@Nonnull
 String headerName,
 @Nonnull
 String headerValue)

Adds a header given by the headerName and headerValue to the list of headers added to every outgoing request for this destination.

Parameters:

headerName - The name of the header to add.

headerValue - The value of the header to add.

Returns:

This builder.

tenantSubdomain

@Nonnull
public B tenantSubdomain(@Nonnull
 String tenantSubdomain)

Adds a tenant subdomain header to the destination. See https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/multitenancy

Note: Tenant subdomain and tenant ID cannot be set at the same time. Calling this method when a tenant ID header is already present will throw an exception.

Parameters:

tenantSubdomain - The tenant subdomain value.

Returns:

This builder instance for method chaining.

Throws:

IllegalStateException - if tenant ID header is already set

tenantId

@Nonnull
public B tenantId(@Nonnull
 String tenantId)

Adds a tenant ID header to the destination. Set automatically by the Cloud SDK per-request, if both tenant id and tenant subdomain are left unset. See https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/multitenancy

Note: Tenant subdomain and tenant ID cannot be set at the same time. Calling this method when a tenant ID header is already present will throw an exception.

Parameters:

tenantId - The tenant ID value.

Returns:

This builder instance for method chaining.

Throws:

IllegalStateException - if tenant ID header is already set

tokenServiceTenant

@Nonnull
public B tokenServiceTenant(@Nonnull
 String tokenServiceTenant)

Adds a token service tenant header to the destination. Is send to the destination service as x-tenant header and should be used when tokenServiceURLType in the destination service is common. See https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/technical-user-propagation and https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/oauth-client-credentials-authentication-cf15900ca39242fb87a1fb081a54b9ca

Parameters:

tokenServiceTenant - The token service tenant value.

Returns:

This builder instance for method chaining.

clientAssertion

@Nonnull
public B clientAssertion(@Nonnull
 String clientAssertion)

Adds a client assertion header to the destination. See https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/provide-client-assertion-properties-as-headers

Parameters:

clientAssertion - The client assertion value.

Returns:

This builder instance for method chaining.

clientAssertionType

@Nonnull
public B clientAssertionType(@Nonnull
 String clientAssertionType)

Adds a client assertion type header to the destination. See https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/provide-client-assertion-properties-as-headers

Parameters:

clientAssertionType - The client assertion type value.

Returns:

This builder instance for method chaining.

clientAssertionDestinationName

@Nonnull
public B clientAssertionDestinationName(@Nonnull
 String clientAssertionDestinationName)

Adds a client assertion destination name header to the destination. See https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/client-assertion-with-automated-assertion-fetching-by-service

Parameters:

clientAssertionDestinationName - The client assertion destination name value.

Returns:

This builder instance for method chaining.

authorization

@Nonnull
public B authorization(@Nonnull
 String authorization)

Adds an authorization header to the destination. Will be used for OAuth 2.0 token exchange and principal propagation by the transparent proxy. Will be sent to the destination service as x-user-token, x-code, x-refresh-token, x-subject-token or x-chain-var-subjectToken header depending on the destination authentication type. Set automatically by the Cloud SDK per-request, if unset here.

Parameters:

authorization - The authorization value.

Returns:

This builder instance for method chaining.

subjectTokenType

@Nonnull
public B subjectTokenType(@Nonnull
 String subjectTokenType)

Adds a subject token type header to the destination. See https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/oauth-token-exchange-authentication-8813df7e39e5472ca5bdcdd34598592d

Parameters:

subjectTokenType - The subject token type value.

Returns:

This builder instance for method chaining.

actorToken

@Nonnull
public B actorToken(@Nonnull
 String actorToken)

Adds an actor token header to the destination. See https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/oauth-token-exchange-authentication-8813df7e39e5472ca5bdcdd34598592d

Parameters:

actorToken - The actor token value.

Returns:

This builder instance for method chaining.

actorTokenType

@Nonnull
public B actorTokenType(@Nonnull
 String actorTokenType)

Adds an actor token type header to the destination. See https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/oauth-token-exchange-authentication-8813df7e39e5472ca5bdcdd34598592d

Parameters:

actorTokenType - The actor token type value.

Returns:

This builder instance for method chaining.

redirectUri

@Nonnull
public B redirectUri(@Nonnull
 String redirectUri)

Adds a redirect URI header to the destination. See https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/oauth-authorization-code-authentication-7bdfed49c6d0451b8aafe1c94da8c770

Parameters:

redirectUri - The redirect URI value.

Returns:

This builder instance for method chaining.

codeVerifier

@Nonnull
public B codeVerifier(@Nonnull
 String codeVerifier)

Adds a code verifier header to the destination. See https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/oauth-authorization-code-authentication-7bdfed49c6d0451b8aafe1c94da8c770

Parameters:

codeVerifier - The code verifier value.

Returns:

This builder instance for method chaining.

chainName

@Nonnull
public B chainName(@Nonnull
 String chainName)

Sets the chain name header for the destination. See https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/ias-signed-saml-bearer-assertion

Parameters:

chainName - The name of the chain.

Returns:

This builder instance for method chaining.

chainVarSubjectToken

@Nonnull
public B chainVarSubjectToken(@Nonnull
 String subjectToken)

Sets the chain variable subject token header for the destination. See https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/ias-signed-saml-bearer-assertion

Parameters:

subjectToken - The subject token value.

Returns:

This builder instance for method chaining.

chainVarSubjectTokenType

@Nonnull
public B chainVarSubjectTokenType(@Nonnull
 String subjectTokenType)

Sets the chain variable subject token type header for the destination. See https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/ias-signed-saml-bearer-assertion

Parameters:

subjectTokenType - The subject token type value.

Returns:

This builder instance for method chaining.

chainVarSamlProviderDestinationName

@Nonnull
public B chainVarSamlProviderDestinationName(@Nonnull
 String samlProviderDestinationName)

Sets the chain variable SAML provider destination name header for the destination. See https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/ias-signed-saml-bearer-assertion

Parameters:

samlProviderDestinationName - The SAML provider destination name.

Returns:

This builder instance for method chaining.

build

@Nonnull
public TransparentProxyDestination build()

Finally creates the TransparentProxyDestination with the properties retrieved via the property(String, Object) method.

Returns:

A fully instantiated TransparentProxyDestination.