com.oracle.bmc.waas.model

Class BlockChallengeSettings

java.lang.Object

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

com.oracle.bmc.waas.model.BlockChallengeSettings

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

The challenge settings if action is set to BLOCK.
Note: Objects should always be created or deserialized using the BlockChallengeSettings.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 BlockChallengeSettings.Builder, which maintain a set of all explicitly set fields called BlockChallengeSettings.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 and Description
static class	BlockChallengeSettings.BlockAction The method used to block requests that fail the challenge, if action is set to BLOCK.
static class	BlockChallengeSettings.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 and Description
BlockChallengeSettings(BlockChallengeSettings.BlockAction blockAction, Integer blockResponseCode, String blockErrorPageMessage, String blockErrorPageDescription, String blockErrorPageCode, String captchaTitle, String captchaHeader, String captchaFooter, String captchaSubmitLabel) Deprecated.

Method Summary

Modifier and Type	Method and Description
static BlockChallengeSettings.Builder	builder() Create a new builder.
boolean	equals(Object o)
BlockChallengeSettings.BlockAction	getBlockAction() The method used to block requests that fail the challenge, if action is set to BLOCK.
String	getBlockErrorPageCode() 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.
String	getBlockErrorPageDescription() 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.
String	getBlockErrorPageMessage() 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.
Integer	getBlockResponseCode() 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.
String	getCaptchaFooter() 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.
String	getCaptchaHeader() 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.
String	getCaptchaSubmitLabel() 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.
String	getCaptchaTitle() 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.
int	hashCode()
BlockChallengeSettings.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

BlockChallengeSettings

@Deprecated
 @ConstructorProperties(value={"blockAction","blockResponseCode","blockErrorPageMessage","blockErrorPageDescription","blockErrorPageCode","captchaTitle","captchaHeader","captchaFooter","captchaSubmitLabel"})
public BlockChallengeSettings(BlockChallengeSettings.BlockAction blockAction,
                                                                                                                                                                                                                                                          Integer blockResponseCode,
                                                                                                                                                                                                                                                          String blockErrorPageMessage,
                                                                                                                                                                                                                                                          String blockErrorPageDescription,
                                                                                                                                                                                                                                                          String blockErrorPageCode,
                                                                                                                                                                                                                                                          String captchaTitle,
                                                                                                                                                                                                                                                          String captchaHeader,
                                                                                                                                                                                                                                                          String captchaFooter,
                                                                                                                                                                                                                                                          String captchaSubmitLabel)

Deprecated.

Method Detail

builder

public static BlockChallengeSettings.Builder builder()

Create a new builder.

toBuilder

public BlockChallengeSettings.Builder toBuilder()

getBlockAction

public BlockChallengeSettings.BlockAction getBlockAction()

The method used to block requests that fail the challenge, if action is set to BLOCK. If unspecified, defaults to SHOW_ERROR_PAGE.

Returns:

the value

getBlockResponseCode

public Integer getBlockResponseCode()

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.

Returns:

the value

getBlockErrorPageMessage

public String getBlockErrorPageMessage()

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.

Returns:

the value

getBlockErrorPageDescription

public String getBlockErrorPageDescription()

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.

Returns:

the value

getBlockErrorPageCode

public String getBlockErrorPageCode()

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.

Returns:

the value

getCaptchaTitle

public String getCaptchaTitle()

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?

Returns:

the value

getCaptchaHeader

public String getCaptchaHeader()

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.

Returns:

the value

getCaptchaFooter

public String getCaptchaFooter()

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.

Returns:

the value

getCaptchaSubmitLabel

public String getCaptchaSubmitLabel()

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.

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