Package com.oracle.bmc.waas.model

Class WafConfig

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20181116")
public final class WafConfig
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The Web Application Firewall configuration for the WAAS policy.
    Note: Objects should always be created or deserialized using the WafConfig.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 WafConfig.Builder, which maintain a set of all explicitly set fields called WafConfig.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getAccessRules

        public List<AccessRule> getAccessRules()
        The access rules applied to the Web Application Firewall.

        Used for defining custom access policies with the combination of ALLOW, DETECT, and BLOCK rules, based on different criteria.

        Returns:
        the value

      • getAddressRateLimiting

        public AddressRateLimiting getAddressRateLimiting()
        The IP address rate limiting settings used to limit the number of requests from an address.
        Returns:
        the value

      • getCaptchas

        public List<Captcha> getCaptchas()
        A list of CAPTCHA challenge settings.

        These are used to challenge requests with a CAPTCHA to block bots.

        Returns:
        the value

      • getDeviceFingerprintChallenge

        public DeviceFingerprintChallenge getDeviceFingerprintChallenge()
        The device fingerprint challenge settings.

        Used to detect unique devices based on the device fingerprint information collected in order to block bots.

        Returns:
        the value

      • getGoodBots

        public List<GoodBot> getGoodBots()
        A list of bots allowed to access the web application.
        Returns:
        the value

      • getHumanInteractionChallenge

        public HumanInteractionChallenge getHumanInteractionChallenge()
        The human interaction challenge settings.

        Used to look for natural human interactions such as mouse movements, time on site, and page scrolling to identify bots.

        Returns:
        the value

      • getJsChallenge

        public JsChallenge getJsChallenge()
        The JavaScript challenge settings.

        Used to challenge requests with a JavaScript challenge and take the action if a browser has no JavaScript support in order to block bots.

        Returns:
        the value

      • getOrigin

        public String getOrigin()
        The key in the map of origins referencing the origin used for the Web Application Firewall.

        The origin must already be included in Origins. Required when creating the WafConfig resource, but not on update.

        Returns:
        the value

      • getCachingRules

        public List<CachingRule> getCachingRules()
        A list of caching rules applied to the web application.
        Returns:
        the value

      • getCustomProtectionRules

        public List<CustomProtectionRuleSetting> getCustomProtectionRules()
        A list of the custom protection rule OCIDs and their actions.
        Returns:
        the value

      • getOriginGroups

        public List<String> getOriginGroups()
        The map of origin groups and their keys used to associate origins to the wafConfig.

        Origin groups allow you to apply weights to groups of origins for load balancing purposes. Origins with higher weights will receive larger proportions of client requests. To add additional origins to your WAAS policy, update the origins field of a UpdateWaasPolicy request.

        Returns:
        the value

      • getProtectionRules

        public List<ProtectionRule> getProtectionRules()
        A list of the protection rules and their details.
        Returns:
        the value

      • getProtectionSettings

        public ProtectionSettings getProtectionSettings()
        The settings to apply to protection rules.
        Returns:
        the value

      • getThreatFeeds

        public List<ThreatFeed> getThreatFeeds()
        A list of threat intelligence feeds and the actions to apply to known malicious traffic based on internet intelligence.
        Returns:
        the value

      • getWhitelists

        public List<Whitelist> getWhitelists()
        A list of IP addresses that bypass the Web Application Firewall.
        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel