@Generated(value="OracleSDKGenerator", comments="API Version: 20181116") public final class WafLog extends Object
A list of Web Application Firewall log entries. Each entry is a JSON object whose fields vary based on log type. Logs record what rules and countermeasures are triggered by requests and are used as a basis to move request handling into block mode.
Note: Objects should always be created or deserialized using the WafLog.Builder
. This model distinguishes fields that are null
because they are unset from fields that are explicitly set to null
. This is done in the setter methods of the WafLog.Builder
, which maintain a set of all explicitly set fields called __explicitlySet__
. The hashCode()
and equals(Object)
methods are implemented to take __explicitlySet__
into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null
from unset null
).
Modifier and Type | Class and Description |
---|---|
static class |
WafLog.Builder |
Constructor and Description |
---|
WafLog(String action,
String captchaAction,
String captchaExpected,
String captchaReceived,
String captchaFailCount,
String clientAddress,
String countryName,
String userAgent,
String domain,
Map<String,String> protectionRuleDetections,
String httpMethod,
String requestUrl,
Map<String,String> httpHeaders,
String referrer,
Integer responseCode,
Integer responseSize,
String incidentKey,
String fingerprint,
String device,
String countryCode,
Map<String,String> requestHeaders,
String threatFeedKey,
String accessRuleKey,
String addressRateLimitingKey,
String timestamp,
String logType,
String originAddress,
String originResponseTime)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static WafLog.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
String |
getAccessRuleKey()
The
AccessRule key that matched the request. |
String |
getAction()
The action taken on the request.
|
String |
getAddressRateLimitingKey()
The
AddressRateLimiting key that matched the request. |
String |
getCaptchaAction()
The CAPTCHA action taken on the request.
|
String |
getCaptchaExpected()
The CAPTCHA challenge answer that was expected.
|
String |
getCaptchaFailCount()
The number of times the CAPTCHA challenge was failed.
|
String |
getCaptchaReceived()
The CAPTCHA challenge answer that was received.
|
String |
getClientAddress()
The IPv4 address of the requesting client.
|
String |
getCountryCode()
The ISO 3166-1 country code of the request.
|
String |
getCountryName()
The name of the country where the request was made.
|
String |
getDevice()
The type of device that the request was made from.
|
String |
getDomain()
The domain where the request was sent.
|
String |
getFingerprint()
TODO: what is this? MD5 hash of the request? SHA1?
|
Map<String,String> |
getHttpHeaders()
The map of header names to values of the request sent to the origin.
|
String |
getHttpMethod()
The HTTP method of the request.
|
String |
getIncidentKey()
The incident key that matched the request.
|
String |
getLogType()
The type of log of the request.
|
String |
getOriginAddress()
The address of the origin server where the request was sent.
|
String |
getOriginResponseTime()
The amount of time it took the origin server to respond to the request.
|
Map<String,String> |
getProtectionRuleDetections()
A map of protection rule keys to detection message details.
|
String |
getReferrer()
The
Referrer header value of the request. |
Map<String,String> |
getRequestHeaders()
A map of header names to values of the original request.
|
String |
getRequestUrl()
The path and query string of the request.
|
Integer |
getResponseCode()
The status code of the response.
|
Integer |
getResponseSize()
The size in bytes of the response.
|
String |
getThreatFeedKey()
The
ThreatFeed key that matched the request. |
String |
getTimestamp()
The
Date header value of the request. |
String |
getUserAgent()
The
User-Agent header value of the request. |
int |
hashCode() |
String |
toString() |
@ConstructorProperties(value={"action","captchaAction","captchaExpected","captchaReceived","captchaFailCount","clientAddress","countryName","userAgent","domain","protectionRuleDetections","httpMethod","requestUrl","httpHeaders","referrer","responseCode","responseSize","incidentKey","fingerprint","device","countryCode","requestHeaders","threatFeedKey","accessRuleKey","addressRateLimitingKey","timestamp","logType","originAddress","originResponseTime"}) @Deprecated public WafLog(String action, String captchaAction, String captchaExpected, String captchaReceived, String captchaFailCount, String clientAddress, String countryName, String userAgent, String domain, Map<String,String> protectionRuleDetections, String httpMethod, String requestUrl, Map<String,String> httpHeaders, String referrer, Integer responseCode, Integer responseSize, String incidentKey, String fingerprint, String device, String countryCode, Map<String,String> requestHeaders, String threatFeedKey, String accessRuleKey, String addressRateLimitingKey, String timestamp, String logType, String originAddress, String originResponseTime)
public static WafLog.Builder builder()
Create a new builder.
public String getAction()
The action taken on the request.
public String getCaptchaAction()
The CAPTCHA action taken on the request.
public String getCaptchaExpected()
The CAPTCHA challenge answer that was expected.
public String getCaptchaReceived()
The CAPTCHA challenge answer that was received.
public String getCaptchaFailCount()
The number of times the CAPTCHA challenge was failed.
public String getClientAddress()
The IPv4 address of the requesting client.
public String getCountryName()
The name of the country where the request was made.
public String getUserAgent()
The User-Agent
header value of the request.
public String getDomain()
The domain where the request was sent.
public Map<String,String> getProtectionRuleDetections()
A map of protection rule keys to detection message details.
public String getHttpMethod()
The HTTP method of the request.
public String getRequestUrl()
The path and query string of the request.
public Map<String,String> getHttpHeaders()
The map of header names to values of the request sent to the origin.
public String getReferrer()
The Referrer
header value of the request.
public Integer getResponseCode()
The status code of the response.
public Integer getResponseSize()
The size in bytes of the response.
public String getIncidentKey()
The incident key that matched the request.
public String getFingerprint()
TODO: what is this? MD5 hash of the request? SHA1?
public String getDevice()
The type of device that the request was made from.
public String getCountryCode()
The ISO 3166-1 country code of the request.
public Map<String,String> getRequestHeaders()
A map of header names to values of the original request.
public String getThreatFeedKey()
The ThreatFeed
key that matched the request.
public String getAccessRuleKey()
The AccessRule
key that matched the request.
public String getAddressRateLimitingKey()
The AddressRateLimiting
key that matched the request.
public String getTimestamp()
The Date
header value of the request.
public String getLogType()
The type of log of the request.
public String getOriginAddress()
The address of the origin server where the request was sent.
public String getOriginResponseTime()
The amount of time it took the origin server to respond to the request. TODO: determine unit of time and example
Copyright © 2016–2019. All rights reserved.