com.amazonaws.services.wafv2.model

Class JsonBody

java.lang.Object

com.amazonaws.services.wafv2.model.JsonBody

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class JsonBody
extends Object
implements Serializable, Cloneable, StructuredPojo

Inspect the body of the web request as JSON. The body immediately follows the request headers.

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

Use the specifications in this object to indicate which parts of the JSON body to inspect using the rule's inspection criteria. WAF inspects only the parts of the JSON that result from the matches that you indicate.

Example JSON: "JsonBody": { "MatchPattern": { "All": {} }, "MatchScope": "ALL" }

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
JsonBody()

Method Summary

Modifier and Type	Method and Description
JsonBody	clone()
boolean	equals(Object obj)
String	getInvalidFallbackBehavior() What WAF should do if it fails to completely parse the JSON body.
JsonMatchPattern	getMatchPattern() The patterns to look for in the JSON body.
String	getMatchScope() The parts of the JSON to match against using the MatchPattern.
String	getOversizeHandling() What WAF should do if the body is larger than WAF can inspect.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setInvalidFallbackBehavior(String invalidFallbackBehavior) What WAF should do if it fails to completely parse the JSON body.
void	setMatchPattern(JsonMatchPattern matchPattern) The patterns to look for in the JSON body.
void	setMatchScope(String matchScope) The parts of the JSON to match against using the MatchPattern.
void	setOversizeHandling(String oversizeHandling) What WAF should do if the body is larger than WAF can inspect.
String	toString() Returns a string representation of this object.
JsonBody	withInvalidFallbackBehavior(BodyParsingFallbackBehavior invalidFallbackBehavior) What WAF should do if it fails to completely parse the JSON body.
JsonBody	withInvalidFallbackBehavior(String invalidFallbackBehavior) What WAF should do if it fails to completely parse the JSON body.
JsonBody	withMatchPattern(JsonMatchPattern matchPattern) The patterns to look for in the JSON body.
JsonBody	withMatchScope(JsonMatchScope matchScope) The parts of the JSON to match against using the MatchPattern.
JsonBody	withMatchScope(String matchScope) The parts of the JSON to match against using the MatchPattern.
JsonBody	withOversizeHandling(OversizeHandling oversizeHandling) What WAF should do if the body is larger than WAF can inspect.
JsonBody	withOversizeHandling(String oversizeHandling) What WAF should do if the body is larger than WAF can inspect.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JsonBody

public JsonBody()

Method Detail

setMatchPattern

public void setMatchPattern(JsonMatchPattern matchPattern)

The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

Parameters:

matchPattern - The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

getMatchPattern

public JsonMatchPattern getMatchPattern()

The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

Returns:

The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

withMatchPattern

public JsonBody withMatchPattern(JsonMatchPattern matchPattern)

The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

Parameters:

matchPattern - The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMatchScope

public void setMatchScope(String matchScope)

The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

Parameters:

matchScope - The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

See Also:

JsonMatchScope

getMatchScope

public String getMatchScope()

The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

Returns:

The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

See Also:

JsonMatchScope

withMatchScope

public JsonBody withMatchScope(String matchScope)

The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

Parameters:

matchScope - The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

JsonMatchScope

withMatchScope

public JsonBody withMatchScope(JsonMatchScope matchScope)

The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

Parameters:

matchScope - The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

JsonMatchScope

setInvalidFallbackBehavior

public void setInvalidFallbackBehavior(String invalidFallbackBehavior)

What WAF should do if it fails to completely parse the JSON body. The options are the following:

• EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

• MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

WAF parses the JSON in the following examples as two valid key, value pairs:

• Missing comma: {"key1":"value1""key2":"value2"}

• Missing colon: {"key1":"value1","key2""value2"}

• Extra colons: {"key1"::"value1","key2""value2"}

Parameters:

invalidFallbackBehavior - What WAF should do if it fails to completely parse the JSON body. The options are the following:

• EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

• MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

WAF parses the JSON in the following examples as two valid key, value pairs:

• Missing comma: {"key1":"value1""key2":"value2"}

• Missing colon: {"key1":"value1","key2""value2"}

• Extra colons: {"key1"::"value1","key2""value2"}

See Also:

BodyParsingFallbackBehavior

getInvalidFallbackBehavior

public String getInvalidFallbackBehavior()

What WAF should do if it fails to completely parse the JSON body. The options are the following:

• EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

• MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

WAF parses the JSON in the following examples as two valid key, value pairs:

• Missing comma: {"key1":"value1""key2":"value2"}

• Missing colon: {"key1":"value1","key2""value2"}

• Extra colons: {"key1"::"value1","key2""value2"}

Returns:

What WAF should do if it fails to completely parse the JSON body. The options are the following:

• EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

• MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

WAF parses the JSON in the following examples as two valid key, value pairs:

• Missing comma: {"key1":"value1""key2":"value2"}

• Missing colon: {"key1":"value1","key2""value2"}

• Extra colons: {"key1"::"value1","key2""value2"}

See Also:

BodyParsingFallbackBehavior

withInvalidFallbackBehavior

public JsonBody withInvalidFallbackBehavior(String invalidFallbackBehavior)

What WAF should do if it fails to completely parse the JSON body. The options are the following:

• EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

• MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

WAF parses the JSON in the following examples as two valid key, value pairs:

• Missing comma: {"key1":"value1""key2":"value2"}

• Missing colon: {"key1":"value1","key2""value2"}

• Extra colons: {"key1"::"value1","key2""value2"}

Parameters:

invalidFallbackBehavior - What WAF should do if it fails to completely parse the JSON body. The options are the following:

• EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

• MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

WAF parses the JSON in the following examples as two valid key, value pairs:

• Missing comma: {"key1":"value1""key2":"value2"}

• Missing colon: {"key1":"value1","key2""value2"}

• Extra colons: {"key1"::"value1","key2""value2"}

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BodyParsingFallbackBehavior

withInvalidFallbackBehavior

public JsonBody withInvalidFallbackBehavior(BodyParsingFallbackBehavior invalidFallbackBehavior)

What WAF should do if it fails to completely parse the JSON body. The options are the following:

• EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

• MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

WAF parses the JSON in the following examples as two valid key, value pairs:

• Missing comma: {"key1":"value1""key2":"value2"}

• Missing colon: {"key1":"value1","key2""value2"}

• Extra colons: {"key1"::"value1","key2""value2"}

Parameters:

invalidFallbackBehavior - What WAF should do if it fails to completely parse the JSON body. The options are the following:

• EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.

• MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.

WAF parses the JSON in the following examples as two valid key, value pairs:

• Missing comma: {"key1":"value1""key2":"value2"}

• Missing colon: {"key1":"value1","key2""value2"}

• Extra colons: {"key1"::"value1","key2""value2"}

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BodyParsingFallbackBehavior

setOversizeHandling

public void setOversizeHandling(String oversizeHandling)

What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

The options for oversize handling are the following:

• CONTINUE - Inspect the body normally, according to the rule inspection criteria.

• MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

Default: CONTINUE

Parameters:

oversizeHandling - What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

The options for oversize handling are the following:

• CONTINUE - Inspect the body normally, according to the rule inspection criteria.

• MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

Default: CONTINUE

See Also:

OversizeHandling

getOversizeHandling

public String getOversizeHandling()

What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

The options for oversize handling are the following:

• CONTINUE - Inspect the body normally, according to the rule inspection criteria.

• MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

Default: CONTINUE

Returns:

What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

The options for oversize handling are the following:

• CONTINUE - Inspect the body normally, according to the rule inspection criteria.

• MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

Default: CONTINUE

See Also:

OversizeHandling

withOversizeHandling

public JsonBody withOversizeHandling(String oversizeHandling)

What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

The options for oversize handling are the following:

• CONTINUE - Inspect the body normally, according to the rule inspection criteria.

• MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

Default: CONTINUE

Parameters:

oversizeHandling - What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

The options for oversize handling are the following:

• CONTINUE - Inspect the body normally, according to the rule inspection criteria.

• MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

Default: CONTINUE

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OversizeHandling

withOversizeHandling

public JsonBody withOversizeHandling(OversizeHandling oversizeHandling)

What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

The options for oversize handling are the following:

• CONTINUE - Inspect the body normally, according to the rule inspection criteria.

• MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

Default: CONTINUE

Parameters:

oversizeHandling - What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.

The options for oversize handling are the following:

• CONTINUE - Inspect the body normally, according to the rule inspection criteria.

• MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

Default: CONTINUE

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OversizeHandling

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public JsonBody clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.