ALBWafConfig.Builder (Java SDK for NSX Global Policy API 4.1.0.2.0)

java.lang.Object
- com.vmware.nsx_global_policy.model.ALBWafConfig.Builder

Enclosing class:: ALBWafConfig

public static final class ALBWafConfig.Builder
extends java.lang.Object

Builder class for ALBWafConfig.

Constructor Summary

Constructors
Constructor and Description

Builder()
Constructor with parameters for the required properties of ALBWafConfig.

Constructors
Constructor and Description
`Builder()` Constructor with parameters for the required properties of `ALBWafConfig`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ALBWafConfig`	`build()`
`ALBWafConfig.Builder`	`setAllowedHttpVersions(java.util.List<java.lang.String> allowedHttpVersions)` Possible values are: `ALBWafConfig.ALLOWED_HTTP_VERSIONS_ZERO_NINE` `ALBWafConfig.ALLOWED_HTTP_VERSIONS_ONE_ZERO` `ALBWafConfig.ALLOWED_HTTP_VERSIONS_ONE_ONE` `ALBWafConfig.ALLOWED_HTTP_VERSIONS_TWO_ZERO` WAF allowed HTTP Versions.
`ALBWafConfig.Builder`	`setAllowedMethods(java.util.List<java.lang.String> allowedMethods)` Possible values are: `ALBWafConfig.ALLOWED_METHODS_GET` `ALBWafConfig.ALLOWED_METHODS_HEAD` `ALBWafConfig.ALLOWED_METHODS_PUT` `ALBWafConfig.ALLOWED_METHODS_DELETE` `ALBWafConfig.ALLOWED_METHODS_POST` `ALBWafConfig.ALLOWED_METHODS_OPTIONS` `ALBWafConfig.ALLOWED_METHODS_TRACE` `ALBWafConfig.ALLOWED_METHODS_CONNECT` `ALBWafConfig.ALLOWED_METHODS_PATCH` `ALBWafConfig.ALLOWED_METHODS_PROPFIND` `ALBWafConfig.ALLOWED_METHODS_PROPPATCH` `ALBWafConfig.ALLOWED_METHODS_MKCOL` `ALBWafConfig.ALLOWED_METHODS_COPY` `ALBWafConfig.ALLOWED_METHODS_MOVE` `ALBWafConfig.ALLOWED_METHODS_LOCK` `ALBWafConfig.ALLOWED_METHODS_UNLOCK` WAF allowed HTTP methods.
`ALBWafConfig.Builder`	`setAllowedRequestContentTypes(java.util.List<java.lang.String> allowedRequestContentTypes)` WAF allowed Content Types.
`ALBWafConfig.Builder`	`setArgumentSeparator(java.lang.String argumentSeparator)` Argument seperator.
`ALBWafConfig.Builder`	`setClientRequestMaxBodySize(java.lang.Long clientRequestMaxBodySize)` Maximum size for the client request body scanned by WAF.
`ALBWafConfig.Builder`	`setCookieFormatVersion(java.lang.Long cookieFormatVersion)` 0 For Netscape Cookies.
`ALBWafConfig.Builder`	`setIgnoreIncompleteRequestBodyError(java.lang.Boolean ignoreIncompleteRequestBodyError)` Ignore request body parsing errors due to partial scanning.
`ALBWafConfig.Builder`	`setMaxExecutionTime(java.lang.Long maxExecutionTime)` The maximum period of time WAF processing is allowed to take for a single request.
`ALBWafConfig.Builder`	`setRegexMatchLimit(java.lang.Long regexMatchLimit)` Limit CPU utilization for each regular expression match when processing rules.
`ALBWafConfig.Builder`	`setRegexRecursionLimit(java.lang.Long regexRecursionLimit)` Limit depth of recursion for each regular expression match when processing rules.
`ALBWafConfig.Builder`	`setRequestBodyDefaultAction(java.lang.String requestBodyDefaultAction)` WAF default action for Request Body Phase.
`ALBWafConfig.Builder`	`setRequestHdrDefaultAction(java.lang.String requestHdrDefaultAction)` WAF default action for Request Header Phase.
`ALBWafConfig.Builder`	`setResponseBodyDefaultAction(java.lang.String responseBodyDefaultAction)` WAF default action for Response Body Phase.
`ALBWafConfig.Builder`	`setResponseHdrDefaultAction(java.lang.String responseHdrDefaultAction)` WAF default action for Response Header Phase.
`ALBWafConfig.Builder`	`setRestrictedExtensions(java.util.List<java.lang.String> restrictedExtensions)` WAF Restricted File Extensions.
`ALBWafConfig.Builder`	`setRestrictedHeaders(java.util.List<java.lang.String> restrictedHeaders)` WAF Restricted HTTP Headers.
`ALBWafConfig.Builder`	`setServerResponseMaxBodySize(java.lang.Long serverResponseMaxBodySize)` Maximum size for response body scanned by WAF.
`ALBWafConfig.Builder`	`setStaticExtensions(java.util.List<java.lang.String> staticExtensions)` WAF Static File Extensions.
`ALBWafConfig.Builder`	`setStatusCodeForRejectedRequests(java.lang.String statusCodeForRejectedRequests)` Possible values are: `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_0` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_100` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_101` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_200` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_201` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_202` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_203` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_204` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_205` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_206` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_300` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_301` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_302` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_303` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_304` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_305` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_307` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_400` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_401` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_402` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_403` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_404` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_405` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_406` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_407` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_408` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_409` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_410` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_411` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_412` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_413` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_414` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_415` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_416` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_417` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_426` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_470` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_475` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_500` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_501` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_502` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_503` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_504` `ALBWafConfig.STATUS_CODE_FOR_REJECTED_REQUESTS_505` HTTP status code used by WAF Positive Security Model when rejecting a request.
`ALBWafConfig.Builder`	`setXmlXxeProtection(java.lang.Boolean xmlXxeProtection)` Block or flag XML requests referring to External Entities.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
    Constructor with parameters for the required properties of ALBWafConfig.
- Method Detail
  - setAllowedHttpVersions
```
public ALBWafConfig.Builder setAllowedHttpVersions(java.util.List<java.lang.String> allowedHttpVersions)
```
    Possible values are:
    WAF allowed HTTP Versions. Enum options - ZERO_NINE, ONE_ZERO, ONE_ONE, TWO_ZERO. Maximum of 8 items allowed.
    Parameters:
    
    allowedHttpVersions - New value for the property.
  - setAllowedMethods
```
public ALBWafConfig.Builder setAllowedMethods(java.util.List<java.lang.String> allowedMethods)
```
    Possible values are:
    WAF allowed HTTP methods. Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK.
    Parameters:
    
    allowedMethods - New value for the property.
  - setAllowedRequestContentTypes
```
public ALBWafConfig.Builder setAllowedRequestContentTypes(java.util.List<java.lang.String> allowedRequestContentTypes)
```
    WAF allowed Content Types. Maximum of 64 items allowed.
    
    Parameters:
    
    allowedRequestContentTypes - New value for the property.
  - setArgumentSeparator
```
public ALBWafConfig.Builder setArgumentSeparator(java.lang.String argumentSeparator)
```
    Argument seperator. Default value when not specified in API or module is interpreted by ALB Controller as &.
    
    Parameters:
    
    argumentSeparator - New value for the property.
  - setClientRequestMaxBodySize
```
public ALBWafConfig.Builder setClientRequestMaxBodySize(java.lang.Long clientRequestMaxBodySize)
```
    Maximum size for the client request body scanned by WAF. Allowed values are 1-32768. Unit is KB. Default value when not specified in API or module is interpreted by ALB Controller as 32. format: int64
    
    Parameters:
    
    clientRequestMaxBodySize - New value for the property.
  - setCookieFormatVersion
```
public ALBWafConfig.Builder setCookieFormatVersion(java.lang.Long cookieFormatVersion)
```
    0 For Netscape Cookies. 1 For version 1 cookies. Allowed values are 0-1. Default value when not specified in API or module is interpreted by ALB Controller as 0. format: int64
    
    Parameters:
    
    cookieFormatVersion - New value for the property.
  - setIgnoreIncompleteRequestBodyError
```
public ALBWafConfig.Builder setIgnoreIncompleteRequestBodyError(java.lang.Boolean ignoreIncompleteRequestBodyError)
```
    Ignore request body parsing errors due to partial scanning. Default value when not specified in API or module is interpreted by ALB Controller as true.
    
    Parameters:
    
    ignoreIncompleteRequestBodyError - New value for the property.
  - setMaxExecutionTime
```
public ALBWafConfig.Builder setMaxExecutionTime(java.lang.Long maxExecutionTime)
```
    The maximum period of time WAF processing is allowed to take for a single request. A value of 0 (zero) means no limit and should not be chosen in production deployments. It is only used for exceptional situations where crashes of se_dp processes are acceptable. The behavior of the system if this time is exceeded depends on two other configuration settings, the WAF policy mode and the WAF failure mode. In WAF policy mode 'Detection', the request is allowed and flagged for both failure mode 'Closed' and 'Open'. In enforcement node, 'Closed' means the request is rejected, 'Open' means the request is allowed and flagged. Irrespective of these settings, no subsequent WAF rules of this or other phases will be executed once the maximum execution time has been exceeded. Allowed values are 0-5000. Unit is MILLISECONDS. Default value when not specified in API or module is interpreted by ALB Controller as 50. format: int64
    
    Parameters:
    
    maxExecutionTime - New value for the property.
  - setRegexMatchLimit
```
public ALBWafConfig.Builder setRegexMatchLimit(java.lang.Long regexMatchLimit)
```
    Limit CPU utilization for each regular expression match when processing rules. Default value when not specified in API or module is interpreted by ALB Controller as 30000. format: int64
    
    Parameters:
    
    regexMatchLimit - New value for the property.
  - setRegexRecursionLimit
```
public ALBWafConfig.Builder setRegexRecursionLimit(java.lang.Long regexRecursionLimit)
```
    Limit depth of recursion for each regular expression match when processing rules. Default value when not specified in API or module is interpreted by ALB Controller as 10000. format: int64
    
    Parameters:
    
    regexRecursionLimit - New value for the property.
  - setRequestBodyDefaultAction
```
public ALBWafConfig.Builder setRequestBodyDefaultAction(java.lang.String requestBodyDefaultAction)
```
    WAF default action for Request Body Phase. Default value when not specified in API or module is interpreted by ALB Controller as phase:2,deny,status:403,log,auditlog.
    
    Parameters:
    
    requestBodyDefaultAction - New value for the property.
  - setRequestHdrDefaultAction
```
public ALBWafConfig.Builder setRequestHdrDefaultAction(java.lang.String requestHdrDefaultAction)
```
    WAF default action for Request Header Phase. Default value when not specified in API or module is interpreted by ALB Controller as phase:1,deny,status:403,log,auditlog.
    
    Parameters:
    
    requestHdrDefaultAction - New value for the property.
  - setResponseBodyDefaultAction
```
public ALBWafConfig.Builder setResponseBodyDefaultAction(java.lang.String responseBodyDefaultAction)
```
    WAF default action for Response Body Phase. Default value when not specified in API or module is interpreted by ALB Controller as phase:4,deny,status:403,log,auditlog.
    
    Parameters:
    
    responseBodyDefaultAction - New value for the property.
  - setResponseHdrDefaultAction
```
public ALBWafConfig.Builder setResponseHdrDefaultAction(java.lang.String responseHdrDefaultAction)
```
    WAF default action for Response Header Phase. Default value when not specified in API or module is interpreted by ALB Controller as phase:3,deny,status:403,log,auditlog.
    
    Parameters:
    
    responseHdrDefaultAction - New value for the property.
  - setRestrictedExtensions
```
public ALBWafConfig.Builder setRestrictedExtensions(java.util.List<java.lang.String> restrictedExtensions)
```
    WAF Restricted File Extensions. Maximum of 256 items allowed.
    
    Parameters:
    
    restrictedExtensions - New value for the property.
  - setRestrictedHeaders
```
public ALBWafConfig.Builder setRestrictedHeaders(java.util.List<java.lang.String> restrictedHeaders)
```
    WAF Restricted HTTP Headers. Maximum of 64 items allowed.
    
    Parameters:
    
    restrictedHeaders - New value for the property.
  - setServerResponseMaxBodySize
```
public ALBWafConfig.Builder setServerResponseMaxBodySize(java.lang.Long serverResponseMaxBodySize)
```
    Maximum size for response body scanned by WAF. Allowed values are 1-32768. Unit is KB. Default value when not specified in API or module is interpreted by ALB Controller as 128. format: int64
    
    Parameters:
    
    serverResponseMaxBodySize - New value for the property.
  - setStaticExtensions
```
public ALBWafConfig.Builder setStaticExtensions(java.util.List<java.lang.String> staticExtensions)
```
    WAF Static File Extensions. GET and HEAD requests with no query args and one of these extensions are allowed and not checked by the ruleset. Maximum of 64 items allowed.
    
    Parameters:
    
    staticExtensions - New value for the property.
  - setStatusCodeForRejectedRequests
```
public ALBWafConfig.Builder setStatusCodeForRejectedRequests(java.lang.String statusCodeForRejectedRequests)
```
    Possible values are:
    HTTP status code used by WAF Positive Security Model when rejecting a request. Enum options - HTTP_RESPONSE_CODE_0, HTTP_RESPONSE_CODE_100, HTTP_RESPONSE_CODE_101, HTTP_RESPONSE_CODE_200, HTTP_RESPONSE_CODE_201, HTTP_RESPONSE_CODE_202, HTTP_RESPONSE_CODE_203, HTTP_RESPONSE_CODE_204, HTTP_RESPONSE_CODE_205, HTTP_RESPONSE_CODE_206, HTTP_RESPONSE_CODE_300, HTTP_RESPONSE_CODE_301, HTTP_RESPONSE_CODE_302, HTTP_RESPONSE_CODE_303, HTTP_RESPONSE_CODE_304, HTTP_RESPONSE_CODE_305, HTTP_RESPONSE_CODE_307, HTTP_RESPONSE_CODE_400, HTTP_RESPONSE_CODE_401, HTTP_RESPONSE_CODE_402... Default value when not specified in API or module is interpreted by ALB Controller as HTTP_RESPONSE_CODE_403.
    Parameters:
    
    statusCodeForRejectedRequests - New value for the property.
  - setXmlXxeProtection
```
public ALBWafConfig.Builder setXmlXxeProtection(java.lang.Boolean xmlXxeProtection)
```
    Block or flag XML requests referring to External Entities. Default value when not specified in API or module is interpreted by ALB Controller as true.
    
    Parameters:
    
    xmlXxeProtection - New value for the property.
  - build
```
public ALBWafConfig build()
```

Class ALBWafConfig.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

setAllowedHttpVersions

setAllowedMethods

setAllowedRequestContentTypes

setArgumentSeparator

setClientRequestMaxBodySize

setCookieFormatVersion

setIgnoreIncompleteRequestBodyError

setMaxExecutionTime

setRegexMatchLimit

setRegexRecursionLimit

setRequestBodyDefaultAction

setRequestHdrDefaultAction

setResponseBodyDefaultAction

setResponseHdrDefaultAction

setRestrictedExtensions

setRestrictedHeaders

setServerResponseMaxBodySize

setStaticExtensions

setStatusCodeForRejectedRequests

setXmlXxeProtection

build