/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.wafv2.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

* Specifies that WAF should run a CAPTCHA check against the request: *

*
* If the request includes a valid, unexpired CAPTCHA token, WAF applies any custom request handling and * labels that you've configured and then allows the web request inspection to proceed to the next rule, similar to a * CountAction. *
*
*
* If the request doesn't include a valid, unexpired token, WAF discontinues the web ACL evaluation of the request and * blocks it from going to its intended destination. *
*
* WAF generates a response that it sends back to the client, which includes the following: *
*
- *
  * The header x-amzn-waf-action with a value of captcha. *
  *
- *
  * The HTTP status code 405 Method Not Allowed. *
  *
- *
  * If the request contains an Accept header with a value of text/html, the response includes a * CAPTCHA JavaScript page interstitial. *
  *
*

* You can configure the expiration time in the CaptchaConfig ImmunityTimeProperty setting at * the rule and web ACL level. The rule setting overrides the web ACL setting. *

* This action option is available for rules. It isn't available for web ACL default actions. *

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CaptchaAction implements Serializable, Cloneable, StructuredPojo { /** *

* Defines custom handling for the web request, used when the CAPTCHA inspection determines that the * request's token is valid and unexpired. *

* For information about customizing web requests and responses, see Customizing web * requests and responses in WAF in the WAF Developer Guide. *

*/ private CustomRequestHandling customRequestHandling; /** *

* Defines custom handling for the web request, used when the CAPTCHA inspection determines that the * request's token is valid and unexpired. *

* For information about customizing web requests and responses, see Customizing web * requests and responses in WAF in the WAF Developer Guide. *

* * @param customRequestHandling * Defines custom handling for the web request, used when the CAPTCHA inspection determines that * the request's token is valid and unexpired.

* For information about customizing web requests and responses, see Customizing * web requests and responses in WAF in the WAF Developer Guide. */ public void setCustomRequestHandling(CustomRequestHandling customRequestHandling) { this.customRequestHandling = customRequestHandling; } /** *

* Defines custom handling for the web request, used when the CAPTCHA inspection determines that the * request's token is valid and unexpired. *

* For information about customizing web requests and responses, see Customizing web * requests and responses in WAF in the WAF Developer Guide. *

* * @return Defines custom handling for the web request, used when the CAPTCHA inspection determines * that the request's token is valid and unexpired.

* For information about customizing web requests and responses, see Customizing * web requests and responses in WAF in the WAF Developer Guide. */ public CustomRequestHandling getCustomRequestHandling() { return this.customRequestHandling; } /** *

* Defines custom handling for the web request, used when the CAPTCHA inspection determines that the * request's token is valid and unexpired. *

* For information about customizing web requests and responses, see Customizing web * requests and responses in WAF in the WAF Developer Guide. *

* * @param customRequestHandling * Defines custom handling for the web request, used when the CAPTCHA inspection determines that * the request's token is valid and unexpired.

* For information about customizing web requests and responses, see Customizing * web requests and responses in WAF in the WAF Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public CaptchaAction withCustomRequestHandling(CustomRequestHandling customRequestHandling) { setCustomRequestHandling(customRequestHandling); return this; } /** * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be * redacted from this string using a placeholder value. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getCustomRequestHandling() != null) sb.append("CustomRequestHandling: ").append(getCustomRequestHandling()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CaptchaAction == false) return false; CaptchaAction other = (CaptchaAction) obj; if (other.getCustomRequestHandling() == null ^ this.getCustomRequestHandling() == null) return false; if (other.getCustomRequestHandling() != null && other.getCustomRequestHandling().equals(this.getCustomRequestHandling()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getCustomRequestHandling() == null) ? 0 : getCustomRequestHandling().hashCode()); return hashCode; } @Override public CaptchaAction clone() { try { return (CaptchaAction) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.wafv2.model.transform.CaptchaActionMarshaller.getInstance().marshall(this, protocolMarshaller); } }