Package com.oracle.bmc.osmanagementhub

Class OnboardingAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.osmanagementhub.OnboardingAsyncClient

All Implemented Interfaces:

OnboardingAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220901")
public class OnboardingAsyncClient
extends BaseAsyncClient
implements OnboardingAsync

Async client implementation for Onboarding 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	Description
static class	OnboardingAsyncClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	Description
String	clientCommonLibraryVersion	Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient	Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE	Service instance for Onboarding.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Future<AttachLifecycleStageToProfileResponse>	attachLifecycleStageToProfile(AttachLifecycleStageToProfileRequest request, AsyncHandler<AttachLifecycleStageToProfileRequest,AttachLifecycleStageToProfileResponse> handler)	Attaches the specified lifecycle stage to a profile.
Future<AttachManagedInstanceGroupToProfileResponse>	attachManagedInstanceGroupToProfile(AttachManagedInstanceGroupToProfileRequest request, AsyncHandler<AttachManagedInstanceGroupToProfileRequest,AttachManagedInstanceGroupToProfileResponse> handler)	Attaches the specified managed instance group to a profile.
Future<AttachManagementStationToProfileResponse>	attachManagementStationToProfile(AttachManagementStationToProfileRequest request, AsyncHandler<AttachManagementStationToProfileRequest,AttachManagementStationToProfileResponse> handler)	Attaches the specified management station to a profile.
Future<AttachSoftwareSourcesToProfileResponse>	attachSoftwareSourcesToProfile(AttachSoftwareSourcesToProfileRequest request, AsyncHandler<AttachSoftwareSourcesToProfileRequest,AttachSoftwareSourcesToProfileResponse> handler)	Attaches the specified software sources to a profile.
static OnboardingAsyncClient.Builder	builder()	Create a builder for this client.
Future<ChangeProfileCompartmentResponse>	changeProfileCompartment(ChangeProfileCompartmentRequest request, AsyncHandler<ChangeProfileCompartmentRequest,ChangeProfileCompartmentResponse> handler)	Moves the profile to a different compartment.
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<CreateProfileResponse>	createProfile(CreateProfileRequest request, AsyncHandler<CreateProfileRequest,CreateProfileResponse> handler)	Creates a registration profile.
Future<DeleteProfileResponse>	deleteProfile(DeleteProfileRequest request, AsyncHandler<DeleteProfileRequest,DeleteProfileResponse> handler)	Deletes a specified registration profile.
Future<DetachSoftwareSourcesFromProfileResponse>	detachSoftwareSourcesFromProfile(DetachSoftwareSourcesFromProfileRequest request, AsyncHandler<DetachSoftwareSourcesFromProfileRequest,DetachSoftwareSourcesFromProfileResponse> handler)	Detaches the specified software sources from a profile.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetProfileResponse>	getProfile(GetProfileRequest request, AsyncHandler<GetProfileRequest,GetProfileResponse> handler)	Returns information about the specified registration profile.
Future<GetProfileVersionResponse>	getProfileVersion(GetProfileVersionRequest request, AsyncHandler<GetProfileVersionRequest,GetProfileVersionResponse> handler)	Returns information about the version of the specified registration profile.
Future<ListProfileAvailableSoftwareSourcesResponse>	listProfileAvailableSoftwareSources(ListProfileAvailableSoftwareSourcesRequest request, AsyncHandler<ListProfileAvailableSoftwareSourcesRequest,ListProfileAvailableSoftwareSourcesResponse> handler)	Lists available software sources for a specified profile.
Future<ListProfilesResponse>	listProfiles(ListProfilesRequest request, AsyncHandler<ListProfilesRequest,ListProfilesResponse> handler)	Lists registration profiles that match the specified compartment or profile OCID.
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<UpdateProfileResponse>	updateProfile(UpdateProfileRequest request, AsyncHandler<UpdateProfileRequest,UpdateProfileResponse> handler)	Updates the specified profile’s name, description, and tags.
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 java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.osmanagementhub.OnboardingAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Onboarding.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

OnboardingAsyncClient

@Deprecated
public OnboardingAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

OnboardingAsyncClient

@Deprecated
public OnboardingAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

OnboardingAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

OnboardingAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

OnboardingAsyncClient

@Deprecated
public OnboardingAsyncClient(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 OnboardingAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

OnboardingAsyncClient

@Deprecated
public OnboardingAsyncClient(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 OnboardingAsyncClient.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)

OnboardingAsyncClient

@Deprecated
public OnboardingAsyncClient(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 OnboardingAsyncClient.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 OnboardingAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: OnboardingAsync

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 OnboardingAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: OnboardingAsync

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 OnboardingAsync

Parameters:

regionId - The public region ID.

attachLifecycleStageToProfile

public Future<AttachLifecycleStageToProfileResponse> attachLifecycleStageToProfile(AttachLifecycleStageToProfileRequest request,
                                                                                   AsyncHandler<AttachLifecycleStageToProfileRequest,AttachLifecycleStageToProfileResponse> handler)

Description copied from interface: OnboardingAsync

Attaches the specified lifecycle stage to a profile.

Specified by:

attachLifecycleStageToProfile in interface OnboardingAsync

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.

attachManagedInstanceGroupToProfile

public Future<AttachManagedInstanceGroupToProfileResponse> attachManagedInstanceGroupToProfile(AttachManagedInstanceGroupToProfileRequest request,
                                                                                               AsyncHandler<AttachManagedInstanceGroupToProfileRequest,AttachManagedInstanceGroupToProfileResponse> handler)

Description copied from interface: OnboardingAsync

Attaches the specified managed instance group to a profile.

Specified by:

attachManagedInstanceGroupToProfile in interface OnboardingAsync

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.

attachManagementStationToProfile

public Future<AttachManagementStationToProfileResponse> attachManagementStationToProfile(AttachManagementStationToProfileRequest request,
                                                                                         AsyncHandler<AttachManagementStationToProfileRequest,AttachManagementStationToProfileResponse> handler)

Description copied from interface: OnboardingAsync

Attaches the specified management station to a profile.

Specified by:

attachManagementStationToProfile in interface OnboardingAsync

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.

attachSoftwareSourcesToProfile

public Future<AttachSoftwareSourcesToProfileResponse> attachSoftwareSourcesToProfile(AttachSoftwareSourcesToProfileRequest request,
                                                                                     AsyncHandler<AttachSoftwareSourcesToProfileRequest,AttachSoftwareSourcesToProfileResponse> handler)

Description copied from interface: OnboardingAsync

Attaches the specified software sources to a profile.

Specified by:

attachSoftwareSourcesToProfile in interface OnboardingAsync

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.

changeProfileCompartment

public Future<ChangeProfileCompartmentResponse> changeProfileCompartment(ChangeProfileCompartmentRequest request,
                                                                         AsyncHandler<ChangeProfileCompartmentRequest,ChangeProfileCompartmentResponse> handler)

Description copied from interface: OnboardingAsync

Moves the profile to a different compartment.

Specified by:

changeProfileCompartment in interface OnboardingAsync

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.

createProfile

public Future<CreateProfileResponse> createProfile(CreateProfileRequest request,
                                                   AsyncHandler<CreateProfileRequest,CreateProfileResponse> handler)

Description copied from interface: OnboardingAsync

Creates a registration profile.

A profile defines the content applied to the instance when registering it with the service.

Specified by:

createProfile in interface OnboardingAsync

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.

deleteProfile

public Future<DeleteProfileResponse> deleteProfile(DeleteProfileRequest request,
                                                   AsyncHandler<DeleteProfileRequest,DeleteProfileResponse> handler)

Description copied from interface: OnboardingAsync

Deletes a specified registration profile.

Specified by:

deleteProfile in interface OnboardingAsync

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.

detachSoftwareSourcesFromProfile

public Future<DetachSoftwareSourcesFromProfileResponse> detachSoftwareSourcesFromProfile(DetachSoftwareSourcesFromProfileRequest request,
                                                                                         AsyncHandler<DetachSoftwareSourcesFromProfileRequest,DetachSoftwareSourcesFromProfileResponse> handler)

Description copied from interface: OnboardingAsync

Detaches the specified software sources from a profile.

Specified by:

detachSoftwareSourcesFromProfile in interface OnboardingAsync

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.

getProfile

public Future<GetProfileResponse> getProfile(GetProfileRequest request,
                                             AsyncHandler<GetProfileRequest,GetProfileResponse> handler)

Description copied from interface: OnboardingAsync

Returns information about the specified registration profile.

Specified by:

getProfile in interface OnboardingAsync

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.

getProfileVersion

public Future<GetProfileVersionResponse> getProfileVersion(GetProfileVersionRequest request,
                                                           AsyncHandler<GetProfileVersionRequest,GetProfileVersionResponse> handler)

Description copied from interface: OnboardingAsync

Returns information about the version of the specified registration profile.

Specified by:

getProfileVersion in interface OnboardingAsync

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.

listProfileAvailableSoftwareSources

public Future<ListProfileAvailableSoftwareSourcesResponse> listProfileAvailableSoftwareSources(ListProfileAvailableSoftwareSourcesRequest request,
                                                                                               AsyncHandler<ListProfileAvailableSoftwareSourcesRequest,ListProfileAvailableSoftwareSourcesResponse> handler)

Description copied from interface: OnboardingAsync

Lists available software sources for a specified profile.

Filter the list against a variety of criteria including but not limited to the software source name. The results list only software sources that have not already been added to the profile.

Specified by:

listProfileAvailableSoftwareSources in interface OnboardingAsync

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.

listProfiles

public Future<ListProfilesResponse> listProfiles(ListProfilesRequest request,
                                                 AsyncHandler<ListProfilesRequest,ListProfilesResponse> handler)

Description copied from interface: OnboardingAsync

Lists registration profiles that match the specified compartment or profile OCID.

Filter the list against a variety of criteria including but not limited to its name, status, vendor name, and architecture type.

Specified by:

listProfiles in interface OnboardingAsync

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.

updateProfile

public Future<UpdateProfileResponse> updateProfile(UpdateProfileRequest request,
                                                   AsyncHandler<UpdateProfileRequest,UpdateProfileResponse> handler)

Description copied from interface: OnboardingAsync

Updates the specified profile’s name, description, and tags.

Specified by:

updateProfile in interface OnboardingAsync

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

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()

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)