com.oracle.bmc.waas.model

Class Captcha

java.lang.Object

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

com.oracle.bmc.waas.model.Captcha

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

The settings of the CAPTCHA challenge. If a specific URL should be accessed only by a human, a CAPTCHA challenge can be placed at the URL to protect the web application from bots.

Warning:* Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Note: Objects should always be created or deserialized using the Captcha.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 Captcha.Builder, which maintain a set of all explicitly set fields called Captcha.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	Captcha.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
Captcha(String url, Integer sessionExpirationInSeconds, String title, String headerText, String footerText, String failureMessage, String submitLabel) Deprecated.

Method Summary

Modifier and Type	Method and Description
static Captcha.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getFailureMessage() The text to show when incorrect CAPTCHA text is entered.
String	getFooterText() The text to show in the footer when showing a CAPTCHA challenge.
String	getHeaderText() The text to show in the header when showing a CAPTCHA challenge.
Integer	getSessionExpirationInSeconds() The amount of time before the CAPTCHA expires, in seconds.
String	getSubmitLabel() The text to show on the label of the CAPTCHA challenge submit button.
String	getTitle() The title used when displaying a CAPTCHA challenge.
String	getUrl() The unique URL path at which to show the CAPTCHA challenge.
int	hashCode()
Captcha.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

Captcha

@Deprecated
 @ConstructorProperties(value={"url","sessionExpirationInSeconds","title","headerText","footerText","failureMessage","submitLabel"})
public Captcha(String url,
                                                                                                                                                                Integer sessionExpirationInSeconds,
                                                                                                                                                                String title,
                                                                                                                                                                String headerText,
                                                                                                                                                                String footerText,
                                                                                                                                                                String failureMessage,
                                                                                                                                                                String submitLabel)

Deprecated.

Method Detail

builder

public static Captcha.Builder builder()

Create a new builder.

toBuilder

public Captcha.Builder toBuilder()

getUrl

public String getUrl()

The unique URL path at which to show the CAPTCHA challenge.

Returns:

the value

getSessionExpirationInSeconds

public Integer getSessionExpirationInSeconds()

The amount of time before the CAPTCHA expires, in seconds. If unspecified, defaults to 300.

Returns:

the value

getTitle

public String getTitle()

The title used when displaying a CAPTCHA challenge. If unspecified, defaults to Are you human?

Returns:

the value

getHeaderText

public String getHeaderText()

The text to show in the header when showing a CAPTCHA challenge. If unspecified, defaults to ‘We have detected an increased number of attempts to access this website. To help us keep this site secure, please let us know that you are not a robot by entering the text from the image below.’

Returns:

the value

getFooterText

public String getFooterText()

The text to show in the footer when showing a CAPTCHA challenge. If unspecified, defaults to ‘Enter the letters and numbers as they are shown in the image above.’

Returns:

the value

getFailureMessage

public String getFailureMessage()

The text to show when incorrect CAPTCHA text is entered. If unspecified, defaults to The CAPTCHA was incorrect. Try again.

Returns:

the value

getSubmitLabel

public String getSubmitLabel()

The text to show on the label of the CAPTCHA challenge submit button. 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