Package com.oracle.bmc.waas.model

Class JsChallenge

java.lang.Object

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

com.oracle.bmc.waas.model.JsChallenge

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

The JavaScript challenge settings.

JavaScript Challenge is the function to filter abnormal or malicious bots and allow access to real clients.
Note: Objects should always be created or deserialized using the JsChallenge.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 JsChallenge.Builder, which maintain a set of all explicitly set fields called JsChallenge.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	JsChallenge.Action	The action to take against requests from detected bots.
static class	JsChallenge.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
JsChallenge(Boolean isEnabled, JsChallenge.Action action, Integer failureThreshold, Integer actionExpirationInSeconds, Header setHttpHeader, BlockChallengeSettings challengeSettings, Boolean areRedirectsChallenged, List<AccessRuleCriteria> criteria, Boolean isNatEnabled)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static JsChallenge.Builder	builder()	Create a new builder.
boolean	equals(Object o)
JsChallenge.Action	getAction()	The action to take against requests from detected bots.
Integer	getActionExpirationInSeconds()	The number of seconds between challenges from the same IP address.
Boolean	getAreRedirectsChallenged()	When enabled, redirect responses from the origin will also be challenged.
BlockChallengeSettings	getChallengeSettings()
List<AccessRuleCriteria>	getCriteria()	When defined, the JavaScript Challenge would be applied only for the requests that matched all the listed conditions.
Integer	getFailureThreshold()	The number of failed requests before taking action.
Boolean	getIsEnabled()	Enables or disables the JavaScript challenge Web Application Firewall feature.
Boolean	getIsNatEnabled()	When enabled, the user is identified not only by the IP address but also by an unique additional hash, which prevents blocking visitors with shared IP addresses.
Header	getSetHttpHeader()	Adds an additional HTTP header to requests that fail the challenge before being passed to the origin.
int	hashCode()
JsChallenge.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

JsChallenge

@Deprecated
@ConstructorProperties({"isEnabled","action","failureThreshold","actionExpirationInSeconds","setHttpHeader","challengeSettings","areRedirectsChallenged","criteria","isNatEnabled"})
public JsChallenge(Boolean isEnabled,
                   JsChallenge.Action action,
                   Integer failureThreshold,
                   Integer actionExpirationInSeconds,
                   Header setHttpHeader,
                   BlockChallengeSettings challengeSettings,
                   Boolean areRedirectsChallenged,
                   List<AccessRuleCriteria> criteria,
                   Boolean isNatEnabled)

Deprecated.

Method Detail

builder

public static JsChallenge.Builder builder()

Create a new builder.

toBuilder

public JsChallenge.Builder toBuilder()

getIsEnabled

public Boolean getIsEnabled()

Enables or disables the JavaScript challenge Web Application Firewall feature.

Returns:

the value

getAction

public JsChallenge.Action getAction()

The action to take against requests from detected bots.

If unspecified, defaults to DETECT.

Returns:

the value

getFailureThreshold

public Integer getFailureThreshold()

The number of failed requests before taking action.

If unspecified, defaults to 10.

Returns:

the value

getActionExpirationInSeconds

public Integer getActionExpirationInSeconds()

The number of seconds between challenges from the same IP address.

If unspecified, defaults to 60.

Returns:

the value

getSetHttpHeader

public Header getSetHttpHeader()

Adds an additional HTTP header to requests that fail the challenge before being passed to the origin.

Only applicable when the action is set to DETECT.

Returns:

the value

getChallengeSettings

public BlockChallengeSettings getChallengeSettings()

getAreRedirectsChallenged

public Boolean getAreRedirectsChallenged()

When enabled, redirect responses from the origin will also be challenged.

This will change HTTP 301/302 responses from origin to HTTP 200 with an HTML body containing JavaScript page redirection.

Returns:

the value

getCriteria

public List<AccessRuleCriteria> getCriteria()

When defined, the JavaScript Challenge would be applied only for the requests that matched all the listed conditions.

Returns:

the value

getIsNatEnabled

public Boolean getIsNatEnabled()

When enabled, the user is identified not only by the IP address but also by an unique additional hash, which prevents blocking visitors with shared IP addresses.

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