com.oracle.bmc.lockbox

Class LockboxAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.lockbox.LockboxAsyncClient

All Implemented Interfaces:

LockboxAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220126")
public class LockboxAsyncClient
extends BaseAsyncClient
implements LockboxAsync

Async client implementation for Lockbox 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	LockboxAsyncClient.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 Lockbox.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static LockboxAsyncClient.Builder	builder() Create a builder for this client.
Future<CancelWorkRequestResponse>	cancelWorkRequest(CancelWorkRequestRequest request, AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler) Cancels the work request with the given ID.
Future<ChangeApprovalTemplateCompartmentResponse>	changeApprovalTemplateCompartment(ChangeApprovalTemplateCompartmentRequest request, AsyncHandler<ChangeApprovalTemplateCompartmentRequest,ChangeApprovalTemplateCompartmentResponse> handler) Moves an ApprovalTemplate resource from one compartment identifier to another.
Future<ChangeLockboxCompartmentResponse>	changeLockboxCompartment(ChangeLockboxCompartmentRequest request, AsyncHandler<ChangeLockboxCompartmentRequest,ChangeLockboxCompartmentResponse> handler) Moves a Lockbox resource from one compartment identifier to another.
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<CreateAccessRequestResponse>	createAccessRequest(CreateAccessRequestRequest request, AsyncHandler<CreateAccessRequestRequest,CreateAccessRequestResponse> handler) Creates a new access request.
Future<CreateApprovalTemplateResponse>	createApprovalTemplate(CreateApprovalTemplateRequest request, AsyncHandler<CreateApprovalTemplateRequest,CreateApprovalTemplateResponse> handler) Creates a new approval template.
Future<CreateLockboxResponse>	createLockbox(CreateLockboxRequest request, AsyncHandler<CreateLockboxRequest,CreateLockboxResponse> handler) Creates a new Lockbox.
Future<DeleteApprovalTemplateResponse>	deleteApprovalTemplate(DeleteApprovalTemplateRequest request, AsyncHandler<DeleteApprovalTemplateRequest,DeleteApprovalTemplateResponse> handler) Deletes an ApprovalTemplate resource by identifier
Future<DeleteLockboxResponse>	deleteLockbox(DeleteLockboxRequest request, AsyncHandler<DeleteLockboxRequest,DeleteLockboxResponse> handler) Deletes a Lockbox resource by identifier
Future<ExportAccessRequestsResponse>	exportAccessRequests(ExportAccessRequestsRequest request, AsyncHandler<ExportAccessRequestsRequest,ExportAccessRequestsResponse> handler) Exports a list of AccessRequestSummary objects within a compartment and during a specified time range in text format.
Future<GetAccessMaterialsResponse>	getAccessMaterials(GetAccessMaterialsRequest request, AsyncHandler<GetAccessMaterialsRequest,GetAccessMaterialsResponse> handler) Retrieves the access credential/material associated with the access request.
Future<GetAccessRequestResponse>	getAccessRequest(GetAccessRequestRequest request, AsyncHandler<GetAccessRequestRequest,GetAccessRequestResponse> handler) Retrieves an access request identified by the access request ID.
Future<GetAccessRequestInternalResponse>	getAccessRequestInternal(GetAccessRequestInternalRequest request, AsyncHandler<GetAccessRequestInternalRequest,GetAccessRequestInternalResponse> handler) Retrieves an access request identified by the access request ID for internal use.
Future<GetApprovalTemplateResponse>	getApprovalTemplate(GetApprovalTemplateRequest request, AsyncHandler<GetApprovalTemplateRequest,GetApprovalTemplateResponse> handler) Retrieves an approval template identified by the approval template ID.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Future<GetLockboxResponse>	getLockbox(GetLockboxRequest request, AsyncHandler<GetLockboxRequest,GetLockboxResponse> handler) Gets a Lockbox by identifier
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler) Gets details of the work request with the given ID.
Future<HandleAccessRequestResponse>	handleAccessRequest(HandleAccessRequestRequest request, AsyncHandler<HandleAccessRequestRequest,HandleAccessRequestResponse> handler) Handle the AccessRequest
Future<ListAccessRequestsResponse>	listAccessRequests(ListAccessRequestsRequest request, AsyncHandler<ListAccessRequestsRequest,ListAccessRequestsResponse> handler) Retrieves a list of AccessRequestSummary objects in a compartment.
Future<ListApprovalTemplatesResponse>	listApprovalTemplates(ListApprovalTemplatesRequest request, AsyncHandler<ListApprovalTemplatesRequest,ListApprovalTemplatesResponse> handler) Retrieves a list of ApprovalTemplateSummary objects in a compartment.
Future<ListLockboxesResponse>	listLockboxes(ListLockboxesRequest request, AsyncHandler<ListLockboxesRequest,ListLockboxesResponse> handler) Returns a list of Lockboxes.
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler) Returns a (paginated) list of errors for the work request with the given ID.
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler) Returns a (paginated) list of logs for the work request with the given ID.
Future<ListWorkRequestsResponse>	listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler) Lists the work requests in a 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’).
Future<UpdateApprovalTemplateResponse>	updateApprovalTemplate(UpdateApprovalTemplateRequest request, AsyncHandler<UpdateApprovalTemplateRequest,UpdateApprovalTemplateResponse> handler) Updates the ApprovalTemplate
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
Future<UpdateLockboxResponse>	updateLockbox(UpdateLockboxRequest request, AsyncHandler<UpdateLockboxRequest,UpdateLockboxResponse> handler) Updates the Lockbox
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.lockbox.LockboxAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Lockbox.

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

LockboxAsyncClient

@Deprecated
public LockboxAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

LockboxAsyncClient

@Deprecated
public LockboxAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                      ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

LockboxAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

LockboxAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

LockboxAsyncClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

LockboxAsyncClient

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

LockboxAsyncClient

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

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: LockboxAsync

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 LockboxAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: LockboxAsync

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 LockboxAsync

Parameters:

regionId - The public region ID.

cancelWorkRequest

public Future<CancelWorkRequestResponse> cancelWorkRequest(CancelWorkRequestRequest request,
                                                           AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler)

Description copied from interface: LockboxAsync

Cancels the work request with the given ID.

Specified by:

cancelWorkRequest in interface LockboxAsync

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.

changeApprovalTemplateCompartment

public Future<ChangeApprovalTemplateCompartmentResponse> changeApprovalTemplateCompartment(ChangeApprovalTemplateCompartmentRequest request,
                                                                                           AsyncHandler<ChangeApprovalTemplateCompartmentRequest,ChangeApprovalTemplateCompartmentResponse> handler)

Description copied from interface: LockboxAsync

Moves an ApprovalTemplate resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeApprovalTemplateCompartment in interface LockboxAsync

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.

changeLockboxCompartment

public Future<ChangeLockboxCompartmentResponse> changeLockboxCompartment(ChangeLockboxCompartmentRequest request,
                                                                         AsyncHandler<ChangeLockboxCompartmentRequest,ChangeLockboxCompartmentResponse> handler)

Description copied from interface: LockboxAsync

Moves a Lockbox resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeLockboxCompartment in interface LockboxAsync

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.

createAccessRequest

public Future<CreateAccessRequestResponse> createAccessRequest(CreateAccessRequestRequest request,
                                                               AsyncHandler<CreateAccessRequestRequest,CreateAccessRequestResponse> handler)

Description copied from interface: LockboxAsync

Creates a new access request.

Specified by:

createAccessRequest in interface LockboxAsync

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.

createApprovalTemplate

public Future<CreateApprovalTemplateResponse> createApprovalTemplate(CreateApprovalTemplateRequest request,
                                                                     AsyncHandler<CreateApprovalTemplateRequest,CreateApprovalTemplateResponse> handler)

Description copied from interface: LockboxAsync

Creates a new approval template.

Specified by:

createApprovalTemplate in interface LockboxAsync

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.

createLockbox

public Future<CreateLockboxResponse> createLockbox(CreateLockboxRequest request,
                                                   AsyncHandler<CreateLockboxRequest,CreateLockboxResponse> handler)

Description copied from interface: LockboxAsync

Creates a new Lockbox.

Specified by:

createLockbox in interface LockboxAsync

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.

deleteApprovalTemplate

public Future<DeleteApprovalTemplateResponse> deleteApprovalTemplate(DeleteApprovalTemplateRequest request,
                                                                     AsyncHandler<DeleteApprovalTemplateRequest,DeleteApprovalTemplateResponse> handler)

Description copied from interface: LockboxAsync

Deletes an ApprovalTemplate resource by identifier

Specified by:

deleteApprovalTemplate in interface LockboxAsync

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.

deleteLockbox

public Future<DeleteLockboxResponse> deleteLockbox(DeleteLockboxRequest request,
                                                   AsyncHandler<DeleteLockboxRequest,DeleteLockboxResponse> handler)

Description copied from interface: LockboxAsync

Deletes a Lockbox resource by identifier

Specified by:

deleteLockbox in interface LockboxAsync

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.

exportAccessRequests

public Future<ExportAccessRequestsResponse> exportAccessRequests(ExportAccessRequestsRequest request,
                                                                 AsyncHandler<ExportAccessRequestsRequest,ExportAccessRequestsResponse> handler)

Description copied from interface: LockboxAsync

Exports a list of AccessRequestSummary objects within a compartment and during a specified time range in text format. You can filter the results by problem severity.

Specified by:

exportAccessRequests in interface LockboxAsync

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.

getAccessMaterials

public Future<GetAccessMaterialsResponse> getAccessMaterials(GetAccessMaterialsRequest request,
                                                             AsyncHandler<GetAccessMaterialsRequest,GetAccessMaterialsResponse> handler)

Description copied from interface: LockboxAsync

Retrieves the access credential/material associated with the access request.

Specified by:

getAccessMaterials in interface LockboxAsync

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.

getAccessRequest

public Future<GetAccessRequestResponse> getAccessRequest(GetAccessRequestRequest request,
                                                         AsyncHandler<GetAccessRequestRequest,GetAccessRequestResponse> handler)

Description copied from interface: LockboxAsync

Retrieves an access request identified by the access request ID.

Specified by:

getAccessRequest in interface LockboxAsync

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.

getAccessRequestInternal

public Future<GetAccessRequestInternalResponse> getAccessRequestInternal(GetAccessRequestInternalRequest request,
                                                                         AsyncHandler<GetAccessRequestInternalRequest,GetAccessRequestInternalResponse> handler)

Description copied from interface: LockboxAsync

Retrieves an access request identified by the access request ID for internal use.

Specified by:

getAccessRequestInternal in interface LockboxAsync

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.

getApprovalTemplate

public Future<GetApprovalTemplateResponse> getApprovalTemplate(GetApprovalTemplateRequest request,
                                                               AsyncHandler<GetApprovalTemplateRequest,GetApprovalTemplateResponse> handler)

Description copied from interface: LockboxAsync

Retrieves an approval template identified by the approval template ID.

Specified by:

getApprovalTemplate in interface LockboxAsync

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.

getLockbox

public Future<GetLockboxResponse> getLockbox(GetLockboxRequest request,
                                             AsyncHandler<GetLockboxRequest,GetLockboxResponse> handler)

Description copied from interface: LockboxAsync

Gets a Lockbox by identifier

Specified by:

getLockbox in interface LockboxAsync

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: LockboxAsync

Gets details of the work request with the given ID.

Specified by:

getWorkRequest in interface LockboxAsync

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.

handleAccessRequest

public Future<HandleAccessRequestResponse> handleAccessRequest(HandleAccessRequestRequest request,
                                                               AsyncHandler<HandleAccessRequestRequest,HandleAccessRequestResponse> handler)

Description copied from interface: LockboxAsync

Handle the AccessRequest

Specified by:

handleAccessRequest in interface LockboxAsync

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.

listAccessRequests

public Future<ListAccessRequestsResponse> listAccessRequests(ListAccessRequestsRequest request,
                                                             AsyncHandler<ListAccessRequestsRequest,ListAccessRequestsResponse> handler)

Description copied from interface: LockboxAsync

Retrieves a list of AccessRequestSummary objects in a compartment.

Specified by:

listAccessRequests in interface LockboxAsync

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.

listApprovalTemplates

public Future<ListApprovalTemplatesResponse> listApprovalTemplates(ListApprovalTemplatesRequest request,
                                                                   AsyncHandler<ListApprovalTemplatesRequest,ListApprovalTemplatesResponse> handler)

Description copied from interface: LockboxAsync

Retrieves a list of ApprovalTemplateSummary objects in a compartment.

Specified by:

listApprovalTemplates in interface LockboxAsync

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.

listLockboxes

public Future<ListLockboxesResponse> listLockboxes(ListLockboxesRequest request,
                                                   AsyncHandler<ListLockboxesRequest,ListLockboxesResponse> handler)

Description copied from interface: LockboxAsync

Returns a list of Lockboxes.

Specified by:

listLockboxes in interface LockboxAsync

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: LockboxAsync

Returns a (paginated) list of errors for the work request with the given ID.

Specified by:

listWorkRequestErrors in interface LockboxAsync

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: LockboxAsync

Returns a (paginated) list of logs for the work request with the given ID.

Specified by:

listWorkRequestLogs in interface LockboxAsync

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: LockboxAsync

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface LockboxAsync

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.

updateApprovalTemplate

public Future<UpdateApprovalTemplateResponse> updateApprovalTemplate(UpdateApprovalTemplateRequest request,
                                                                     AsyncHandler<UpdateApprovalTemplateRequest,UpdateApprovalTemplateResponse> handler)

Description copied from interface: LockboxAsync

Updates the ApprovalTemplate

Specified by:

updateApprovalTemplate in interface LockboxAsync

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.

updateLockbox

public Future<UpdateLockboxResponse> updateLockbox(UpdateLockboxRequest request,
                                                   AsyncHandler<UpdateLockboxRequest,UpdateLockboxResponse> handler)

Description copied from interface: LockboxAsync

Updates the Lockbox

Specified by:

updateLockbox in interface LockboxAsync

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)