Class WafClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.waf.WafClient
-
- All Implemented Interfaces:
Waf,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20210930") public class WafClient extends BaseSyncClient implements Waf
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classWafClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for Waf.
-
Constructor Summary
Constructors Constructor Description WafClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.WafClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.WafClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.WafClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.WafClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.WafClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.WafClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.WafClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
-
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 java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.waf.Waf
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
WafClient
@Deprecated public WafClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeWafClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
WafClient
@Deprecated public WafClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeWafClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
WafClient
@Deprecated public WafClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeWafClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
WafClient
@Deprecated public WafClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeWafClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
WafClient
@Deprecated public WafClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeWafClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
WafClient
@Deprecated public WafClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeWafClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)
-
WafClient
@Deprecated public WafClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeWafClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactories
-
WafClient
@Deprecated public WafClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeWafClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactoriesexecutorService-WafClient.Builder.executorService
-
-
Method Detail
-
builder
public static WafClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:WafSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:WafSets 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 callsetEndpoint.
-
changeNetworkAddressListCompartment
public ChangeNetworkAddressListCompartmentResponse changeNetworkAddressListCompartment(ChangeNetworkAddressListCompartmentRequest request)
Description copied from interface:WafMoves a NetworkAddressList resource from one compartment to another.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
changeNetworkAddressListCompartmentin interfaceWaf- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeWebAppFirewallCompartment
public ChangeWebAppFirewallCompartmentResponse changeWebAppFirewallCompartment(ChangeWebAppFirewallCompartmentRequest request)
Description copied from interface:WafMoves a Web App Firewall resource from one compartment to another.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
changeWebAppFirewallCompartmentin interfaceWaf- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeWebAppFirewallPolicyCompartment
public ChangeWebAppFirewallPolicyCompartmentResponse changeWebAppFirewallPolicyCompartment(ChangeWebAppFirewallPolicyCompartmentRequest request)
Description copied from interface:WafMoves a WebAppFirewallfPolicy resource from one compartment to another.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
changeWebAppFirewallPolicyCompartmentin interfaceWaf- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createNetworkAddressList
public CreateNetworkAddressListResponse createNetworkAddressList(CreateNetworkAddressListRequest request)
Description copied from interface:WafCreates a new NetworkAddressList.- Specified by:
createNetworkAddressListin interfaceWaf- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createWebAppFirewall
public CreateWebAppFirewallResponse createWebAppFirewall(CreateWebAppFirewallRequest request)
Description copied from interface:WafCreates a new WebAppFirewall.- Specified by:
createWebAppFirewallin interfaceWaf- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createWebAppFirewallPolicy
public CreateWebAppFirewallPolicyResponse createWebAppFirewallPolicy(CreateWebAppFirewallPolicyRequest request)
Description copied from interface:WafCreates a new WebAppFirewallPolicy.- Specified by:
createWebAppFirewallPolicyin interfaceWaf- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteNetworkAddressList
public DeleteNetworkAddressListResponse deleteNetworkAddressList(DeleteNetworkAddressListRequest request)
Description copied from interface:WafDeletes a NetworkAddressList resource identified by the OCID.- Specified by:
deleteNetworkAddressListin interfaceWaf- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteWebAppFirewall
public DeleteWebAppFirewallResponse deleteWebAppFirewall(DeleteWebAppFirewallRequest request)
Description copied from interface:WafDeletes a WebAppFirewall resource identified by the OCID.- Specified by:
deleteWebAppFirewallin interfaceWaf- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteWebAppFirewallPolicy
public DeleteWebAppFirewallPolicyResponse deleteWebAppFirewallPolicy(DeleteWebAppFirewallPolicyRequest request)
Description copied from interface:WafDeletes a WebAppFirewallPolicy resource identified by the OCID.- Specified by:
deleteWebAppFirewallPolicyin interfaceWaf- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getNetworkAddressList
public GetNetworkAddressListResponse getNetworkAddressList(GetNetworkAddressListRequest request)
Description copied from interface:WafGets a NetworkAddressList by OCID.- Specified by:
getNetworkAddressListin interfaceWaf- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWebAppFirewall
public GetWebAppFirewallResponse getWebAppFirewall(GetWebAppFirewallRequest request)
Description copied from interface:WafGets a WebAppFirewall by OCID.- Specified by:
getWebAppFirewallin interfaceWaf- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWebAppFirewallPolicy
public GetWebAppFirewallPolicyResponse getWebAppFirewallPolicy(GetWebAppFirewallPolicyRequest request)
Description copied from interface:WafGets a WebAppFirewallPolicy with the given OCID.- Specified by:
getWebAppFirewallPolicyin interfaceWaf- 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:WafGets the status of the WorkRequest with the given OCID.- Specified by:
getWorkRequestin interfaceWaf- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listNetworkAddressLists
public ListNetworkAddressListsResponse listNetworkAddressLists(ListNetworkAddressListsRequest request)
Description copied from interface:WafGets a list of all NetworkAddressLists in a compartment.- Specified by:
listNetworkAddressListsin interfaceWaf- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listProtectionCapabilities
public ListProtectionCapabilitiesResponse listProtectionCapabilities(ListProtectionCapabilitiesRequest request)
Description copied from interface:WafLists of protection capabilities filtered by query parameters.- Specified by:
listProtectionCapabilitiesin interfaceWaf- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listProtectionCapabilityGroupTags
public ListProtectionCapabilityGroupTagsResponse listProtectionCapabilityGroupTags(ListProtectionCapabilityGroupTagsRequest request)
Description copied from interface:WafLists of available group tags filtered by query parameters.- Specified by:
listProtectionCapabilityGroupTagsin interfaceWaf- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWebAppFirewallPolicies
public ListWebAppFirewallPoliciesResponse listWebAppFirewallPolicies(ListWebAppFirewallPoliciesRequest request)
Description copied from interface:WafGets a list of all WebAppFirewallPolicies in a compartment.- Specified by:
listWebAppFirewallPoliciesin interfaceWaf- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWebAppFirewalls
public ListWebAppFirewallsResponse listWebAppFirewalls(ListWebAppFirewallsRequest request)
Description copied from interface:WafGets a list of all WebAppFirewalls in a compartment.- Specified by:
listWebAppFirewallsin interfaceWaf- 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:WafReturn a (paginated) list of errors for a given WorkRequest.- Specified by:
listWorkRequestErrorsin interfaceWaf- 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:WafReturn a (paginated) list of logs for a given WorkRequest.- Specified by:
listWorkRequestLogsin interfaceWaf- 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:WafLists the WorkRequests in a compartment.- Specified by:
listWorkRequestsin interfaceWaf- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateNetworkAddressList
public UpdateNetworkAddressListResponse updateNetworkAddressList(UpdateNetworkAddressListRequest request)
Description copied from interface:WafUpdate the NetworkAddressList identified by the OCID.- Specified by:
updateNetworkAddressListin interfaceWaf- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateWebAppFirewall
public UpdateWebAppFirewallResponse updateWebAppFirewall(UpdateWebAppFirewallRequest request)
Description copied from interface:WafUpdates the WebAppFirewall identified by the OCID.- Specified by:
updateWebAppFirewallin interfaceWaf- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateWebAppFirewallPolicy
public UpdateWebAppFirewallPolicyResponse updateWebAppFirewallPolicy(UpdateWebAppFirewallPolicyRequest request)
Description copied from interface:WafUpdate the WebAppFirewallPolicy identified by the OCID.- Specified by:
updateWebAppFirewallPolicyin interfaceWaf- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public WafWaiters getWaiters()
Description copied from interface:WafGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceWaf- Returns:
- The service waiters.
-
getPaginators
public WafPaginators getPaginators()
Description copied from interface:WafGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginatorsin interfaceWaf- 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 userequiredParametersMap- 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 backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-