com.oracle.bmc.vault

Class VaultsAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.vault.VaultsAsyncClient

All Implemented Interfaces:

VaultsAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180608")
public class VaultsAsyncClient
extends BaseAsyncClient
implements VaultsAsync

Async client implementation for Vaults 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	VaultsAsyncClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and 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 Vaults.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static VaultsAsyncClient.Builder	builder() Create a builder for this client.
Future<CancelSecretDeletionResponse>	cancelSecretDeletion(CancelSecretDeletionRequest request, AsyncHandler<CancelSecretDeletionRequest,CancelSecretDeletionResponse> handler) Cancels the pending deletion of the specified secret.
Future<CancelSecretRotationResponse>	cancelSecretRotation(CancelSecretRotationRequest request, AsyncHandler<CancelSecretRotationRequest,CancelSecretRotationResponse> handler) Cancels the ongoing secret rotation.
Future<CancelSecretVersionDeletionResponse>	cancelSecretVersionDeletion(CancelSecretVersionDeletionRequest request, AsyncHandler<CancelSecretVersionDeletionRequest,CancelSecretVersionDeletionResponse> handler) Cancels the scheduled deletion of a secret version.
Future<ChangeSecretCompartmentResponse>	changeSecretCompartment(ChangeSecretCompartmentRequest request, AsyncHandler<ChangeSecretCompartmentRequest,ChangeSecretCompartmentResponse> handler) Moves a secret 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<CreateSecretResponse>	createSecret(CreateSecretRequest request, AsyncHandler<CreateSecretRequest,CreateSecretResponse> handler) Creates a new secret according to the details of the request.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetSecretResponse>	getSecret(GetSecretRequest request, AsyncHandler<GetSecretRequest,GetSecretResponse> handler) Gets information about the specified secret.
Future<GetSecretVersionResponse>	getSecretVersion(GetSecretVersionRequest request, AsyncHandler<GetSecretVersionRequest,GetSecretVersionResponse> handler) Gets information about the specified version of a secret.
Future<ListSecretsResponse>	listSecrets(ListSecretsRequest request, AsyncHandler<ListSecretsRequest,ListSecretsResponse> handler) Lists all secrets in the specified vault and compartment.
Future<ListSecretVersionsResponse>	listSecretVersions(ListSecretVersionsRequest request, AsyncHandler<ListSecretVersionsRequest,ListSecretVersionsResponse> handler) Lists all secret versions for the specified secret.
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.
Future<RotateSecretResponse>	rotateSecret(RotateSecretRequest request, AsyncHandler<RotateSecretRequest,RotateSecretResponse> handler) API to force rotation of an existing secret in Vault and the specified target system; expects secret to have a valid Target System Details object
Future<ScheduleSecretDeletionResponse>	scheduleSecretDeletion(ScheduleSecretDeletionRequest request, AsyncHandler<ScheduleSecretDeletionRequest,ScheduleSecretDeletionResponse> handler) Schedules the deletion of the specified secret.
Future<ScheduleSecretVersionDeletionResponse>	scheduleSecretVersionDeletion(ScheduleSecretVersionDeletionRequest request, AsyncHandler<ScheduleSecretVersionDeletionRequest,ScheduleSecretVersionDeletionResponse> handler) Schedules the deletion of the specified secret version.
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<UpdateSecretResponse>	updateSecret(UpdateSecretRequest request, AsyncHandler<UpdateSecretRequest,UpdateSecretResponse> handler) Updates the properties of a secret.
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.vault.VaultsAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Vaults.

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

VaultsAsyncClient

@Deprecated
public VaultsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

VaultsAsyncClient

@Deprecated
public VaultsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                     ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

VaultsAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

VaultsAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

VaultsAsyncClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

VaultsAsyncClient

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

VaultsAsyncClient

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

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: VaultsAsync

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 VaultsAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: VaultsAsync

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 VaultsAsync

Parameters:

regionId - The public region ID.

cancelSecretDeletion

public Future<CancelSecretDeletionResponse> cancelSecretDeletion(CancelSecretDeletionRequest request,
                                                                 AsyncHandler<CancelSecretDeletionRequest,CancelSecretDeletionResponse> handler)

Description copied from interface: VaultsAsync

Cancels the pending deletion of the specified secret. Canceling a scheduled deletion restores the secret’s lifecycle state to what it was before you scheduled the secret for deletion.

Specified by:

cancelSecretDeletion in interface VaultsAsync

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.

cancelSecretRotation

public Future<CancelSecretRotationResponse> cancelSecretRotation(CancelSecretRotationRequest request,
                                                                 AsyncHandler<CancelSecretRotationRequest,CancelSecretRotationResponse> handler)

Description copied from interface: VaultsAsync

Cancels the ongoing secret rotation. The cancellation is contingent on how far the rotation process has progressed. Upon cancelling a rotation, all future rotations are also disabled.

Specified by:

cancelSecretRotation in interface VaultsAsync

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.

cancelSecretVersionDeletion

public Future<CancelSecretVersionDeletionResponse> cancelSecretVersionDeletion(CancelSecretVersionDeletionRequest request,
                                                                               AsyncHandler<CancelSecretVersionDeletionRequest,CancelSecretVersionDeletionResponse> handler)

Description copied from interface: VaultsAsync

Cancels the scheduled deletion of a secret version.

Specified by:

cancelSecretVersionDeletion in interface VaultsAsync

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.

changeSecretCompartment

public Future<ChangeSecretCompartmentResponse> changeSecretCompartment(ChangeSecretCompartmentRequest request,
                                                                       AsyncHandler<ChangeSecretCompartmentRequest,ChangeSecretCompartmentResponse> handler)

Description copied from interface: VaultsAsync

Moves a secret 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 the ETag values of the secret.

Specified by:

changeSecretCompartment in interface VaultsAsync

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.

createSecret

public Future<CreateSecretResponse> createSecret(CreateSecretRequest request,
                                                 AsyncHandler<CreateSecretRequest,CreateSecretResponse> handler)

Description copied from interface: VaultsAsync

Creates a new secret according to the details of the request.

This operation is not supported by the Oracle Cloud Infrastructure Terraform Provider.

Specified by:

createSecret in interface VaultsAsync

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.

getSecret

public Future<GetSecretResponse> getSecret(GetSecretRequest request,
                                           AsyncHandler<GetSecretRequest,GetSecretResponse> handler)

Description copied from interface: VaultsAsync

Gets information about the specified secret.

Specified by:

getSecret in interface VaultsAsync

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.

getSecretVersion

public Future<GetSecretVersionResponse> getSecretVersion(GetSecretVersionRequest request,
                                                         AsyncHandler<GetSecretVersionRequest,GetSecretVersionResponse> handler)

Description copied from interface: VaultsAsync

Gets information about the specified version of a secret.

Specified by:

getSecretVersion in interface VaultsAsync

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.

listSecretVersions

public Future<ListSecretVersionsResponse> listSecretVersions(ListSecretVersionsRequest request,
                                                             AsyncHandler<ListSecretVersionsRequest,ListSecretVersionsResponse> handler)

Description copied from interface: VaultsAsync

Lists all secret versions for the specified secret.

Specified by:

listSecretVersions in interface VaultsAsync

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.

listSecrets

public Future<ListSecretsResponse> listSecrets(ListSecretsRequest request,
                                               AsyncHandler<ListSecretsRequest,ListSecretsResponse> handler)

Description copied from interface: VaultsAsync

Lists all secrets in the specified vault and compartment.

Specified by:

listSecrets in interface VaultsAsync

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.

rotateSecret

public Future<RotateSecretResponse> rotateSecret(RotateSecretRequest request,
                                                 AsyncHandler<RotateSecretRequest,RotateSecretResponse> handler)

Description copied from interface: VaultsAsync

API to force rotation of an existing secret in Vault and the specified target system; expects secret to have a valid Target System Details object

Specified by:

rotateSecret in interface VaultsAsync

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.

scheduleSecretDeletion

public Future<ScheduleSecretDeletionResponse> scheduleSecretDeletion(ScheduleSecretDeletionRequest request,
                                                                     AsyncHandler<ScheduleSecretDeletionRequest,ScheduleSecretDeletionResponse> handler)

Description copied from interface: VaultsAsync

Schedules the deletion of the specified secret. This sets the lifecycle state of the secret to PENDING_DELETION and then deletes it after the specified retention period ends.

Specified by:

scheduleSecretDeletion in interface VaultsAsync

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.

scheduleSecretVersionDeletion

public Future<ScheduleSecretVersionDeletionResponse> scheduleSecretVersionDeletion(ScheduleSecretVersionDeletionRequest request,
                                                                                   AsyncHandler<ScheduleSecretVersionDeletionRequest,ScheduleSecretVersionDeletionResponse> handler)

Description copied from interface: VaultsAsync

Schedules the deletion of the specified secret version. This deletes it after the specified retention period ends. You can only delete a secret version if the secret version rotation state is marked as DEPRECATED.

Specified by:

scheduleSecretVersionDeletion in interface VaultsAsync

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.

updateSecret

public Future<UpdateSecretResponse> updateSecret(UpdateSecretRequest request,
                                                 AsyncHandler<UpdateSecretRequest,UpdateSecretResponse> handler)

Description copied from interface: VaultsAsync

Updates the properties of a secret. Specifically, you can update the version number of the secret to make that version number the current version. You can also update a secret’s description, its free-form or defined tags, rules and the secret contents. Updating the secret content automatically creates a new secret version. You cannot, however, update the current secret version number, secret contents, and secret rules at the same time. Furthermore, the secret must in an ACTIVE lifecycle state to be updated.

This operation is not supported by the Oracle Cloud Infrastructure Terraform Provider.

Specified by:

updateSecret in interface VaultsAsync

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)