com.sap.cloud.sdk.cloudplatform.connectivity

Class ScpNeoHttpDestination.Builder

java.lang.Object

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

Enclosing class:

ScpNeoHttpDestination

public static final class ScpNeoHttpDestination.Builder
extends Object

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

Method Summary

Modifier and Type	Method and Description
ScpNeoHttpDestination.Builder	authenticationHeaders(List<Header> authenticationHeaders) Adds the authentication headers to every outgoing request to this destination
ScpNeoHttpDestination.Builder	authenticationType(AuthenticationType authenticationType) Sets the authentication type of the destination
ScpNeoHttpDestination.Builder	basicCredentials(BasicCredentials value) Sets the credentials for accessing the destination when basic authentication is used.
ScpNeoHttpDestination	build() Finally creates the ScpCfHttpDestination based on the builder methods called and properties previously set.
protected DefaultDestination	buildDefaultDestination() Finally creates a DefaultDestination with the properties retrieved via #the property(String, Object) method.
ScpNeoHttpDestination.Builder	cloudConnectorLocationId(String locationId) Sets the connectivity location id of the destination.
protected ScpNeoHttpDestination.Builder	getThis() Returns a reference to the builder
ScpNeoHttpDestination.Builder	header(Header header) Adds the given header to the list of headers added to every outgoing request for this destination.
ScpNeoHttpDestination.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.
ScpNeoHttpDestination.Builder	keyStore(KeyStore keyStore) Sets the key store of the destination.
ScpNeoHttpDestination.Builder	keyStorePassword(String password) Sets the key store password of the destination.
BuilderT	name(String name) Sets a name for the destination.
ScpNeoHttpDestination.Builder	password(String password) Sets the password for accessing the destination when basic authentication is used.
BuilderT	property(String key, Object value) Adds the given key-value pair to the destination to be created.
ScpNeoHttpDestination.Builder	proxyConfiguration(ProxyConfiguration proxyConfiguration) Sets the proxy configuration used by the destination
ScpNeoHttpDestination.Builder	proxyType(ProxyType proxyType) Sets the proxy type (Internet or On-Premise)
String	toString()
ScpNeoHttpDestination.Builder	trustAllCertificates() Lets the destination trust all server certificates.
ScpNeoHttpDestination.Builder	trustStore(KeyStore trustStore) Sets the trust store of the destination.
ScpNeoHttpDestination.Builder	trustStorePassword(String password) Sets the trust store password of the destination.
BuilderT	type(DestinationType type) Sets the type for the destination.
ScpNeoHttpDestination.Builder	user(String user) Sets the user name for accessing the destination when basic authentication is used.

Methods inherited from class java.lang.Object

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

Method Detail

keyStore

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

Sets the key store of the destination.

Parameters:

keyStore - A key store for this destination.

Returns:

This builder.

keyStorePassword

@Nonnull
public ScpNeoHttpDestination.Builder keyStorePassword(@Nonnull
                                                               String password)

Sets the key store password of the destination.

Parameters:

password - A key store password for this destination.

Returns:

This builder.

trustStore

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

Sets the trust store of the destination.

Parameters:

trustStore - A trust store for this destination.

Returns:

This builder.

trustStorePassword

@Nonnull
public ScpNeoHttpDestination.Builder trustStorePassword(@Nonnull
                                                                 String password)

Sets the trust store password of the destination.

Parameters:

password - A trust store password for this destination.

Returns:

This builder.

cloudConnectorLocationId

@Nonnull
public ScpNeoHttpDestination.Builder cloudConnectorLocationId(@Nonnull
                                                                       String locationId)

Sets the connectivity location id of the destination.

Parameters:

locationId - The location identifier for connecting to SAP Cloud Connector.

Returns:

This builder.

user

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

Sets the user name for accessing the destination when basic authentication is used.

Parameters:

user - The user name used for accessing the destination

Returns:

This builder.

password

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

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

Parameters:

password - The password for accessing the destination

Returns:

This builder.

basicCredentials

@Nonnull
public ScpNeoHttpDestination.Builder basicCredentials(@Nonnull
                                                               BasicCredentials value)

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

Parameters:

value - Username and password represented as a BasicCredentials object.

Returns:

This builder.

authenticationHeaders

@Nonnull
public ScpNeoHttpDestination.Builder authenticationHeaders(@Nonnull
                                                                    List<Header> authenticationHeaders)

Adds the authentication headers to every outgoing request to this destination

Parameters:

authenticationHeaders - The authentication headers added to outgoing requests.

Returns:

This builder

authenticationType

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

Sets the authentication type of the destination

Parameters:

authenticationType - Enum value from AuthenticationType representing the authentication type

Returns:

This builder

proxyType

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

Sets the proxy type (Internet or On-Premise)

Parameters:

proxyType - Enum value from ProxyType representing the proxy type

Returns:

This builder

proxyConfiguration

@Nonnull
public ScpNeoHttpDestination.Builder proxyConfiguration(@Nonnull
                                                                 ProxyConfiguration proxyConfiguration)

Sets the proxy configuration used by the destination

Parameters:

proxyConfiguration - The proxy that should be used.

Returns:

This builder

trustAllCertificates

@Nonnull
public ScpNeoHttpDestination.Builder trustAllCertificates()

Lets the destination trust all server certificates.

Returns:

This builder.

header

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

getThis

@Nonnull
protected ScpNeoHttpDestination.Builder getThis()

Returns a reference to the builder

Returns:

This builder

build

@Nonnull
public ScpNeoHttpDestination build()

Finally creates the ScpCfHttpDestination based on the builder methods called and properties previously set.

Returns:

A fully instantiated ScpCfHttpDestination.

name

@Nonnull
public BuilderT name(@Nonnull
                              String name)

Sets a name for the destination.

Parameters:

name - A name for the destination.

Returns:

This builder.

type

@Nonnull
public BuilderT type(@Nonnull
                              DestinationType type)

Sets the type for the destination.

Parameters:

type - A recognized type for the destination.

Returns:

This builder.

property

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

buildDefaultDestination

@Nonnull
protected final DefaultDestination buildDefaultDestination()

Finally creates a DefaultDestination with the properties retrieved via #the property(String, Object) method.

Returns:

A fully instantiated DefaultDestination.

toString

public String toString()

Overrides:

toString in class Object