Class HumanInteractionChallenge.Builder

    • 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
      • 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
      • 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