Package com.oracle.bmc.waas.model

Class HumanInteractionChallenge

java.lang.Object

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

com.oracle.bmc.waas.model.HumanInteractionChallenge

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

The human interaction challenge settings.

The human interaction challenge checks various event listeners in the user’s browser to determine if there is a human user making a request.
Note: Objects should always be created or deserialized using the HumanInteractionChallenge.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 HumanInteractionChallenge.Builder, which maintain a set of all explicitly set fields called HumanInteractionChallenge.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	HumanInteractionChallenge.Action	The action to take against requests from detected bots.
static class	HumanInteractionChallenge.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
HumanInteractionChallenge(Boolean isEnabled, HumanInteractionChallenge.Action action, Integer failureThreshold, Integer actionExpirationInSeconds, Integer failureThresholdExpirationInSeconds, Integer interactionThreshold, Integer recordingPeriodInSeconds, Header setHttpHeader, BlockChallengeSettings challengeSettings, Boolean isNatEnabled)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static HumanInteractionChallenge.Builder	builder()	Create a new builder.
boolean	equals(Object o)
HumanInteractionChallenge.Action	getAction()	The action to take against requests from detected bots.
Integer	getActionExpirationInSeconds()	The number of seconds between challenges for the same IP address.
BlockChallengeSettings	getChallengeSettings()
Integer	getFailureThreshold()	The number of failed requests before taking action.
Integer	getFailureThresholdExpirationInSeconds()	The number of seconds before the failure threshold resets.
Integer	getInteractionThreshold()	The number of interactions required to pass the challenge.
Boolean	getIsEnabled()	Enables or disables the human interaction 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.
Integer	getRecordingPeriodInSeconds()	The number of seconds to record the interactions from the user.
Header	getSetHttpHeader()	Adds an additional HTTP header to requests that fail the challenge before being passed to the origin.
int	hashCode()
HumanInteractionChallenge.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

HumanInteractionChallenge

@Deprecated
@ConstructorProperties({"isEnabled","action","failureThreshold","actionExpirationInSeconds","failureThresholdExpirationInSeconds","interactionThreshold","recordingPeriodInSeconds","setHttpHeader","challengeSettings","isNatEnabled"})
public HumanInteractionChallenge(Boolean isEnabled,
                                 HumanInteractionChallenge.Action action,
                                 Integer failureThreshold,
                                 Integer actionExpirationInSeconds,
                                 Integer failureThresholdExpirationInSeconds,
                                 Integer interactionThreshold,
                                 Integer recordingPeriodInSeconds,
                                 Header setHttpHeader,
                                 BlockChallengeSettings challengeSettings,
                                 Boolean isNatEnabled)

Deprecated.

Method Detail

builder

public static HumanInteractionChallenge.Builder builder()

Create a new builder.

toBuilder

public HumanInteractionChallenge.Builder toBuilder()

getIsEnabled

public Boolean getIsEnabled()

Enables or disables the human interaction challenge Web Application Firewall feature.

Returns:

the value

getAction

public HumanInteractionChallenge.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 for the same IP address.

If unspecified, defaults to 60.

Returns:

the value

getFailureThresholdExpirationInSeconds

public Integer getFailureThresholdExpirationInSeconds()

The number of seconds before the failure threshold resets.

If unspecified, defaults to 60.

Returns:

the value

getInteractionThreshold

public Integer getInteractionThreshold()

The number of interactions required to pass the challenge.

If unspecified, defaults to 3.

Returns:

the value

getRecordingPeriodInSeconds

public Integer getRecordingPeriodInSeconds()

The number of seconds to record the interactions from the user.

If unspecified, defaults to 15.

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()

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