Package com.oracle.bmc.waas.model

Class WafConfigDetails

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.waas.model.WafConfigDetails

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20181116")
public final class WafConfigDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

The Web Application Firewall configuration for the WAAS policy creation.
Note: Objects should always be created or deserialized using the WafConfigDetails.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the WafConfigDetails.Builder, which maintain a set of all explicitly set fields called WafConfigDetails.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WafConfigDetails.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor

Description

WafConfigDetails(List<AccessRule> accessRules, AddressRateLimiting addressRateLimiting, List<Captcha> captchas, DeviceFingerprintChallenge deviceFingerprintChallenge, HumanInteractionChallenge humanInteractionChallenge, JsChallenge jsChallenge, String origin, List<CachingRule> cachingRules, List<CustomProtectionRuleSetting> customProtectionRules, List<String> originGroups, ProtectionSettings protectionSettings, List<Whitelist> whitelists)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static WafConfigDetails.Builder	builder()	Create a new builder.
boolean	equals(Object o)
List<AccessRule>	getAccessRules()	The access rules applied to the Web Application Firewall.
AddressRateLimiting	getAddressRateLimiting()	The settings used to limit the number of requests from an IP address.
List<CachingRule>	getCachingRules()	A list of caching rules applied to the web application.
List<Captcha>	getCaptchas()	A list of CAPTCHA challenge settings.
List<CustomProtectionRuleSetting>	getCustomProtectionRules()	A list of the custom protection rule OCIDs and their actions.
DeviceFingerprintChallenge	getDeviceFingerprintChallenge()	The device fingerprint challenge settings.
HumanInteractionChallenge	getHumanInteractionChallenge()	The human interaction challenge settings.
JsChallenge	getJsChallenge()	The JavaScript challenge settings.
String	getOrigin()	The key in the map of origins referencing the origin used for the Web Application Firewall.
List<String>	getOriginGroups()	The map of origin groups and their keys used to associate origins to the wafConfig.
ProtectionSettings	getProtectionSettings()	The settings applied to protection rules.
List<Whitelist>	getWhitelists()	A list of IP addresses that bypass the Web Application Firewall.
int	hashCode()
WafConfigDetails.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WafConfigDetails

@Deprecated
@ConstructorProperties({"accessRules","addressRateLimiting","captchas","deviceFingerprintChallenge","humanInteractionChallenge","jsChallenge","origin","cachingRules","customProtectionRules","originGroups","protectionSettings","whitelists"})
public WafConfigDetails(List<AccessRule> accessRules,
                        AddressRateLimiting addressRateLimiting,
                        List<Captcha> captchas,
                        DeviceFingerprintChallenge deviceFingerprintChallenge,
                        HumanInteractionChallenge humanInteractionChallenge,
                        JsChallenge jsChallenge,
                        String origin,
                        List<CachingRule> cachingRules,
                        List<CustomProtectionRuleSetting> customProtectionRules,
                        List<String> originGroups,
                        ProtectionSettings protectionSettings,
                        List<Whitelist> whitelists)

Deprecated.

Method Detail

builder

public static WafConfigDetails.Builder builder()

Create a new builder.

toBuilder

public WafConfigDetails.Builder toBuilder()

getAccessRules

public List<AccessRule> getAccessRules()

The access rules applied to the Web Application Firewall.

Access rules allow custom content access policies to be defined and ALLOW, DETECT, or BLOCK actions to be taken on a request when specified criteria are met.

Returns:

the value

getAddressRateLimiting

public AddressRateLimiting getAddressRateLimiting()

The settings used to limit the number of requests from an IP address.

Returns:

the value

getCaptchas

public List<Captcha> getCaptchas()

A list of CAPTCHA challenge settings.

CAPTCHAs challenge requests to ensure a human is attempting to reach the specified URL and not a bot.

Returns:

the value

getDeviceFingerprintChallenge

public DeviceFingerprintChallenge getDeviceFingerprintChallenge()

The device fingerprint challenge settings.

Blocks bots based on unique device fingerprint information.

Returns:

the value

getHumanInteractionChallenge

public HumanInteractionChallenge getHumanInteractionChallenge()

The human interaction challenge settings.

Detects natural human interactions such as mouse movements, time on site, and page scrolling to identify bots.

Returns:

the value

getJsChallenge

public JsChallenge getJsChallenge()

The JavaScript challenge settings.

Blocks bots by challenging requests from browsers that have no JavaScript support.

Returns:

the value

getOrigin

public String getOrigin()

The key in the map of origins referencing the origin used for the Web Application Firewall.

The origin must already be included in Origins. Required when creating the WafConfig resource, but is not required upon updating the configuration.

Returns:

the value

getCachingRules

public List<CachingRule> getCachingRules()

A list of caching rules applied to the web application.

Returns:

the value

getCustomProtectionRules

public List<CustomProtectionRuleSetting> getCustomProtectionRules()

A list of the custom protection rule OCIDs and their actions.

Returns:

the value

getOriginGroups

public List<String> getOriginGroups()

The map of origin groups and their keys used to associate origins to the wafConfig.

Origin groups allow you to apply weights to groups of origins for load balancing purposes. Origins with higher weights will receive larger proportions of client requests. To add additional origins to your WAAS policy, update the origins field of a UpdateWaasPolicy request.

Returns:

the value

getProtectionSettings

public ProtectionSettings getProtectionSettings()

The settings applied to protection rules.

Returns:

the value

getWhitelists

public List<Whitelist> getWhitelists()

A list of IP addresses that bypass the Web Application Firewall.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel