* Specifies that WAF should run a Challenge check against the request to verify that the request is coming
* from a legitimate client session:
*
* If the request includes a valid, unexpired challenge 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 challenge token, WAF discontinues the web ACL evaluation of the * request and blocks it from going to its intended destination. *
** WAF then generates a challenge response that it sends back to the client, which includes the following: *
*
* The header x-amzn-waf-action with a value of challenge.
*
* The HTTP status code 202 Request Accepted.
*
* If the request contains an Accept header with a value of text/html, the response includes a
* JavaScript page interstitial with a challenge script.
*
* Challenges run silent browser interrogations in the background, and don't generally affect the end user experience. *
** A challenge enforces token acquisition using an interstitial JavaScript challenge that inspects the client session * for legitimate behavior. The challenge blocks bots or at least increases the cost of operating sophisticated bots. *
** After the client session successfully responds to the challenge, it receives a new token from WAF, which the * challenge script uses to resubmit the original request. *
*
* You can configure the expiration time in the ChallengeConfig 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 ChallengeAction implements Serializable, Cloneable, StructuredPojo { /** ** Defines custom handling for the web request, used when the challenge 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 challenge 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 challenge 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 challenge 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 challenge 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 challenge 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 challenge 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 ChallengeAction 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 ChallengeAction == false) return false; ChallengeAction other = (ChallengeAction) 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 ChallengeAction clone() { try { return (ChallengeAction) 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.ChallengeActionMarshaller.getInstance().marshall(this, protocolMarshaller); } }