com.ibm.cos.v2.core

Interface ClientEndpointProvider

All Known Implementing Classes:

AwsClientEndpointProvider, StaticClientEndpointProvider

public interface ClientEndpointProvider

Client endpoint providers are responsible for resolving client-level endpoints. EndpointProviders are ultimately responsible for resolving the endpoint used for a request.

EndpointProviders may choose to honor or completely ignore the client-level endpoint. Default endpoint providers will ignore the client-level endpoint, unless isEndpointOverridden() is true.

Method Summary

Modifier and Type	Method and Description
URI	clientEndpoint() Retrieve the client endpoint from this provider.
static ClientEndpointProvider	create(URI uri, boolean isEndpointOverridden) Create a client endpoint provider that uses the provided static URI and override settings.
static ClientEndpointProvider	forEndpointOverride(URI uri) Create a client endpoint provider that uses the provided URI and returns true from isEndpointOverridden().
boolean	isEndpointOverridden() Returns true if this endpoint was specified as an override by the customer, or false if it was determined automatically by the SDK.

Method Detail

forEndpointOverride

static ClientEndpointProvider forEndpointOverride(URI uri)

Create a client endpoint provider that uses the provided URI and returns true from isEndpointOverridden().

create

static ClientEndpointProvider create(URI uri,
                                     boolean isEndpointOverridden)

Create a client endpoint provider that uses the provided static URI and override settings.

clientEndpoint

URI clientEndpoint()

Retrieve the client endpoint from this provider.

isEndpointOverridden

boolean isEndpointOverridden()

Returns true if this endpoint was specified as an override by the customer, or false if it was determined automatically by the SDK.