com.oracle.bmc.sch

Class ServiceConnectorAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.sch.ServiceConnectorAsyncClient

All Implemented Interfaces:

ServiceConnectorAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200909")
public class ServiceConnectorAsyncClient
extends BaseAsyncClient
implements ServiceConnectorAsync

Async client implementation for ServiceConnector service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceConnectorAsyncClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
static Service	SERVICE Service instance for ServiceConnector.

Constructor Summary

Constructors

Constructor and Description
ServiceConnectorAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
ServiceConnectorAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
ServiceConnectorAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
ServiceConnectorAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
ServiceConnectorAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
ServiceConnectorAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
ServiceConnectorAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
Future<ActivateServiceConnectorResponse>	activateServiceConnector(ActivateServiceConnectorRequest request, AsyncHandler<ActivateServiceConnectorRequest,ActivateServiceConnectorResponse> handler) Activates the specified service connector.
static ServiceConnectorAsyncClient.Builder	builder() Create a builder for this client.
Future<ChangeServiceConnectorCompartmentResponse>	changeServiceConnectorCompartment(ChangeServiceConnectorCompartmentRequest request, AsyncHandler<ChangeServiceConnectorCompartmentRequest,ChangeServiceConnectorCompartmentResponse> handler) Moves a service connector into a different compartment within the same tenancy.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
Future<CreateServiceConnectorResponse>	createServiceConnector(CreateServiceConnectorRequest request, AsyncHandler<CreateServiceConnectorRequest,CreateServiceConnectorResponse> handler) Creates a new service connector in the specified compartment.
Future<DeactivateServiceConnectorResponse>	deactivateServiceConnector(DeactivateServiceConnectorRequest request, AsyncHandler<DeactivateServiceConnectorRequest,DeactivateServiceConnectorResponse> handler) Deactivates the specified service connector.
Future<DeleteServiceConnectorResponse>	deleteServiceConnector(DeleteServiceConnectorRequest request, AsyncHandler<DeleteServiceConnectorRequest,DeleteServiceConnectorResponse> handler) Deletes the specified service connector.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Future<GetServiceConnectorResponse>	getServiceConnector(GetServiceConnectorRequest request, AsyncHandler<GetServiceConnectorRequest,GetServiceConnectorResponse> handler) Gets the specified service connector’s configuration information.
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler) Gets the details of the specified work request.
Future<ListServiceConnectorsResponse>	listServiceConnectors(ListServiceConnectorsRequest request, AsyncHandler<ListServiceConnectorsRequest,ListServiceConnectorsResponse> handler) Lists service connectors in the specified compartment.
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler) Lists work request errors for the specified work request.
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler) Lists logs for the specified work request.
Future<ListWorkRequestsResponse>	listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler) Lists the work requests in the specified compartment.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
Future<UpdateServiceConnectorResponse>	updateServiceConnector(UpdateServiceConnectorRequest request, AsyncHandler<UpdateServiceConnectorRequest,UpdateServiceConnectorResponse> handler) Updates the configuration information for the specified service connector.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.bmc.sch.ServiceConnectorAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for ServiceConnector.

Constructor Detail

ServiceConnectorAsyncClient

@Deprecated
public ServiceConnectorAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ServiceConnectorAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

ServiceConnectorAsyncClient

@Deprecated
public ServiceConnectorAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                               ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ServiceConnectorAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

ServiceConnectorAsyncClient

@Deprecated
public ServiceConnectorAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                               ClientConfiguration configuration,
                                               ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ServiceConnectorAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

ServiceConnectorAsyncClient

@Deprecated
public ServiceConnectorAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                               ClientConfiguration configuration,
                                               ClientConfigurator clientConfigurator,
                                               RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ServiceConnectorAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ServiceConnectorAsyncClient

@Deprecated
public ServiceConnectorAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                               ClientConfiguration configuration,
                                               ClientConfigurator clientConfigurator,
                                               RequestSignerFactory defaultRequestSignerFactory,
                                               List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ServiceConnectorAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ServiceConnectorAsyncClient

@Deprecated
public ServiceConnectorAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                               ClientConfiguration configuration,
                                               ClientConfigurator clientConfigurator,
                                               RequestSignerFactory defaultRequestSignerFactory,
                                               List<ClientConfigurator> additionalClientConfigurators,
                                               String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ServiceConnectorAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

ServiceConnectorAsyncClient

@Deprecated
public ServiceConnectorAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                               ClientConfiguration configuration,
                                               ClientConfigurator clientConfigurator,
                                               RequestSignerFactory defaultRequestSignerFactory,
                                               Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                               List<ClientConfigurator> additionalClientConfigurators,
                                               String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ServiceConnectorAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

Method Detail

builder

public static ServiceConnectorAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: ServiceConnectorAsync

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.

Specified by:

setRegion in interface ServiceConnectorAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: ServiceConnectorAsync

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Specified by:

setRegion in interface ServiceConnectorAsync

Parameters:

regionId - The public region ID.

activateServiceConnector

public Future<ActivateServiceConnectorResponse> activateServiceConnector(ActivateServiceConnectorRequest request,
                                                                         AsyncHandler<ActivateServiceConnectorRequest,ActivateServiceConnectorResponse> handler)

Description copied from interface: ServiceConnectorAsync

Activates the specified service connector.

After you send your request, the service connector's state is temporarily UPDATING. When the state changes to ACTIVE, data begins transferring from the source service to the target service. For instructions on activating service connectors, see [To activate a service connector](https://docs.cloud.oracle.com/iaas/Content/service-connector-hub/managingconnectors.htm#activate).

Specified by:

activateServiceConnector in interface ServiceConnectorAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

changeServiceConnectorCompartment

public Future<ChangeServiceConnectorCompartmentResponse> changeServiceConnectorCompartment(ChangeServiceConnectorCompartmentRequest request,
                                                                                           AsyncHandler<ChangeServiceConnectorCompartmentRequest,ChangeServiceConnectorCompartmentResponse> handler)

Description copied from interface: ServiceConnectorAsync

Moves a service connector into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeServiceConnectorCompartment in interface ServiceConnectorAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createServiceConnector

public Future<CreateServiceConnectorResponse> createServiceConnector(CreateServiceConnectorRequest request,
                                                                     AsyncHandler<CreateServiceConnectorRequest,CreateServiceConnectorResponse> handler)

Description copied from interface: ServiceConnectorAsync

Creates a new service connector in the specified compartment. A service connector is a logically defined flow for moving data from a source service to a destination service in Oracle Cloud Infrastructure. For instructions, see To create a service connector. For general information about service connectors, see Service Connector Hub Overview.

For purposes of access control, you must provide the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the service connector to reside. Notice that the service connector doesn't have to be in the same compartment as the source or target services. For information about access control and compartments, see [Overview of the IAM Service](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm).

After you send your request, the new service connector's state is temporarily CREATING. When the state changes to ACTIVE, data begins transferring from the source service to the target service. For instructions on deactivating and activating service connectors, see [To activate or deactivate a service connector](https://docs.cloud.oracle.com/iaas/Content/service-connector-hub/overview.htm).

Specified by:

createServiceConnector in interface ServiceConnectorAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deactivateServiceConnector

public Future<DeactivateServiceConnectorResponse> deactivateServiceConnector(DeactivateServiceConnectorRequest request,
                                                                             AsyncHandler<DeactivateServiceConnectorRequest,DeactivateServiceConnectorResponse> handler)

Description copied from interface: ServiceConnectorAsync

Deactivates the specified service connector.

After you send your request, the service connector's state is temporarily UPDATING and any data transfer stops. The state then changes to INACTIVE. For instructions on deactivating service connectors, see [To deactivate a service connector](https://docs.cloud.oracle.com/iaas/Content/service-connector-hub/managingconnectors.htm#deactivate).

Specified by:

deactivateServiceConnector in interface ServiceConnectorAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteServiceConnector

public Future<DeleteServiceConnectorResponse> deleteServiceConnector(DeleteServiceConnectorRequest request,
                                                                     AsyncHandler<DeleteServiceConnectorRequest,DeleteServiceConnectorResponse> handler)

Description copied from interface: ServiceConnectorAsync

Deletes the specified service connector.

After you send your request, the service connector's state is temporarily DELETING and any data transfer stops. The state then changes to DELETED.

Specified by:

deleteServiceConnector in interface ServiceConnectorAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getServiceConnector

public Future<GetServiceConnectorResponse> getServiceConnector(GetServiceConnectorRequest request,
                                                               AsyncHandler<GetServiceConnectorRequest,GetServiceConnectorResponse> handler)

Description copied from interface: ServiceConnectorAsync

Gets the specified service connector’s configuration information.

Specified by:

getServiceConnector in interface ServiceConnectorAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getWorkRequest

public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                                     AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)

Description copied from interface: ServiceConnectorAsync

Gets the details of the specified work request.

Specified by:

getWorkRequest in interface ServiceConnectorAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listServiceConnectors

public Future<ListServiceConnectorsResponse> listServiceConnectors(ListServiceConnectorsRequest request,
                                                                   AsyncHandler<ListServiceConnectorsRequest,ListServiceConnectorsResponse> handler)

Description copied from interface: ServiceConnectorAsync

Lists service connectors in the specified compartment.

Specified by:

listServiceConnectors in interface ServiceConnectorAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listWorkRequestErrors

public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                                   AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)

Description copied from interface: ServiceConnectorAsync

Lists work request errors for the specified work request. Results are paginated.

Specified by:

listWorkRequestErrors in interface ServiceConnectorAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listWorkRequestLogs

public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                               AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)

Description copied from interface: ServiceConnectorAsync

Lists logs for the specified work request. Results are paginated.

Specified by:

listWorkRequestLogs in interface ServiceConnectorAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listWorkRequests

public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                         AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)

Description copied from interface: ServiceConnectorAsync

Lists the work requests in the specified compartment.

Specified by:

listWorkRequests in interface ServiceConnectorAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateServiceConnector

public Future<UpdateServiceConnectorResponse> updateServiceConnector(UpdateServiceConnectorRequest request,
                                                                     AsyncHandler<UpdateServiceConnectorRequest,UpdateServiceConnectorResponse> handler)

Description copied from interface: ServiceConnectorAsync

Updates the configuration information for the specified service connector.

After you send your request, the service connector's state is temporarily UPDATING and any data transfer pauses. The state then changes back to its original value: if ACTIVE, then data transfer resumes.

Specified by:

updateServiceConnector in interface ServiceConnectorAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template. The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                           Supplier<RESP_BUILDER> responseBuilder)