com.amazonaws.services.wafv2.model.XssMatchStatement Maven / Gradle / Ivy
Show all versions of aws-java-sdk-wafv2 Show documentation
/*
* Copyright 2014-2019 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;
/**
*
*
* This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including
* how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.
*
*
*
* A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS
* attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious
* client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests
* that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for
* character sequences that are likely to be malicious strings.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class XssMatchStatement implements Serializable, Cloneable, StructuredPojo {
/**
*
* The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.
*
*/
private FieldToMatch fieldToMatch;
/**
*
* Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to
* bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all
* transformations on the content identified by FieldToMatch, starting from the lowest priority
* setting, before inspecting the content for a match.
*
*/
private java.util.List textTransformations;
/**
*
* The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.
*
*
* @param fieldToMatch
* The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.
*/
public void setFieldToMatch(FieldToMatch fieldToMatch) {
this.fieldToMatch = fieldToMatch;
}
/**
*
* The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.
*
*
* @return The part of a web request that you want AWS WAF to inspect. For more information, see
* FieldToMatch.
*/
public FieldToMatch getFieldToMatch() {
return this.fieldToMatch;
}
/**
*
* The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.
*
*
* @param fieldToMatch
* The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public XssMatchStatement withFieldToMatch(FieldToMatch fieldToMatch) {
setFieldToMatch(fieldToMatch);
return this;
}
/**
*
* Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to
* bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all
* transformations on the content identified by FieldToMatch, starting from the lowest priority
* setting, before inspecting the content for a match.
*
*
* @return Text transformations eliminate some of the unusual formatting that attackers use in web requests in an
* effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF
* performs all transformations on the content identified by FieldToMatch, starting from the
* lowest priority setting, before inspecting the content for a match.
*/
public java.util.List getTextTransformations() {
return textTransformations;
}
/**
*
* Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to
* bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all
* transformations on the content identified by FieldToMatch, starting from the lowest priority
* setting, before inspecting the content for a match.
*
*
* @param textTransformations
* Text transformations eliminate some of the unusual formatting that attackers use in web requests in an
* effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF
* performs all transformations on the content identified by FieldToMatch, starting from the
* lowest priority setting, before inspecting the content for a match.
*/
public void setTextTransformations(java.util.Collection textTransformations) {
if (textTransformations == null) {
this.textTransformations = null;
return;
}
this.textTransformations = new java.util.ArrayList(textTransformations);
}
/**
*
* Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to
* bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all
* transformations on the content identified by FieldToMatch, starting from the lowest priority
* setting, before inspecting the content for a match.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTextTransformations(java.util.Collection)} or {@link #withTextTransformations(java.util.Collection)}
* if you want to override the existing values.
*
*
* @param textTransformations
* Text transformations eliminate some of the unusual formatting that attackers use in web requests in an
* effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF
* performs all transformations on the content identified by FieldToMatch, starting from the
* lowest priority setting, before inspecting the content for a match.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public XssMatchStatement withTextTransformations(TextTransformation... textTransformations) {
if (this.textTransformations == null) {
setTextTransformations(new java.util.ArrayList(textTransformations.length));
}
for (TextTransformation ele : textTransformations) {
this.textTransformations.add(ele);
}
return this;
}
/**
*
* Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to
* bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all
* transformations on the content identified by FieldToMatch, starting from the lowest priority
* setting, before inspecting the content for a match.
*
*
* @param textTransformations
* Text transformations eliminate some of the unusual formatting that attackers use in web requests in an
* effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF
* performs all transformations on the content identified by FieldToMatch, starting from the
* lowest priority setting, before inspecting the content for a match.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public XssMatchStatement withTextTransformations(java.util.Collection textTransformations) {
setTextTransformations(textTransformations);
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 (getFieldToMatch() != null)
sb.append("FieldToMatch: ").append(getFieldToMatch()).append(",");
if (getTextTransformations() != null)
sb.append("TextTransformations: ").append(getTextTransformations());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof XssMatchStatement == false)
return false;
XssMatchStatement other = (XssMatchStatement) obj;
if (other.getFieldToMatch() == null ^ this.getFieldToMatch() == null)
return false;
if (other.getFieldToMatch() != null && other.getFieldToMatch().equals(this.getFieldToMatch()) == false)
return false;
if (other.getTextTransformations() == null ^ this.getTextTransformations() == null)
return false;
if (other.getTextTransformations() != null && other.getTextTransformations().equals(this.getTextTransformations()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFieldToMatch() == null) ? 0 : getFieldToMatch().hashCode());
hashCode = prime * hashCode + ((getTextTransformations() == null) ? 0 : getTextTransformations().hashCode());
return hashCode;
}
@Override
public XssMatchStatement clone() {
try {
return (XssMatchStatement) 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.XssMatchStatementMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}