Package com.oracle.bmc.waf.model

Class RequestProtection

java.lang.Object

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

com.oracle.bmc.waf.model.RequestProtection

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

Module that allows to enable OCI-managed protection capabilities for incoming HTTP requests.
Note: Objects should always be created or deserialized using the RequestProtection.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 RequestProtection.Builder, which maintain a set of all explicitly set fields called RequestProtection.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	RequestProtection.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
RequestProtection(List<ProtectionRule> rules, Integer bodyInspectionSizeLimitInBytes, String bodyInspectionSizeLimitExceededActionName)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static RequestProtection.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getBodyInspectionSizeLimitExceededActionName()	References action by name from actions defined in WebAppFirewallPolicy.
Integer	getBodyInspectionSizeLimitInBytes()	Maximum size of inspected HTTP message body in bytes.
List<ProtectionRule>	getRules()	Ordered list of ProtectionRules.
int	hashCode()
RequestProtection.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

RequestProtection

@Deprecated
@ConstructorProperties({"rules","bodyInspectionSizeLimitInBytes","bodyInspectionSizeLimitExceededActionName"})
public RequestProtection(List<ProtectionRule> rules,
                         Integer bodyInspectionSizeLimitInBytes,
                         String bodyInspectionSizeLimitExceededActionName)

Deprecated.

Method Detail

builder

public static RequestProtection.Builder builder()

Create a new builder.

toBuilder

public RequestProtection.Builder toBuilder()

getRules

public List<ProtectionRule> getRules()

Ordered list of ProtectionRules.

Rules are executed in order of appearance in this array. ProtectionRules in this array can only use protection Capabilities of REQUEST_PROTECTION_CAPABILITY type.

Returns:

the value

getBodyInspectionSizeLimitInBytes

public Integer getBodyInspectionSizeLimitInBytes()

Maximum size of inspected HTTP message body in bytes.

Actions to take if this limit is exceeded are defined in bodyInspectionSizeLimitExceededActionName.

Body inspection maximum size allowed is defined with per-tenancy limit: 8192 bytes.

Returns:

the value

getBodyInspectionSizeLimitExceededActionName

public String getBodyInspectionSizeLimitExceededActionName()

References action by name from actions defined in WebAppFirewallPolicy.

Executed if HTTP message body size exceeds limit set in field bodyInspectionSizeLimitInBytes.

If this field is null HTTP message body will inspected up to bodyInspectionSizeLimitInBytes and the rest will not be inspected by Protection Capabilities.

Allowed action types: * **RETURN_HTTP_RESPONSE** terminates further execution of modules and rules and returns defined HTTP response.

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