com.oracle.bmc.waf.model

Class RequestAccessControl

java.lang.Object

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

com.oracle.bmc.waf.model.RequestAccessControl

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

Module that allows inspection of HTTP request properties and to return a defined HTTP response. In this module, rules with the name ‘Default Action’ are not allowed, since this name is reserved for default action logs.
Note: Objects should always be created or deserialized using the RequestAccessControl.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 RequestAccessControl.Builder, which maintain a set of all explicitly set fields called ExplicitlySetBmcModel.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take ExplicitlySetBmcModel.__explicitlySet__ into account. The constructor, on the other hand, does not set ExplicitlySetBmcModel.__explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RequestAccessControl.Builder

Constructor Summary

Constructors

Constructor and Description
RequestAccessControl(String defaultActionName, List<AccessControlRule> rules) Deprecated.

Method Summary

Modifier and Type	Method and Description
static RequestAccessControl.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getDefaultActionName() References an default Action to take if no AccessControlRule was matched.
List<AccessControlRule>	getRules() Ordered list of AccessControlRules.
int	hashCode()
RequestAccessControl.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

RequestAccessControl

@Deprecated
 @ConstructorProperties(value={"defaultActionName","rules"})
public RequestAccessControl(String defaultActionName,
                                                                                                     List<AccessControlRule> rules)

Deprecated.

Method Detail

builder

public static RequestAccessControl.Builder builder()

Create a new builder.

toBuilder

public RequestAccessControl.Builder toBuilder()

getDefaultActionName

public String getDefaultActionName()

References an default Action to take if no AccessControlRule was matched. Allowed action types:

**ALLOW** continues execution of other modules and their rules.

**RETURN_HTTP_RESPONSE** terminates further execution of modules and rules and returns defined HTTP response.

Returns:

the value

getRules

public List<AccessControlRule> getRules()

Ordered list of AccessControlRules. Rules are executed in order of appearance in this array.

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