public class ScpCfHttpDestination extends com.sap.cloud.sdk.cloudplatform.connectivity.AbstractScpDestination implements HttpDestination
Additionally provides a builder to construct instances.
Modifier and Type | Class and Description |
---|---|
static class |
ScpCfHttpDestination.Builder
Builder class to allow for easy creation of an immutable
ScpCfHttpDestination instance. |
Modifier | Constructor and Description |
---|---|
protected |
ScpCfHttpDestination(DestinationProperties baseDestination)
Create an instance by wrapping an existing
DestinationProperties object. |
Modifier and Type | Method and Description |
---|---|
static ScpCfHttpDestination.Builder |
builder(String name,
String uri)
Starts a builder to be used to create a
ScpCfHttpDestination with some properties. |
static ScpCfHttpDestination.Builder |
builder(String name,
URI uri)
Starts a builder to be used to create a
ScpCfHttpDestination with some properties. |
protected boolean |
canEqual(Object other) |
boolean |
equals(Object o) |
AuthenticationType |
getAuthenticationType()
Returns the authentication type to be expected when authenticating at the remote system.
|
io.vavr.control.Option<BasicCredentials> |
getBasicCredentials()
Returns the basic credentials to be used for authentication 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.
|
io.vavr.control.Option<KeyStore> |
getKeyStore()
The KeyStore to be used when communicating over HTTP.
|
io.vavr.control.Option<String> |
getKeyStorePassword()
The password for the Key Store to be used when communicating over HTTP.
|
io.vavr.control.Option<ProxyConfiguration> |
getProxyConfiguration()
The
ProxyConfiguration to be used when communicating over HTTP. |
io.vavr.control.Option<ProxyType> |
getProxyType()
Returns the
ProxyType that is configured for this destination. |
io.vavr.control.Option<String> |
getTlsVersion()
The TLS version to be used when communicating over HTTP.
|
io.vavr.control.Option<KeyStore> |
getTrustStore() |
io.vavr.control.Option<String> |
getTrustStorePassword() |
URI |
getUri()
Getter for the
URI to communicate with. |
int |
hashCode() |
boolean |
isTrustingAllCertificates()
Indicates whether all server certificates should be accepted when communicating over HTTP.
|
get, getName, getType, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
decorate
get, get, get, get
protected ScpCfHttpDestination(@Nonnull DestinationProperties baseDestination)
DestinationProperties
object. To be representable as a
ScpCfHttpDestination
, the existing destination object must have the following:
DestinationType.HTTP
.baseDestination
- Existing destination object that implements the DestinationProperties
interface.@Nonnull public URI getUri()
HttpDestinationProperties
URI
to communicate with.
This is a mandatory property of a HttpDestination.
getUri
in interface HttpDestinationProperties
URI
to be used with this destination.@Nonnull public AuthenticationType getAuthenticationType()
HttpDestinationProperties
getAuthenticationType
in interface HttpDestinationProperties
@Nonnull public io.vavr.control.Option<BasicCredentials> getBasicCredentials()
HttpDestinationProperties
getBasicCredentials
in interface HttpDestinationProperties
Option
wrapping the BasicCredentials
to use, if any.@Nonnull public io.vavr.control.Option<String> getTlsVersion()
HttpDestinationProperties
getTlsVersion
in interface HttpDestinationProperties
Option
wrapping the TLS version to use, if any.@Nonnull public io.vavr.control.Option<ProxyType> getProxyType()
HttpDestinationProperties
ProxyType
that is configured for this destination.getProxyType
in interface HttpDestinationProperties
Option
wrapping the ProxyType
to use, if any.@Nonnull public io.vavr.control.Option<ProxyConfiguration> getProxyConfiguration()
HttpDestinationProperties
ProxyConfiguration
to be used when communicating over HTTP.getProxyConfiguration
in interface HttpDestinationProperties
Option
wrapping the ProxyConfiguration
to use, if any.public boolean isTrustingAllCertificates()
HttpDestinationProperties
isTrustingAllCertificates
in interface HttpDestinationProperties
true
if all certificates should be accepted, false
otherwise.@Nonnull public io.vavr.control.Option<KeyStore> getKeyStore()
HttpDestinationProperties
getKeyStore
in interface HttpDestinationProperties
Option
wrapping the KeyStore to use, if any.@Nonnull public io.vavr.control.Option<String> getKeyStorePassword()
HttpDestinationProperties
getKeyStorePassword
in interface HttpDestinationProperties
Option
wrapping the password to use, if any.@Nonnull public io.vavr.control.Option<KeyStore> getTrustStore()
getTrustStore
in interface HttpDestinationProperties
@Nonnull public io.vavr.control.Option<String> getTrustStorePassword()
getTrustStorePassword
in interface HttpDestinationProperties
@Nonnull public Collection<Header> getHeaders(@Nonnull URI requestUri) throws DestinationAccessException
HttpDestinationProperties
getHeaders
in interface HttpDestinationProperties
requestUri
- The target URI of a request to which HTTP headers should be added.DestinationAccessException
@Nonnull public static ScpCfHttpDestination.Builder builder(@Nonnull String name, @Nonnull URI uri)
ScpCfHttpDestination
with some properties.name
- The name of the destination.uri
- The URI of the destination.ScpCfHttpDestination
.@Nonnull public static ScpCfHttpDestination.Builder builder(@Nonnull String name, @Nonnull String uri)
ScpCfHttpDestination
with some properties.uri
- The URI (as a String) of the destination.name
- The name of the destination.ScpCfHttpDestination
.IllegalArgumentException
- If the given string cannot be converted to a URI
, as described by URI.create(String)
.public boolean equals(Object o)
equals
in class com.sap.cloud.sdk.cloudplatform.connectivity.AbstractScpDestination
protected boolean canEqual(Object other)
canEqual
in class com.sap.cloud.sdk.cloudplatform.connectivity.AbstractScpDestination
public int hashCode()
hashCode
in class com.sap.cloud.sdk.cloudplatform.connectivity.AbstractScpDestination
Copyright © 2019 SAP SE. All rights reserved.