com.amazonaws.services.wafv2.model.SizeConstraintStatement Maven / Gradle / Ivy
/*
* 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;
/**
*
* A rule statement that compares a number of bytes against the size of a request component, using a comparison
* operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to
* look for query strings that are longer than 100 bytes.
*
*
* If you configure WAF to inspect the request body, WAF inspects only the number of bytes of the body up to the limit
* for the web ACL. By default, for regional web ACLs, this limit is 8 KB (8,192 kilobytes) and for CloudFront web ACLs,
* this limit is 16 KB (16,384 kilobytes). For CloudFront web ACLs, you can increase the limit in the web ACL
* AssociationConfig, for additional fees. If you know that the request body for your web requests should
* never exceed the inspection limit, you could use a size constraint statement to block requests that have a larger
* request body size.
*
*
* If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one
* character. For example, the URI /logo.jpg is nine characters long.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SizeConstraintStatement implements Serializable, Cloneable, StructuredPojo {
/**
*
* The part of the web request that you want WAF to inspect.
*
*/
private FieldToMatch fieldToMatch;
/**
*
* The operator to use to compare the request part to the size setting.
*
*/
private String comparisonOperator;
/**
*
* The size, in byte, to compare to the request part, after any transformations.
*
*/
private Long size;
/**
*
* 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, WAF performs all
* transformations on the content of the request component identified by FieldToMatch, starting from
* the lowest priority setting, before inspecting the content for a match.
*
*/
private java.util.List textTransformations;
/**
*
* The part of the web request that you want WAF to inspect.
*
*
* @param fieldToMatch
* The part of the web request that you want WAF to inspect.
*/
public void setFieldToMatch(FieldToMatch fieldToMatch) {
this.fieldToMatch = fieldToMatch;
}
/**
*
* The part of the web request that you want WAF to inspect.
*
*
* @return The part of the web request that you want WAF to inspect.
*/
public FieldToMatch getFieldToMatch() {
return this.fieldToMatch;
}
/**
*
* The part of the web request that you want WAF to inspect.
*
*
* @param fieldToMatch
* The part of the web request that you want WAF to inspect.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SizeConstraintStatement withFieldToMatch(FieldToMatch fieldToMatch) {
setFieldToMatch(fieldToMatch);
return this;
}
/**
*
* The operator to use to compare the request part to the size setting.
*
*
* @param comparisonOperator
* The operator to use to compare the request part to the size setting.
* @see ComparisonOperator
*/
public void setComparisonOperator(String comparisonOperator) {
this.comparisonOperator = comparisonOperator;
}
/**
*
* The operator to use to compare the request part to the size setting.
*
*
* @return The operator to use to compare the request part to the size setting.
* @see ComparisonOperator
*/
public String getComparisonOperator() {
return this.comparisonOperator;
}
/**
*
* The operator to use to compare the request part to the size setting.
*
*
* @param comparisonOperator
* The operator to use to compare the request part to the size setting.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ComparisonOperator
*/
public SizeConstraintStatement withComparisonOperator(String comparisonOperator) {
setComparisonOperator(comparisonOperator);
return this;
}
/**
*
* The operator to use to compare the request part to the size setting.
*
*
* @param comparisonOperator
* The operator to use to compare the request part to the size setting.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ComparisonOperator
*/
public SizeConstraintStatement withComparisonOperator(ComparisonOperator comparisonOperator) {
this.comparisonOperator = comparisonOperator.toString();
return this;
}
/**
*
* The size, in byte, to compare to the request part, after any transformations.
*
*
* @param size
* The size, in byte, to compare to the request part, after any transformations.
*/
public void setSize(Long size) {
this.size = size;
}
/**
*
* The size, in byte, to compare to the request part, after any transformations.
*
*
* @return The size, in byte, to compare to the request part, after any transformations.
*/
public Long getSize() {
return this.size;
}
/**
*
* The size, in byte, to compare to the request part, after any transformations.
*
*
* @param size
* The size, in byte, to compare to the request part, after any transformations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SizeConstraintStatement withSize(Long size) {
setSize(size);
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, WAF performs all
* transformations on the content of the request component 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, WAF performs
* all transformations on the content of the request component 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, WAF performs all
* transformations on the content of the request component 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, WAF performs
* all transformations on the content of the request component 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, WAF performs all
* transformations on the content of the request component 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, WAF performs
* all transformations on the content of the request component 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 SizeConstraintStatement 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, WAF performs all
* transformations on the content of the request component 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, WAF performs
* all transformations on the content of the request component 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 SizeConstraintStatement 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 (getComparisonOperator() != null)
sb.append("ComparisonOperator: ").append(getComparisonOperator()).append(",");
if (getSize() != null)
sb.append("Size: ").append(getSize()).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 SizeConstraintStatement == false)
return false;
SizeConstraintStatement other = (SizeConstraintStatement) obj;
if (other.getFieldToMatch() == null ^ this.getFieldToMatch() == null)
return false;
if (other.getFieldToMatch() != null && other.getFieldToMatch().equals(this.getFieldToMatch()) == false)
return false;
if (other.getComparisonOperator() == null ^ this.getComparisonOperator() == null)
return false;
if (other.getComparisonOperator() != null && other.getComparisonOperator().equals(this.getComparisonOperator()) == false)
return false;
if (other.getSize() == null ^ this.getSize() == null)
return false;
if (other.getSize() != null && other.getSize().equals(this.getSize()) == 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 + ((getComparisonOperator() == null) ? 0 : getComparisonOperator().hashCode());
hashCode = prime * hashCode + ((getSize() == null) ? 0 : getSize().hashCode());
hashCode = prime * hashCode + ((getTextTransformations() == null) ? 0 : getTextTransformations().hashCode());
return hashCode;
}
@Override
public SizeConstraintStatement clone() {
try {
return (SizeConstraintStatement) 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.SizeConstraintStatementMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}