com.oracle.bmc.lockbox

Class LockboxClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.lockbox.LockboxClient

All Implemented Interfaces:

Lockbox, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220126")
public class LockboxClient
extends BaseSyncClient
implements Lockbox

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LockboxClient.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
LockboxClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
LockboxClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
LockboxClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
LockboxClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
LockboxClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated. Use the builder instead.
LockboxClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
LockboxClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
LockboxClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

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

clientCall

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.Lockbox

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

LockboxClient

@Deprecated
public LockboxClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

LockboxClient

@Deprecated
public LockboxClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

LockboxClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

LockboxClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

LockboxClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

LockboxClient

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

LockboxClient

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

LockboxClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see LockboxClient.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

executorService - LockboxClient.Builder.executorService

Method Detail

builder

public static LockboxClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: Lockbox

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 Lockbox

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Lockbox

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 Lockbox

Parameters:

regionId - The public region ID.

cancelWorkRequest

public CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)

Description copied from interface: Lockbox

Cancels the work request with the given ID.

Specified by:

cancelWorkRequest in interface Lockbox

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeApprovalTemplateCompartment

public ChangeApprovalTemplateCompartmentResponse changeApprovalTemplateCompartment(ChangeApprovalTemplateCompartmentRequest request)

Description copied from interface: Lockbox

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 Lockbox

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeLockboxCompartment

public ChangeLockboxCompartmentResponse changeLockboxCompartment(ChangeLockboxCompartmentRequest request)

Description copied from interface: Lockbox

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 Lockbox

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createAccessRequest

public CreateAccessRequestResponse createAccessRequest(CreateAccessRequestRequest request)

Description copied from interface: Lockbox

Creates a new access request.

Specified by:

createAccessRequest in interface Lockbox

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createApprovalTemplate

public CreateApprovalTemplateResponse createApprovalTemplate(CreateApprovalTemplateRequest request)

Description copied from interface: Lockbox

Creates a new approval template.

Specified by:

createApprovalTemplate in interface Lockbox

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createLockbox

public CreateLockboxResponse createLockbox(CreateLockboxRequest request)

Description copied from interface: Lockbox

Creates a new Lockbox.

Specified by:

createLockbox in interface Lockbox

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteApprovalTemplate

public DeleteApprovalTemplateResponse deleteApprovalTemplate(DeleteApprovalTemplateRequest request)

Description copied from interface: Lockbox

Deletes an ApprovalTemplate resource by identifier

Specified by:

deleteApprovalTemplate in interface Lockbox

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteLockbox

public DeleteLockboxResponse deleteLockbox(DeleteLockboxRequest request)

Description copied from interface: Lockbox

Deletes a Lockbox resource by identifier

Specified by:

deleteLockbox in interface Lockbox

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

exportAccessRequests

public ExportAccessRequestsResponse exportAccessRequests(ExportAccessRequestsRequest request)

Description copied from interface: Lockbox

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 Lockbox

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getAccessMaterials

public GetAccessMaterialsResponse getAccessMaterials(GetAccessMaterialsRequest request)

Description copied from interface: Lockbox

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

Specified by:

getAccessMaterials in interface Lockbox

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getAccessRequest

public GetAccessRequestResponse getAccessRequest(GetAccessRequestRequest request)

Description copied from interface: Lockbox

Retrieves an access request identified by the access request ID.

Specified by:

getAccessRequest in interface Lockbox

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getAccessRequestInternal

public GetAccessRequestInternalResponse getAccessRequestInternal(GetAccessRequestInternalRequest request)

Description copied from interface: Lockbox

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

Specified by:

getAccessRequestInternal in interface Lockbox

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getApprovalTemplate

public GetApprovalTemplateResponse getApprovalTemplate(GetApprovalTemplateRequest request)

Description copied from interface: Lockbox

Retrieves an approval template identified by the approval template ID.

Specified by:

getApprovalTemplate in interface Lockbox

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getLockbox

public GetLockboxResponse getLockbox(GetLockboxRequest request)

Description copied from interface: Lockbox

Gets a Lockbox by identifier

Specified by:

getLockbox in interface Lockbox

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWorkRequest

public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Description copied from interface: Lockbox

Gets details of the work request with the given ID.

Specified by:

getWorkRequest in interface Lockbox

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

handleAccessRequest

public HandleAccessRequestResponse handleAccessRequest(HandleAccessRequestRequest request)

Description copied from interface: Lockbox

Handle the AccessRequest

Specified by:

handleAccessRequest in interface Lockbox

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAccessRequests

public ListAccessRequestsResponse listAccessRequests(ListAccessRequestsRequest request)

Description copied from interface: Lockbox

Retrieves a list of AccessRequestSummary objects in a compartment.

Specified by:

listAccessRequests in interface Lockbox

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listApprovalTemplates

public ListApprovalTemplatesResponse listApprovalTemplates(ListApprovalTemplatesRequest request)

Description copied from interface: Lockbox

Retrieves a list of ApprovalTemplateSummary objects in a compartment.

Specified by:

listApprovalTemplates in interface Lockbox

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listLockboxes

public ListLockboxesResponse listLockboxes(ListLockboxesRequest request)

Description copied from interface: Lockbox

Returns a list of Lockboxes.

Specified by:

listLockboxes in interface Lockbox

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestErrors

public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Description copied from interface: Lockbox

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

Specified by:

listWorkRequestErrors in interface Lockbox

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestLogs

public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

Description copied from interface: Lockbox

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

Specified by:

listWorkRequestLogs in interface Lockbox

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequests

public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Description copied from interface: Lockbox

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface Lockbox

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateApprovalTemplate

public UpdateApprovalTemplateResponse updateApprovalTemplate(UpdateApprovalTemplateRequest request)

Description copied from interface: Lockbox

Updates the ApprovalTemplate

Specified by:

updateApprovalTemplate in interface Lockbox

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateLockbox

public UpdateLockboxResponse updateLockbox(UpdateLockboxRequest request)

Description copied from interface: Lockbox

Updates the Lockbox

Specified by:

updateLockbox in interface Lockbox

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public LockboxWaiters getWaiters()

Description copied from interface: Lockbox

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface Lockbox

Returns:

The service waiters.

getPaginators

public LockboxPaginators getPaginators()

Description copied from interface: Lockbox

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Specified by:

getPaginators in interface Lockbox

Returns:

The service paginators.

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()