com.oracle.bmc.waas.model

Class HumanInteractionChallenge.Builder

java.lang.Object

com.oracle.bmc.waas.model.HumanInteractionChallenge.Builder

Enclosing class:

HumanInteractionChallenge

public static class HumanInteractionChallenge.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
HumanInteractionChallenge.Builder	action(HumanInteractionChallenge.Action action) The action to take against requests from detected bots.
HumanInteractionChallenge.Builder	actionExpirationInSeconds(Integer actionExpirationInSeconds) The number of seconds between challenges for the same IP address.
HumanInteractionChallenge	build()
HumanInteractionChallenge.Builder	challengeSettings(BlockChallengeSettings challengeSettings)
HumanInteractionChallenge.Builder	copy(HumanInteractionChallenge model)
HumanInteractionChallenge.Builder	failureThreshold(Integer failureThreshold) The number of failed requests before taking action.
HumanInteractionChallenge.Builder	failureThresholdExpirationInSeconds(Integer failureThresholdExpirationInSeconds) The number of seconds before the failure threshold resets.
HumanInteractionChallenge.Builder	interactionThreshold(Integer interactionThreshold) The number of interactions required to pass the challenge.
HumanInteractionChallenge.Builder	isEnabled(Boolean isEnabled) Enables or disables the human interaction challenge Web Application Firewall feature.
HumanInteractionChallenge.Builder	isNatEnabled(Boolean isNatEnabled) 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.
HumanInteractionChallenge.Builder	recordingPeriodInSeconds(Integer recordingPeriodInSeconds) The number of seconds to record the interactions from the user.
HumanInteractionChallenge.Builder	setHttpHeader(Header setHttpHeader) Adds an additional HTTP header to requests that fail the challenge before being passed to the origin.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

isEnabled

public HumanInteractionChallenge.Builder isEnabled(Boolean isEnabled)

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

Parameters:

isEnabled - the value to set

Returns:

this builder

action

public HumanInteractionChallenge.Builder action(HumanInteractionChallenge.Action action)

The action to take against requests from detected bots. If unspecified, defaults to DETECT.

Parameters:

action - the value to set

Returns:

this builder

failureThreshold

public HumanInteractionChallenge.Builder failureThreshold(Integer failureThreshold)

The number of failed requests before taking action. If unspecified, defaults to 10.

Parameters:

failureThreshold - the value to set

Returns:

this builder

actionExpirationInSeconds

public HumanInteractionChallenge.Builder actionExpirationInSeconds(Integer actionExpirationInSeconds)

The number of seconds between challenges for the same IP address. If unspecified, defaults to 60.

Parameters:

actionExpirationInSeconds - the value to set

Returns:

this builder

failureThresholdExpirationInSeconds

public HumanInteractionChallenge.Builder failureThresholdExpirationInSeconds(Integer failureThresholdExpirationInSeconds)

The number of seconds before the failure threshold resets. If unspecified, defaults to 60.

Parameters:

failureThresholdExpirationInSeconds - the value to set

Returns:

this builder

interactionThreshold

public HumanInteractionChallenge.Builder interactionThreshold(Integer interactionThreshold)

The number of interactions required to pass the challenge. If unspecified, defaults to 3.

Parameters:

interactionThreshold - the value to set

Returns:

this builder

recordingPeriodInSeconds

public HumanInteractionChallenge.Builder recordingPeriodInSeconds(Integer recordingPeriodInSeconds)

The number of seconds to record the interactions from the user. If unspecified, defaults to 15.

Parameters:

recordingPeriodInSeconds - the value to set

Returns:

this builder

setHttpHeader

public HumanInteractionChallenge.Builder setHttpHeader(Header setHttpHeader)

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.

Parameters:

setHttpHeader - the value to set

Returns:

this builder

challengeSettings

public HumanInteractionChallenge.Builder challengeSettings(BlockChallengeSettings challengeSettings)

isNatEnabled

public HumanInteractionChallenge.Builder isNatEnabled(Boolean isNatEnabled)

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.

Parameters:

isNatEnabled - the value to set

Returns:

this builder

build

public HumanInteractionChallenge build()

copy

public HumanInteractionChallenge.Builder copy(HumanInteractionChallenge model)