com.sap.cloud.sdk.cloudplatform.connectivity

Class DefaultHttpDestination.Builder

java.lang.Object

com.sap.cloud.sdk.cloudplatform.connectivity.DefaultHttpDestination.Builder

Enclosing class:

DefaultHttpDestination

public static class DefaultHttpDestination.Builder
extends Object

Builder class to allow for easy creation of an immutable DefaultHttpDestination instance.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
DefaultHttpDestination.Builder	authenticationType(AuthenticationType authenticationType) Sets the expected authentication type of the DefaultHttpDestination.
DefaultHttpDestination.Builder	basicCredentials(BasicCredentials basicCredentials) Sets the credentials for accessing the destination when basic authentication is used.
DefaultHttpDestination	build() Finally creates the DefaultHttpDestination with the properties retrieved via the property(String, Object) method.
DefaultHttpDestination.Builder	header(Header header) Adds the given header to the list of headers added to every outgoing request for this destination.
DefaultHttpDestination.Builder	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.
DefaultHttpDestination.Builder	headerProviders(DestinationHeaderProvider... headerProviders) Registers the provided DestinationHeaderProvider instances on this Destination.
DefaultHttpDestination.Builder	keyStore(KeyStore keyStore) Sets the KeyStore to be used when communicating over HTTP.
DefaultHttpDestination.Builder	keyStorePassword(String value) Sets the key store password for the corresponding KeyStore used by the DefaultHttpDestination to access the key store.
DefaultHttpDestination.Builder	name(String name) Sets the name of the DefaultHttpDestination.
DefaultHttpDestination.Builder	network(ProxyType proxyType) Deprecated. Use proxyType(ProxyType) instead.
DefaultHttpDestination.Builder	password(String password) Sets the password of the DefaultHttpDestination.
DefaultHttpDestination.Builder	property(String key, Object value) Adds the given key-value pair to the destination to be created.
DefaultHttpDestination.Builder	proxy(String proxyHost, int proxyPort) Sets the proxy host and proxy port of the DefaultHttpDestination.
DefaultHttpDestination.Builder	proxy(URI proxyUri) Sets the proxy URI of the DefaultHttpDestination.
DefaultHttpDestination.Builder	proxyType(ProxyType proxyType) Sets the proxy type (Internet or On-Premise).
DefaultHttpDestination.Builder	securityConfiguration(SecurityConfigurationStrategy securityConfigurationStrategy) Sets the SecurityConfigurationStrategy for outbound calls via this Destination to decide if the HttpSecuritySettings should be taken from the Destination Configuration or from the CloudPlatform.
DefaultHttpDestination.Builder	tlsVersion(String value) Sets the TLS version used by the DefaultHttpDestination to the given value.
DefaultHttpDestination.Builder	trustAllCertificates() Lets the DefaultHttpDestination trust all server certificates.
DefaultHttpDestination.Builder	trustStore(KeyStore trustStore) Sets the Trust Store to be used when communicating over HTTP.
DefaultHttpDestination.Builder	uri(URI uri) Deprecated. The URI is already passed as a parameter to create the builder instance, hence deprecating this method.
DefaultHttpDestination.Builder	user(String user) Sets the user name of the DefaultHttpDestination.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

property

@Nonnull
public DefaultHttpDestination.Builder 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.

tlsVersion

@Nonnull
public DefaultHttpDestination.Builder tlsVersion(@Nonnull
                                                          String value)

Sets the TLS version used by the DefaultHttpDestination to the given value.

Parameters:

value - The TLS version that should be used.

Returns:

This builder.

keyStorePassword

@Nonnull
public DefaultHttpDestination.Builder keyStorePassword(@Nonnull
                                                                String value)

Sets the key store password for the corresponding KeyStore used by the DefaultHttpDestination to access the key store.

Parameters:

value - The keyStore password that should be used.

Returns:

This builder.

keyStore

@Nonnull
public DefaultHttpDestination.Builder keyStore(@Nonnull
                                                        KeyStore keyStore)

Sets the KeyStore to be used when communicating over HTTP.

Parameters:

keyStore - The keyStore that should be used for HTTP communication

Returns:

This builder.

trustStore

@Nonnull
public DefaultHttpDestination.Builder trustStore(@Nonnull
                                                          KeyStore trustStore)

Sets the Trust Store to be used when communicating over HTTP.

Parameters:

trustStore - The Trust Store that should be used. for HTTP communication

Returns:

This builder.

trustAllCertificates

@Nonnull
public DefaultHttpDestination.Builder trustAllCertificates()

Lets the DefaultHttpDestination trust all server certificates.

Returns:

This builder.

name

@Nonnull
public DefaultHttpDestination.Builder name(@Nonnull
                                                    String name)

Sets the name of the DefaultHttpDestination.

Parameters:

name - The destination name

Returns:

This builder.

proxy

@Nonnull
public DefaultHttpDestination.Builder proxy(@Nonnull
                                                     URI proxyUri)

Sets the proxy URI of the DefaultHttpDestination.

Parameters:

proxyUri - The URI of the proxy

Returns:

This builder.

network

@Deprecated
 @Nonnull
public DefaultHttpDestination.Builder network(@Nonnull
                                                                    ProxyType proxyType)

Deprecated. Use proxyType(ProxyType) instead.

Sets the network (i.e. "proxy type") of the DefaultHttpDestination.

Parameters:

proxyType - The network (i.e. "proxy type")

Returns:

This builder.

proxyType

@Nonnull
public DefaultHttpDestination.Builder proxyType(@Nonnull
                                                         ProxyType proxyType)

Sets the proxy type (Internet or On-Premise).

Parameters:

proxyType - Type of proxy this destination is configured for.

Returns:

This builder.

proxy

@Nonnull
public DefaultHttpDestination.Builder proxy(@Nonnull
                                                     String proxyHost,
                                                     int proxyPort)

Sets the proxy host and proxy port of the DefaultHttpDestination.

Parameters:

proxyHost - The host of the proxy

proxyPort - The port of the proxy

Returns:

This builder.

uri

@Deprecated
 @Nonnull
public DefaultHttpDestination.Builder uri(@Nonnull
                                                                URI uri)

Deprecated. The URI is already passed as a parameter to create the builder instance, hence deprecating this method.

Sets the proxy host and proxy port of the DefaultHttpDestination.

Parameters:

uri - The URI of the destination

Returns:

This builder.

user

@Nonnull
public DefaultHttpDestination.Builder user(@Nonnull
                                                    String user)

Sets the user name of the DefaultHttpDestination.

Parameters:

user - The user name of the destination

Returns:

This builder.

password

@Nonnull
public DefaultHttpDestination.Builder password(@Nonnull
                                                        String password)

Sets the password of the DefaultHttpDestination.

Parameters:

password - The password of the destination

Returns:

This builder.

basicCredentials

@Nonnull
public DefaultHttpDestination.Builder basicCredentials(@Nonnull
                                                                BasicCredentials basicCredentials)

Sets the credentials for accessing the destination when basic authentication is used.

Parameters:

basicCredentials - Username and password represented as a BasicCredentials object.

Returns:

This builder.

authenticationType

@Nonnull
public DefaultHttpDestination.Builder authenticationType(@Nonnull
                                                                  AuthenticationType authenticationType)

Sets the expected authentication type of the DefaultHttpDestination.

Parameters:

authenticationType - The type of authentication forthe destination

Returns:

This builder.

header

@Nonnull
public DefaultHttpDestination.Builder 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 DefaultHttpDestination.Builder 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.

securityConfiguration

@Beta
 @Nonnull
public DefaultHttpDestination.Builder securityConfiguration(@Nonnull
                                                                            SecurityConfigurationStrategy securityConfigurationStrategy)

Sets the SecurityConfigurationStrategy for outbound calls via this Destination to decide if the HttpSecuritySettings should be taken from the Destination Configuration or from the CloudPlatform.

Parameters:

securityConfigurationStrategy - The security configuration strategy to use

Returns:

This builder

headerProviders

@Nonnull
public DefaultHttpDestination.Builder headerProviders(@Nonnull
                                                               DestinationHeaderProvider... headerProviders)

Registers the provided DestinationHeaderProvider instances on this Destination. For all outgoing requests, the registered header providers are invoked and the returned headers are added to the request.

Parameters:

headerProviders - The header provider instances

Returns:

This builder

build

@Nonnull
public DefaultHttpDestination build()

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

Returns:

A fully instantiated DefaultHttpDestination.