Class BlockChallengeSettings.Builder

    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • blockResponseCode

        public BlockChallengeSettings.Builder blockResponseCode​(Integer blockResponseCode)
        The response status code to return when action is set to BLOCK, blockAction is set to SET_RESPONSE_CODE or SHOW_ERROR_PAGE, and the request is blocked.

        If unspecified, defaults to 403. The list of available response codes: 200, 201, 202, 204, 206, 300, 301, 302, 303, 304, 307, 400, 401, 403, 404, 405, 408, 409, 411, 412, 413, 414, 415, 416, 422, 444, 494, 495, 496, 497, 499, 500, 501, 502, 503, 504, 507.

        Parameters:
        blockResponseCode - the value to set
        Returns:
        this builder
      • blockErrorPageMessage

        public BlockChallengeSettings.Builder blockErrorPageMessage​(String blockErrorPageMessage)
        The message to show on the error page when action is set to BLOCK, blockAction is set to SHOW_ERROR_PAGE, and the request is blocked.

        If unspecified, defaults to Access to the website is blocked.

        Parameters:
        blockErrorPageMessage - the value to set
        Returns:
        this builder
      • blockErrorPageDescription

        public BlockChallengeSettings.Builder blockErrorPageDescription​(String blockErrorPageDescription)
        The description text to show on the error page when action is set to BLOCK, blockAction is set to SHOW_ERROR_PAGE, and the request is blocked.

        If unspecified, defaults to Access blocked by website owner. Please contact support.

        Parameters:
        blockErrorPageDescription - the value to set
        Returns:
        this builder
      • blockErrorPageCode

        public BlockChallengeSettings.Builder blockErrorPageCode​(String blockErrorPageCode)
        The error code to show on the error page when action is set to BLOCK, blockAction is set to SHOW_ERROR_PAGE and the request is blocked.

        If unspecified, defaults to 403.

        Parameters:
        blockErrorPageCode - the value to set
        Returns:
        this builder
      • captchaTitle

        public BlockChallengeSettings.Builder captchaTitle​(String captchaTitle)
        The title used when showing a CAPTCHA challenge when action is set to BLOCK, blockAction is set to SHOW_CAPTCHA, and the request is blocked.

        If unspecified, defaults to Are you human?

        Parameters:
        captchaTitle - the value to set
        Returns:
        this builder
      • captchaHeader

        public BlockChallengeSettings.Builder captchaHeader​(String captchaHeader)
        The text to show in the header when showing a CAPTCHA challenge when action is set to BLOCK, blockAction is set to SHOW_CAPTCHA, and the request is blocked.

        If unspecified, defaults to We have detected an increased number of attempts to access this webapp. To help us keep this webapp secure, please let us know that you are not a robot by entering the text from captcha below.

        Parameters:
        captchaHeader - the value to set
        Returns:
        this builder
      • captchaFooter

        public BlockChallengeSettings.Builder captchaFooter​(String captchaFooter)
        The text to show in the footer when showing a CAPTCHA challenge when action is set to BLOCK, blockAction is set to SHOW_CAPTCHA, and the request is blocked.

        If unspecified, default to Enter the letters and numbers as they are shown in image above.

        Parameters:
        captchaFooter - the value to set
        Returns:
        this builder
      • captchaSubmitLabel

        public BlockChallengeSettings.Builder captchaSubmitLabel​(String captchaSubmitLabel)
        The text to show on the label of the CAPTCHA challenge submit button when action is set to BLOCK, blockAction is set to SHOW_CAPTCHA, and the request is blocked.

        If unspecified, defaults to Yes, I am human.

        Parameters:
        captchaSubmitLabel - the value to set
        Returns:
        this builder