com.oracle.bmc.waf

Class WafAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.waf.WafAsyncClient

All Implemented Interfaces:

WafAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210930")
public class WafAsyncClient
extends BaseAsyncClient
implements WafAsync

Async client implementation for Waf 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	WafAsyncClient.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 Waf.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static WafAsyncClient.Builder	builder() Create a builder for this client.
Future<ChangeNetworkAddressListCompartmentResponse>	changeNetworkAddressListCompartment(ChangeNetworkAddressListCompartmentRequest request, AsyncHandler<ChangeNetworkAddressListCompartmentRequest,ChangeNetworkAddressListCompartmentResponse> handler) Moves a NetworkAddressList resource from one compartment to another.
Future<ChangeWebAppFirewallCompartmentResponse>	changeWebAppFirewallCompartment(ChangeWebAppFirewallCompartmentRequest request, AsyncHandler<ChangeWebAppFirewallCompartmentRequest,ChangeWebAppFirewallCompartmentResponse> handler) Moves a Web App Firewall resource from one compartment to another.
Future<ChangeWebAppFirewallPolicyCompartmentResponse>	changeWebAppFirewallPolicyCompartment(ChangeWebAppFirewallPolicyCompartmentRequest request, AsyncHandler<ChangeWebAppFirewallPolicyCompartmentRequest,ChangeWebAppFirewallPolicyCompartmentResponse> handler) Moves a WebAppFirewallfPolicy resource from one compartment 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<CreateNetworkAddressListResponse>	createNetworkAddressList(CreateNetworkAddressListRequest request, AsyncHandler<CreateNetworkAddressListRequest,CreateNetworkAddressListResponse> handler) Creates a new NetworkAddressList.
Future<CreateWebAppFirewallResponse>	createWebAppFirewall(CreateWebAppFirewallRequest request, AsyncHandler<CreateWebAppFirewallRequest,CreateWebAppFirewallResponse> handler) Creates a new WebAppFirewall.
Future<CreateWebAppFirewallPolicyResponse>	createWebAppFirewallPolicy(CreateWebAppFirewallPolicyRequest request, AsyncHandler<CreateWebAppFirewallPolicyRequest,CreateWebAppFirewallPolicyResponse> handler) Creates a new WebAppFirewallPolicy.
Future<DeleteNetworkAddressListResponse>	deleteNetworkAddressList(DeleteNetworkAddressListRequest request, AsyncHandler<DeleteNetworkAddressListRequest,DeleteNetworkAddressListResponse> handler) Deletes a NetworkAddressList resource identified by the OCID.
Future<DeleteWebAppFirewallResponse>	deleteWebAppFirewall(DeleteWebAppFirewallRequest request, AsyncHandler<DeleteWebAppFirewallRequest,DeleteWebAppFirewallResponse> handler) Deletes a WebAppFirewall resource identified by the OCID.
Future<DeleteWebAppFirewallPolicyResponse>	deleteWebAppFirewallPolicy(DeleteWebAppFirewallPolicyRequest request, AsyncHandler<DeleteWebAppFirewallPolicyRequest,DeleteWebAppFirewallPolicyResponse> handler) Deletes a WebAppFirewallPolicy resource identified by the OCID.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetNetworkAddressListResponse>	getNetworkAddressList(GetNetworkAddressListRequest request, AsyncHandler<GetNetworkAddressListRequest,GetNetworkAddressListResponse> handler) Gets a NetworkAddressList by OCID.
Future<GetWebAppFirewallResponse>	getWebAppFirewall(GetWebAppFirewallRequest request, AsyncHandler<GetWebAppFirewallRequest,GetWebAppFirewallResponse> handler) Gets a WebAppFirewall by OCID.
Future<GetWebAppFirewallPolicyResponse>	getWebAppFirewallPolicy(GetWebAppFirewallPolicyRequest request, AsyncHandler<GetWebAppFirewallPolicyRequest,GetWebAppFirewallPolicyResponse> handler) Gets a WebAppFirewallPolicy with the given OCID.
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler) Gets the status of the WorkRequest with the given OCID.
Future<ListNetworkAddressListsResponse>	listNetworkAddressLists(ListNetworkAddressListsRequest request, AsyncHandler<ListNetworkAddressListsRequest,ListNetworkAddressListsResponse> handler) Gets a list of all NetworkAddressLists in a compartment.
Future<ListProtectionCapabilitiesResponse>	listProtectionCapabilities(ListProtectionCapabilitiesRequest request, AsyncHandler<ListProtectionCapabilitiesRequest,ListProtectionCapabilitiesResponse> handler) Lists of protection capabilities filtered by query parameters.
Future<ListProtectionCapabilityGroupTagsResponse>	listProtectionCapabilityGroupTags(ListProtectionCapabilityGroupTagsRequest request, AsyncHandler<ListProtectionCapabilityGroupTagsRequest,ListProtectionCapabilityGroupTagsResponse> handler) Lists of available group tags filtered by query parameters.
Future<ListWebAppFirewallPoliciesResponse>	listWebAppFirewallPolicies(ListWebAppFirewallPoliciesRequest request, AsyncHandler<ListWebAppFirewallPoliciesRequest,ListWebAppFirewallPoliciesResponse> handler) Gets a list of all WebAppFirewallPolicies in a compartment.
Future<ListWebAppFirewallsResponse>	listWebAppFirewalls(ListWebAppFirewallsRequest request, AsyncHandler<ListWebAppFirewallsRequest,ListWebAppFirewallsResponse> handler) Gets a list of all WebAppFirewalls in a compartment.
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler) Return a (paginated) list of errors for a given WorkRequest.
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler) Return a (paginated) list of logs for a given WorkRequest.
Future<ListWorkRequestsResponse>	listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler) Lists the WorkRequests 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’).
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
Future<UpdateNetworkAddressListResponse>	updateNetworkAddressList(UpdateNetworkAddressListRequest request, AsyncHandler<UpdateNetworkAddressListRequest,UpdateNetworkAddressListResponse> handler) Update the NetworkAddressList identified by the OCID.
Future<UpdateWebAppFirewallResponse>	updateWebAppFirewall(UpdateWebAppFirewallRequest request, AsyncHandler<UpdateWebAppFirewallRequest,UpdateWebAppFirewallResponse> handler) Updates the WebAppFirewall identified by the OCID.
Future<UpdateWebAppFirewallPolicyResponse>	updateWebAppFirewallPolicy(UpdateWebAppFirewallPolicyRequest request, AsyncHandler<UpdateWebAppFirewallPolicyRequest,UpdateWebAppFirewallPolicyResponse> handler) Update the WebAppFirewallPolicy identified by the OCID.
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.waf.WafAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Waf.

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

WafAsyncClient

@Deprecated
public WafAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

WafAsyncClient

@Deprecated
public WafAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                  ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

WafAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

WafAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

WafAsyncClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

WafAsyncClient

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

WafAsyncClient

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

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: WafAsync

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 WafAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: WafAsync

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 WafAsync

Parameters:

regionId - The public region ID.

changeNetworkAddressListCompartment

public Future<ChangeNetworkAddressListCompartmentResponse> changeNetworkAddressListCompartment(ChangeNetworkAddressListCompartmentRequest request,
                                                                                               AsyncHandler<ChangeNetworkAddressListCompartmentRequest,ChangeNetworkAddressListCompartmentResponse> handler)

Description copied from interface: WafAsync

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

Specified by:

changeNetworkAddressListCompartment in interface WafAsync

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.

changeWebAppFirewallCompartment

public Future<ChangeWebAppFirewallCompartmentResponse> changeWebAppFirewallCompartment(ChangeWebAppFirewallCompartmentRequest request,
                                                                                       AsyncHandler<ChangeWebAppFirewallCompartmentRequest,ChangeWebAppFirewallCompartmentResponse> handler)

Description copied from interface: WafAsync

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

Specified by:

changeWebAppFirewallCompartment in interface WafAsync

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.

changeWebAppFirewallPolicyCompartment

public Future<ChangeWebAppFirewallPolicyCompartmentResponse> changeWebAppFirewallPolicyCompartment(ChangeWebAppFirewallPolicyCompartmentRequest request,
                                                                                                   AsyncHandler<ChangeWebAppFirewallPolicyCompartmentRequest,ChangeWebAppFirewallPolicyCompartmentResponse> handler)

Description copied from interface: WafAsync

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

Specified by:

changeWebAppFirewallPolicyCompartment in interface WafAsync

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.

createNetworkAddressList

public Future<CreateNetworkAddressListResponse> createNetworkAddressList(CreateNetworkAddressListRequest request,
                                                                         AsyncHandler<CreateNetworkAddressListRequest,CreateNetworkAddressListResponse> handler)

Description copied from interface: WafAsync

Creates a new NetworkAddressList.

Specified by:

createNetworkAddressList in interface WafAsync

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.

createWebAppFirewall

public Future<CreateWebAppFirewallResponse> createWebAppFirewall(CreateWebAppFirewallRequest request,
                                                                 AsyncHandler<CreateWebAppFirewallRequest,CreateWebAppFirewallResponse> handler)

Description copied from interface: WafAsync

Creates a new WebAppFirewall.

Specified by:

createWebAppFirewall in interface WafAsync

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.

createWebAppFirewallPolicy

public Future<CreateWebAppFirewallPolicyResponse> createWebAppFirewallPolicy(CreateWebAppFirewallPolicyRequest request,
                                                                             AsyncHandler<CreateWebAppFirewallPolicyRequest,CreateWebAppFirewallPolicyResponse> handler)

Description copied from interface: WafAsync

Creates a new WebAppFirewallPolicy.

Specified by:

createWebAppFirewallPolicy in interface WafAsync

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.

deleteNetworkAddressList

public Future<DeleteNetworkAddressListResponse> deleteNetworkAddressList(DeleteNetworkAddressListRequest request,
                                                                         AsyncHandler<DeleteNetworkAddressListRequest,DeleteNetworkAddressListResponse> handler)

Description copied from interface: WafAsync

Deletes a NetworkAddressList resource identified by the OCID.

Specified by:

deleteNetworkAddressList in interface WafAsync

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.

deleteWebAppFirewall

public Future<DeleteWebAppFirewallResponse> deleteWebAppFirewall(DeleteWebAppFirewallRequest request,
                                                                 AsyncHandler<DeleteWebAppFirewallRequest,DeleteWebAppFirewallResponse> handler)

Description copied from interface: WafAsync

Deletes a WebAppFirewall resource identified by the OCID.

Specified by:

deleteWebAppFirewall in interface WafAsync

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.

deleteWebAppFirewallPolicy

public Future<DeleteWebAppFirewallPolicyResponse> deleteWebAppFirewallPolicy(DeleteWebAppFirewallPolicyRequest request,
                                                                             AsyncHandler<DeleteWebAppFirewallPolicyRequest,DeleteWebAppFirewallPolicyResponse> handler)

Description copied from interface: WafAsync

Deletes a WebAppFirewallPolicy resource identified by the OCID.

Specified by:

deleteWebAppFirewallPolicy in interface WafAsync

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.

getNetworkAddressList

public Future<GetNetworkAddressListResponse> getNetworkAddressList(GetNetworkAddressListRequest request,
                                                                   AsyncHandler<GetNetworkAddressListRequest,GetNetworkAddressListResponse> handler)

Description copied from interface: WafAsync

Gets a NetworkAddressList by OCID.

Specified by:

getNetworkAddressList in interface WafAsync

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.

getWebAppFirewall

public Future<GetWebAppFirewallResponse> getWebAppFirewall(GetWebAppFirewallRequest request,
                                                           AsyncHandler<GetWebAppFirewallRequest,GetWebAppFirewallResponse> handler)

Description copied from interface: WafAsync

Gets a WebAppFirewall by OCID.

Specified by:

getWebAppFirewall in interface WafAsync

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.

getWebAppFirewallPolicy

public Future<GetWebAppFirewallPolicyResponse> getWebAppFirewallPolicy(GetWebAppFirewallPolicyRequest request,
                                                                       AsyncHandler<GetWebAppFirewallPolicyRequest,GetWebAppFirewallPolicyResponse> handler)

Description copied from interface: WafAsync

Gets a WebAppFirewallPolicy with the given OCID.

Specified by:

getWebAppFirewallPolicy in interface WafAsync

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

Gets the status of the WorkRequest with the given OCID.

Specified by:

getWorkRequest in interface WafAsync

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.

listNetworkAddressLists

public Future<ListNetworkAddressListsResponse> listNetworkAddressLists(ListNetworkAddressListsRequest request,
                                                                       AsyncHandler<ListNetworkAddressListsRequest,ListNetworkAddressListsResponse> handler)

Description copied from interface: WafAsync

Gets a list of all NetworkAddressLists in a compartment.

Specified by:

listNetworkAddressLists in interface WafAsync

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.

listProtectionCapabilities

public Future<ListProtectionCapabilitiesResponse> listProtectionCapabilities(ListProtectionCapabilitiesRequest request,
                                                                             AsyncHandler<ListProtectionCapabilitiesRequest,ListProtectionCapabilitiesResponse> handler)

Description copied from interface: WafAsync

Lists of protection capabilities filtered by query parameters.

Specified by:

listProtectionCapabilities in interface WafAsync

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.

listProtectionCapabilityGroupTags

public Future<ListProtectionCapabilityGroupTagsResponse> listProtectionCapabilityGroupTags(ListProtectionCapabilityGroupTagsRequest request,
                                                                                           AsyncHandler<ListProtectionCapabilityGroupTagsRequest,ListProtectionCapabilityGroupTagsResponse> handler)

Description copied from interface: WafAsync

Lists of available group tags filtered by query parameters.

Specified by:

listProtectionCapabilityGroupTags in interface WafAsync

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.

listWebAppFirewallPolicies

public Future<ListWebAppFirewallPoliciesResponse> listWebAppFirewallPolicies(ListWebAppFirewallPoliciesRequest request,
                                                                             AsyncHandler<ListWebAppFirewallPoliciesRequest,ListWebAppFirewallPoliciesResponse> handler)

Description copied from interface: WafAsync

Gets a list of all WebAppFirewallPolicies in a compartment.

Specified by:

listWebAppFirewallPolicies in interface WafAsync

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.

listWebAppFirewalls

public Future<ListWebAppFirewallsResponse> listWebAppFirewalls(ListWebAppFirewallsRequest request,
                                                               AsyncHandler<ListWebAppFirewallsRequest,ListWebAppFirewallsResponse> handler)

Description copied from interface: WafAsync

Gets a list of all WebAppFirewalls in a compartment.

Specified by:

listWebAppFirewalls in interface WafAsync

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

Return a (paginated) list of errors for a given WorkRequest.

Specified by:

listWorkRequestErrors in interface WafAsync

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

Return a (paginated) list of logs for a given WorkRequest.

Specified by:

listWorkRequestLogs in interface WafAsync

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

Lists the WorkRequests in a compartment.

Specified by:

listWorkRequests in interface WafAsync

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.

updateNetworkAddressList

public Future<UpdateNetworkAddressListResponse> updateNetworkAddressList(UpdateNetworkAddressListRequest request,
                                                                         AsyncHandler<UpdateNetworkAddressListRequest,UpdateNetworkAddressListResponse> handler)

Description copied from interface: WafAsync

Update the NetworkAddressList identified by the OCID.

Specified by:

updateNetworkAddressList in interface WafAsync

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.

updateWebAppFirewall

public Future<UpdateWebAppFirewallResponse> updateWebAppFirewall(UpdateWebAppFirewallRequest request,
                                                                 AsyncHandler<UpdateWebAppFirewallRequest,UpdateWebAppFirewallResponse> handler)

Description copied from interface: WafAsync

Updates the WebAppFirewall identified by the OCID.

Specified by:

updateWebAppFirewall in interface WafAsync

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.

updateWebAppFirewallPolicy

public Future<UpdateWebAppFirewallPolicyResponse> updateWebAppFirewallPolicy(UpdateWebAppFirewallPolicyRequest request,
                                                                             AsyncHandler<UpdateWebAppFirewallPolicyRequest,UpdateWebAppFirewallPolicyResponse> handler)

Description copied from interface: WafAsync

Update the WebAppFirewallPolicy identified by the OCID.

Specified by:

updateWebAppFirewallPolicy in interface WafAsync

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)