com.oracle.bmc.waas.model.AccessRuleCriteria Maven / Gradle / Ivy
Show all versions of oci-java-sdk-shaded-full Show documentation
/**
* Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved.
* This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
*/
package com.oracle.bmc.waas.model;
/**
* When defined, the parent challenge would be applied only for the requests that matched all the
* listed conditions.
* Note: Objects should always be created or deserialized using the {@link Builder}. This model
* distinguishes fields that are {@code null} because they are unset from fields that are explicitly
* set to {@code null}. This is done in the setter methods of the {@link Builder}, which maintain a
* set of all explicitly set fields called {@link Builder#__explicitlySet__}. The {@link
* #hashCode()} and {@link #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 {@code null} from unset {@code
* null}).
*/
@jakarta.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20181116")
@com.fasterxml.jackson.databind.annotation.JsonDeserialize(
builder = AccessRuleCriteria.Builder.class)
@com.fasterxml.jackson.annotation.JsonFilter(
com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel.EXPLICITLY_SET_FILTER_NAME)
public final class AccessRuleCriteria
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel {
@Deprecated
@java.beans.ConstructorProperties({"condition", "value", "isCaseSensitive"})
public AccessRuleCriteria(Condition condition, String value, Boolean isCaseSensitive) {
super();
this.condition = condition;
this.value = value;
this.isCaseSensitive = isCaseSensitive;
}
@com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder(withPrefix = "")
public static class Builder {
/**
* The criteria the access rule and JavaScript Challenge uses to determine if action should
* be taken on a request. - **URL_IS:** Matches if the concatenation of request URL path and
* query is identical to the contents of the {@code value} field. URL must start with a
* {@code /}. - **URL_IS_NOT:** Matches if the concatenation of request URL path and query
* is not identical to the contents of the {@code value} field. URL must start with a {@code
* /}. - **URL_STARTS_WITH:** Matches if the concatenation of request URL path and query
* starts with the contents of the {@code value} field. URL must start with a {@code /}. -
* **URL_PART_ENDS_WITH:** Matches if the concatenation of request URL path and query ends
* with the contents of the {@code value} field. - **URL_PART_CONTAINS:** Matches if the
* concatenation of request URL path and query contains the contents of the {@code value}
* field. - **URL_REGEX:** Matches if the concatenation of request URL path and query is
* described by the regular expression in the value field. The value must be a valid regular
* expression recognized by the PCRE library in Nginx (https://www.pcre.org). -
* **URL_DOES_NOT_MATCH_REGEX:** Matches if the concatenation of request URL path and query
* is not described by the regular expression in the {@code value} field. The value must be
* a valid regular expression recognized by the PCRE library in Nginx
* (https://www.pcre.org). - **URL_DOES_NOT_START_WITH:** Matches if the concatenation of
* request URL path and query does not start with the contents of the {@code value} field. -
* **URL_PART_DOES_NOT_CONTAIN:** Matches if the concatenation of request URL path and query
* does not contain the contents of the {@code value} field. -
* **URL_PART_DOES_NOT_END_WITH:** Matches if the concatenation of request URL path and
* query does not end with the contents of the {@code value} field. - **IP_IS:** Matches if
* the request originates from one of the IP addresses contained in the defined address
* list. The {@code value} in this case is string with one or multiple IPs or CIDR notations
* separated by new line symbol \
*
* Example:* "1.1.1.1\ 1.1.1.2\ 1.2.2.1/30" - **IP_IS_NOT:** Matches if the request does
* not originate from any of the IP addresses contained in the defined address list. The
* {@code value} in this case is string with one or multiple IPs or CIDR notations separated
* by new line symbol \
*
*
Example:* "1.1.1.1\ 1.1.1.2\ 1.2.2.1/30" - **IP_IN_LIST:** Matches if the request
* originates from one of the IP addresses contained in the referenced address list. The
* {@code value} in this case is OCID of the address list. - **IP_NOT_IN_LIST:** Matches if
* the request does not originate from any IP address contained in the referenced address
* list. The {@code value} field in this case is OCID of the address list. -
* **HTTP_HEADER_CONTAINS:** The HTTP_HEADER_CONTAINS criteria is defined using a compound
* value separated by a colon: a header field name and a header field value. {@code
* host:test.example.com} is an example of a criteria value where {@code host} is the header
* field name and {@code test.example.com} is the header field value. A request matches when
* the header field name is a case insensitive match and the header field value is a case
* insensitive, substring match. *Example:* With a criteria value of {@code
* host:test.example.com}, where {@code host} is the name of the field and {@code
* test.example.com} is the value of the host field, a request with the header values,
* {@code Host: www.test.example.com} will match, where as a request with header values of
* {@code host: www.example.com} or {@code host: test.sub.example.com} will not match. -
* **HTTP_METHOD_IS:** Matches if the request method is identical to one of the values
* listed in field. The {@code value} in this case is string with one or multiple HTTP
* methods separated by new line symbol \ The list of available methods: {@code GET}, {@code
* HEAD}, {@code POST}, {@code PUT}, {@code DELETE}, {@code CONNECT}, {@code OPTIONS},
* {@code TRACE}, {@code PATCH}
*
*
Example:* "GET\ POST"
*
*
- **HTTP_METHOD_IS_NOT:** Matches if the request is not identical to any of the
* contents of the {@code value} field. The {@code value} in this case is string with one or
* multiple HTTP methods separated by new line symbol \ The list of available methods:
* {@code GET}, {@code HEAD}, {@code POST}, {@code PUT}, {@code DELETE}, {@code CONNECT},
* {@code OPTIONS}, {@code TRACE}, {@code PATCH}
*
*
Example:* "GET\ POST"
*
*
- **COUNTRY_IS:** Matches if the request originates from one of countries in the
* {@code value} field. The {@code value} in this case is string with one or multiple
* countries separated by new line symbol \ Country codes are in ISO 3166-1 alpha-2 format.
* For a list of codes, see [ISO's website](https://www.iso.org/obp/ui/#search/code/).
* *Example:* "AL\ DZ\ AM" - **COUNTRY_IS_NOT:** Matches if the request does not originate
* from any of countries in the {@code value} field. The {@code value} in this case is
* string with one or multiple countries separated by new line symbol \ Country codes are in
* ISO 3166-1 alpha-2 format. For a list of codes, see [ISO's
* website](https://www.iso.org/obp/ui/#search/code/). *Example:* "AL\ DZ\ AM" -
* **USER_AGENT_IS:** Matches if the requesting user agent is identical to the contents of
* the {@code value} field. *Example:* {@code Mozilla/5.0 (X11; Ubuntu; Linux x86_64;
* rv:35.0) Gecko/20100101 Firefox/35.0} - **USER_AGENT_IS_NOT:** Matches if the requesting
* user agent is not identical to the contents of the {@code value} field. *Example:* {@code
* Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:35.0) Gecko/20100101 Firefox/35.0}
*/
@com.fasterxml.jackson.annotation.JsonProperty("condition")
private Condition condition;
/**
* The criteria the access rule and JavaScript Challenge uses to determine if action should
* be taken on a request. - **URL_IS:** Matches if the concatenation of request URL path and
* query is identical to the contents of the {@code value} field. URL must start with a
* {@code /}. - **URL_IS_NOT:** Matches if the concatenation of request URL path and query
* is not identical to the contents of the {@code value} field. URL must start with a {@code
* /}. - **URL_STARTS_WITH:** Matches if the concatenation of request URL path and query
* starts with the contents of the {@code value} field. URL must start with a {@code /}. -
* **URL_PART_ENDS_WITH:** Matches if the concatenation of request URL path and query ends
* with the contents of the {@code value} field. - **URL_PART_CONTAINS:** Matches if the
* concatenation of request URL path and query contains the contents of the {@code value}
* field. - **URL_REGEX:** Matches if the concatenation of request URL path and query is
* described by the regular expression in the value field. The value must be a valid regular
* expression recognized by the PCRE library in Nginx (https://www.pcre.org). -
* **URL_DOES_NOT_MATCH_REGEX:** Matches if the concatenation of request URL path and query
* is not described by the regular expression in the {@code value} field. The value must be
* a valid regular expression recognized by the PCRE library in Nginx
* (https://www.pcre.org). - **URL_DOES_NOT_START_WITH:** Matches if the concatenation of
* request URL path and query does not start with the contents of the {@code value} field. -
* **URL_PART_DOES_NOT_CONTAIN:** Matches if the concatenation of request URL path and query
* does not contain the contents of the {@code value} field. -
* **URL_PART_DOES_NOT_END_WITH:** Matches if the concatenation of request URL path and
* query does not end with the contents of the {@code value} field. - **IP_IS:** Matches if
* the request originates from one of the IP addresses contained in the defined address
* list. The {@code value} in this case is string with one or multiple IPs or CIDR notations
* separated by new line symbol \
*
*
Example:* "1.1.1.1\ 1.1.1.2\ 1.2.2.1/30" - **IP_IS_NOT:** Matches if the request does
* not originate from any of the IP addresses contained in the defined address list. The
* {@code value} in this case is string with one or multiple IPs or CIDR notations separated
* by new line symbol \
*
*
Example:* "1.1.1.1\ 1.1.1.2\ 1.2.2.1/30" - **IP_IN_LIST:** Matches if the request
* originates from one of the IP addresses contained in the referenced address list. The
* {@code value} in this case is OCID of the address list. - **IP_NOT_IN_LIST:** Matches if
* the request does not originate from any IP address contained in the referenced address
* list. The {@code value} field in this case is OCID of the address list. -
* **HTTP_HEADER_CONTAINS:** The HTTP_HEADER_CONTAINS criteria is defined using a compound
* value separated by a colon: a header field name and a header field value. {@code
* host:test.example.com} is an example of a criteria value where {@code host} is the header
* field name and {@code test.example.com} is the header field value. A request matches when
* the header field name is a case insensitive match and the header field value is a case
* insensitive, substring match. *Example:* With a criteria value of {@code
* host:test.example.com}, where {@code host} is the name of the field and {@code
* test.example.com} is the value of the host field, a request with the header values,
* {@code Host: www.test.example.com} will match, where as a request with header values of
* {@code host: www.example.com} or {@code host: test.sub.example.com} will not match. -
* **HTTP_METHOD_IS:** Matches if the request method is identical to one of the values
* listed in field. The {@code value} in this case is string with one or multiple HTTP
* methods separated by new line symbol \ The list of available methods: {@code GET}, {@code
* HEAD}, {@code POST}, {@code PUT}, {@code DELETE}, {@code CONNECT}, {@code OPTIONS},
* {@code TRACE}, {@code PATCH}
*
*
Example:* "GET\ POST"
*
*
- **HTTP_METHOD_IS_NOT:** Matches if the request is not identical to any of the
* contents of the {@code value} field. The {@code value} in this case is string with one or
* multiple HTTP methods separated by new line symbol \ The list of available methods:
* {@code GET}, {@code HEAD}, {@code POST}, {@code PUT}, {@code DELETE}, {@code CONNECT},
* {@code OPTIONS}, {@code TRACE}, {@code PATCH}
*
*
Example:* "GET\ POST"
*
*
- **COUNTRY_IS:** Matches if the request originates from one of countries in the
* {@code value} field. The {@code value} in this case is string with one or multiple
* countries separated by new line symbol \ Country codes are in ISO 3166-1 alpha-2 format.
* For a list of codes, see [ISO's website](https://www.iso.org/obp/ui/#search/code/).
* *Example:* "AL\ DZ\ AM" - **COUNTRY_IS_NOT:** Matches if the request does not originate
* from any of countries in the {@code value} field. The {@code value} in this case is
* string with one or multiple countries separated by new line symbol \ Country codes are in
* ISO 3166-1 alpha-2 format. For a list of codes, see [ISO's
* website](https://www.iso.org/obp/ui/#search/code/). *Example:* "AL\ DZ\ AM" -
* **USER_AGENT_IS:** Matches if the requesting user agent is identical to the contents of
* the {@code value} field. *Example:* {@code Mozilla/5.0 (X11; Ubuntu; Linux x86_64;
* rv:35.0) Gecko/20100101 Firefox/35.0} - **USER_AGENT_IS_NOT:** Matches if the requesting
* user agent is not identical to the contents of the {@code value} field. *Example:* {@code
* Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:35.0) Gecko/20100101 Firefox/35.0}
*
* @param condition the value to set
* @return this builder
*/
public Builder condition(Condition condition) {
this.condition = condition;
this.__explicitlySet__.add("condition");
return this;
}
/** The criteria value. */
@com.fasterxml.jackson.annotation.JsonProperty("value")
private String value;
/**
* The criteria value.
*
* @param value the value to set
* @return this builder
*/
public Builder value(String value) {
this.value = value;
this.__explicitlySet__.add("value");
return this;
}
/** When enabled, the condition will be matched with case-sensitive rules. */
@com.fasterxml.jackson.annotation.JsonProperty("isCaseSensitive")
private Boolean isCaseSensitive;
/**
* When enabled, the condition will be matched with case-sensitive rules.
*
* @param isCaseSensitive the value to set
* @return this builder
*/
public Builder isCaseSensitive(Boolean isCaseSensitive) {
this.isCaseSensitive = isCaseSensitive;
this.__explicitlySet__.add("isCaseSensitive");
return this;
}
@com.fasterxml.jackson.annotation.JsonIgnore
private final java.util.Set __explicitlySet__ = new java.util.HashSet();
public AccessRuleCriteria build() {
AccessRuleCriteria model =
new AccessRuleCriteria(this.condition, this.value, this.isCaseSensitive);
for (String explicitlySetProperty : this.__explicitlySet__) {
model.markPropertyAsExplicitlySet(explicitlySetProperty);
}
return model;
}
@com.fasterxml.jackson.annotation.JsonIgnore
public Builder copy(AccessRuleCriteria model) {
if (model.wasPropertyExplicitlySet("condition")) {
this.condition(model.getCondition());
}
if (model.wasPropertyExplicitlySet("value")) {
this.value(model.getValue());
}
if (model.wasPropertyExplicitlySet("isCaseSensitive")) {
this.isCaseSensitive(model.getIsCaseSensitive());
}
return this;
}
}
/** Create a new builder. */
public static Builder builder() {
return new Builder();
}
public Builder toBuilder() {
return new Builder().copy(this);
}
/**
* The criteria the access rule and JavaScript Challenge uses to determine if action should be
* taken on a request. - **URL_IS:** Matches if the concatenation of request URL path and query
* is identical to the contents of the {@code value} field. URL must start with a {@code /}. -
* **URL_IS_NOT:** Matches if the concatenation of request URL path and query is not identical
* to the contents of the {@code value} field. URL must start with a {@code /}. -
* **URL_STARTS_WITH:** Matches if the concatenation of request URL path and query starts with
* the contents of the {@code value} field. URL must start with a {@code /}. -
* **URL_PART_ENDS_WITH:** Matches if the concatenation of request URL path and query ends with
* the contents of the {@code value} field. - **URL_PART_CONTAINS:** Matches if the
* concatenation of request URL path and query contains the contents of the {@code value} field.
* - **URL_REGEX:** Matches if the concatenation of request URL path and query is described by
* the regular expression in the value field. The value must be a valid regular expression
* recognized by the PCRE library in Nginx (https://www.pcre.org). -
* **URL_DOES_NOT_MATCH_REGEX:** Matches if the concatenation of request URL path and query is
* not described by the regular expression in the {@code value} field. The value must be a valid
* regular expression recognized by the PCRE library in Nginx (https://www.pcre.org). -
* **URL_DOES_NOT_START_WITH:** Matches if the concatenation of request URL path and query does
* not start with the contents of the {@code value} field. - **URL_PART_DOES_NOT_CONTAIN:**
* Matches if the concatenation of request URL path and query does not contain the contents of
* the {@code value} field. - **URL_PART_DOES_NOT_END_WITH:** Matches if the concatenation of
* request URL path and query does not end with the contents of the {@code value} field. -
* **IP_IS:** Matches if the request originates from one of the IP addresses contained in the
* defined address list. The {@code value} in this case is string with one or multiple IPs or
* CIDR notations separated by new line symbol \
*
* Example:* "1.1.1.1\ 1.1.1.2\ 1.2.2.1/30" - **IP_IS_NOT:** Matches if the request does not
* originate from any of the IP addresses contained in the defined address list. The {@code
* value} in this case is string with one or multiple IPs or CIDR notations separated by new
* line symbol \
*
*
Example:* "1.1.1.1\ 1.1.1.2\ 1.2.2.1/30" - **IP_IN_LIST:** Matches if the request
* originates from one of the IP addresses contained in the referenced address list. The {@code
* value} in this case is OCID of the address list. - **IP_NOT_IN_LIST:** Matches if the request
* does not originate from any IP address contained in the referenced address list. The {@code
* value} field in this case is OCID of the address list. - **HTTP_HEADER_CONTAINS:** The
* HTTP_HEADER_CONTAINS criteria is defined using a compound value separated by a colon: a
* header field name and a header field value. {@code host:test.example.com} is an example of a
* criteria value where {@code host} is the header field name and {@code test.example.com} is
* the header field value. A request matches when the header field name is a case insensitive
* match and the header field value is a case insensitive, substring match. *Example:* With a
* criteria value of {@code host:test.example.com}, where {@code host} is the name of the field
* and {@code test.example.com} is the value of the host field, a request with the header
* values, {@code Host: www.test.example.com} will match, where as a request with header values
* of {@code host: www.example.com} or {@code host: test.sub.example.com} will not match. -
* **HTTP_METHOD_IS:** Matches if the request method is identical to one of the values listed in
* field. The {@code value} in this case is string with one or multiple HTTP methods separated
* by new line symbol \ The list of available methods: {@code GET}, {@code HEAD}, {@code POST},
* {@code PUT}, {@code DELETE}, {@code CONNECT}, {@code OPTIONS}, {@code TRACE}, {@code PATCH}
*
*
Example:* "GET\ POST"
*
*
- **HTTP_METHOD_IS_NOT:** Matches if the request is not identical to any of the contents
* of the {@code value} field. The {@code value} in this case is string with one or multiple
* HTTP methods separated by new line symbol \ The list of available methods: {@code GET},
* {@code HEAD}, {@code POST}, {@code PUT}, {@code DELETE}, {@code CONNECT}, {@code OPTIONS},
* {@code TRACE}, {@code PATCH}
*
*
Example:* "GET\ POST"
*
*
- **COUNTRY_IS:** Matches if the request originates from one of countries in the {@code
* value} field. The {@code value} in this case is string with one or multiple countries
* separated by new line symbol \ Country codes are in ISO 3166-1 alpha-2 format. For a list of
* codes, see [ISO's website](https://www.iso.org/obp/ui/#search/code/). *Example:* "AL\ DZ\ AM"
* - **COUNTRY_IS_NOT:** Matches if the request does not originate from any of countries in the
* {@code value} field. The {@code value} in this case is string with one or multiple countries
* separated by new line symbol \ Country codes are in ISO 3166-1 alpha-2 format. For a list of
* codes, see [ISO's website](https://www.iso.org/obp/ui/#search/code/). *Example:* "AL\ DZ\ AM"
* - **USER_AGENT_IS:** Matches if the requesting user agent is identical to the contents of the
* {@code value} field. *Example:* {@code Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:35.0)
* Gecko/20100101 Firefox/35.0} - **USER_AGENT_IS_NOT:** Matches if the requesting user agent is
* not identical to the contents of the {@code value} field. *Example:* {@code Mozilla/5.0 (X11;
* Ubuntu; Linux x86_64; rv:35.0) Gecko/20100101 Firefox/35.0}
*/
public enum Condition implements com.oracle.bmc.http.internal.BmcEnum {
UrlIs("URL_IS"),
UrlIsNot("URL_IS_NOT"),
UrlStartsWith("URL_STARTS_WITH"),
UrlPartEndsWith("URL_PART_ENDS_WITH"),
UrlPartContains("URL_PART_CONTAINS"),
UrlRegex("URL_REGEX"),
UrlDoesNotMatchRegex("URL_DOES_NOT_MATCH_REGEX"),
UrlDoesNotStartWith("URL_DOES_NOT_START_WITH"),
UrlPartDoesNotContain("URL_PART_DOES_NOT_CONTAIN"),
UrlPartDoesNotEndWith("URL_PART_DOES_NOT_END_WITH"),
IpIs("IP_IS"),
IpIsNot("IP_IS_NOT"),
IpInList("IP_IN_LIST"),
IpNotInList("IP_NOT_IN_LIST"),
HttpHeaderContains("HTTP_HEADER_CONTAINS"),
HttpMethodIs("HTTP_METHOD_IS"),
HttpMethodIsNot("HTTP_METHOD_IS_NOT"),
CountryIs("COUNTRY_IS"),
CountryIsNot("COUNTRY_IS_NOT"),
UserAgentIs("USER_AGENT_IS"),
UserAgentIsNot("USER_AGENT_IS_NOT"),
/**
* This value is used if a service returns a value for this enum that is not recognized by
* this version of the SDK.
*/
UnknownEnumValue(null);
private static final org.slf4j.Logger LOG =
org.slf4j.LoggerFactory.getLogger(Condition.class);
private final String value;
private static java.util.Map map;
static {
map = new java.util.HashMap<>();
for (Condition v : Condition.values()) {
if (v != UnknownEnumValue) {
map.put(v.getValue(), v);
}
}
}
Condition(String value) {
this.value = value;
}
@com.fasterxml.jackson.annotation.JsonValue
public String getValue() {
return value;
}
@com.fasterxml.jackson.annotation.JsonCreator
public static Condition create(String key) {
if (map.containsKey(key)) {
return map.get(key);
}
LOG.warn(
"Received unknown value '{}' for enum 'Condition', returning UnknownEnumValue",
key);
return UnknownEnumValue;
}
};
/**
* The criteria the access rule and JavaScript Challenge uses to determine if action should be
* taken on a request. - **URL_IS:** Matches if the concatenation of request URL path and query
* is identical to the contents of the {@code value} field. URL must start with a {@code /}. -
* **URL_IS_NOT:** Matches if the concatenation of request URL path and query is not identical
* to the contents of the {@code value} field. URL must start with a {@code /}. -
* **URL_STARTS_WITH:** Matches if the concatenation of request URL path and query starts with
* the contents of the {@code value} field. URL must start with a {@code /}. -
* **URL_PART_ENDS_WITH:** Matches if the concatenation of request URL path and query ends with
* the contents of the {@code value} field. - **URL_PART_CONTAINS:** Matches if the
* concatenation of request URL path and query contains the contents of the {@code value} field.
* - **URL_REGEX:** Matches if the concatenation of request URL path and query is described by
* the regular expression in the value field. The value must be a valid regular expression
* recognized by the PCRE library in Nginx (https://www.pcre.org). -
* **URL_DOES_NOT_MATCH_REGEX:** Matches if the concatenation of request URL path and query is
* not described by the regular expression in the {@code value} field. The value must be a valid
* regular expression recognized by the PCRE library in Nginx (https://www.pcre.org). -
* **URL_DOES_NOT_START_WITH:** Matches if the concatenation of request URL path and query does
* not start with the contents of the {@code value} field. - **URL_PART_DOES_NOT_CONTAIN:**
* Matches if the concatenation of request URL path and query does not contain the contents of
* the {@code value} field. - **URL_PART_DOES_NOT_END_WITH:** Matches if the concatenation of
* request URL path and query does not end with the contents of the {@code value} field. -
* **IP_IS:** Matches if the request originates from one of the IP addresses contained in the
* defined address list. The {@code value} in this case is string with one or multiple IPs or
* CIDR notations separated by new line symbol \
*
* Example:* "1.1.1.1\ 1.1.1.2\ 1.2.2.1/30" - **IP_IS_NOT:** Matches if the request does not
* originate from any of the IP addresses contained in the defined address list. The {@code
* value} in this case is string with one or multiple IPs or CIDR notations separated by new
* line symbol \
*
*
Example:* "1.1.1.1\ 1.1.1.2\ 1.2.2.1/30" - **IP_IN_LIST:** Matches if the request
* originates from one of the IP addresses contained in the referenced address list. The {@code
* value} in this case is OCID of the address list. - **IP_NOT_IN_LIST:** Matches if the request
* does not originate from any IP address contained in the referenced address list. The {@code
* value} field in this case is OCID of the address list. - **HTTP_HEADER_CONTAINS:** The
* HTTP_HEADER_CONTAINS criteria is defined using a compound value separated by a colon: a
* header field name and a header field value. {@code host:test.example.com} is an example of a
* criteria value where {@code host} is the header field name and {@code test.example.com} is
* the header field value. A request matches when the header field name is a case insensitive
* match and the header field value is a case insensitive, substring match. *Example:* With a
* criteria value of {@code host:test.example.com}, where {@code host} is the name of the field
* and {@code test.example.com} is the value of the host field, a request with the header
* values, {@code Host: www.test.example.com} will match, where as a request with header values
* of {@code host: www.example.com} or {@code host: test.sub.example.com} will not match. -
* **HTTP_METHOD_IS:** Matches if the request method is identical to one of the values listed in
* field. The {@code value} in this case is string with one or multiple HTTP methods separated
* by new line symbol \ The list of available methods: {@code GET}, {@code HEAD}, {@code POST},
* {@code PUT}, {@code DELETE}, {@code CONNECT}, {@code OPTIONS}, {@code TRACE}, {@code PATCH}
*
*
Example:* "GET\ POST"
*
*
- **HTTP_METHOD_IS_NOT:** Matches if the request is not identical to any of the contents
* of the {@code value} field. The {@code value} in this case is string with one or multiple
* HTTP methods separated by new line symbol \ The list of available methods: {@code GET},
* {@code HEAD}, {@code POST}, {@code PUT}, {@code DELETE}, {@code CONNECT}, {@code OPTIONS},
* {@code TRACE}, {@code PATCH}
*
*
Example:* "GET\ POST"
*
*
- **COUNTRY_IS:** Matches if the request originates from one of countries in the {@code
* value} field. The {@code value} in this case is string with one or multiple countries
* separated by new line symbol \ Country codes are in ISO 3166-1 alpha-2 format. For a list of
* codes, see [ISO's website](https://www.iso.org/obp/ui/#search/code/). *Example:* "AL\ DZ\ AM"
* - **COUNTRY_IS_NOT:** Matches if the request does not originate from any of countries in the
* {@code value} field. The {@code value} in this case is string with one or multiple countries
* separated by new line symbol \ Country codes are in ISO 3166-1 alpha-2 format. For a list of
* codes, see [ISO's website](https://www.iso.org/obp/ui/#search/code/). *Example:* "AL\ DZ\ AM"
* - **USER_AGENT_IS:** Matches if the requesting user agent is identical to the contents of the
* {@code value} field. *Example:* {@code Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:35.0)
* Gecko/20100101 Firefox/35.0} - **USER_AGENT_IS_NOT:** Matches if the requesting user agent is
* not identical to the contents of the {@code value} field. *Example:* {@code Mozilla/5.0 (X11;
* Ubuntu; Linux x86_64; rv:35.0) Gecko/20100101 Firefox/35.0}
*/
@com.fasterxml.jackson.annotation.JsonProperty("condition")
private final Condition condition;
/**
* The criteria the access rule and JavaScript Challenge uses to determine if action should be
* taken on a request. - **URL_IS:** Matches if the concatenation of request URL path and query
* is identical to the contents of the {@code value} field. URL must start with a {@code /}. -
* **URL_IS_NOT:** Matches if the concatenation of request URL path and query is not identical
* to the contents of the {@code value} field. URL must start with a {@code /}. -
* **URL_STARTS_WITH:** Matches if the concatenation of request URL path and query starts with
* the contents of the {@code value} field. URL must start with a {@code /}. -
* **URL_PART_ENDS_WITH:** Matches if the concatenation of request URL path and query ends with
* the contents of the {@code value} field. - **URL_PART_CONTAINS:** Matches if the
* concatenation of request URL path and query contains the contents of the {@code value} field.
* - **URL_REGEX:** Matches if the concatenation of request URL path and query is described by
* the regular expression in the value field. The value must be a valid regular expression
* recognized by the PCRE library in Nginx (https://www.pcre.org). -
* **URL_DOES_NOT_MATCH_REGEX:** Matches if the concatenation of request URL path and query is
* not described by the regular expression in the {@code value} field. The value must be a valid
* regular expression recognized by the PCRE library in Nginx (https://www.pcre.org). -
* **URL_DOES_NOT_START_WITH:** Matches if the concatenation of request URL path and query does
* not start with the contents of the {@code value} field. - **URL_PART_DOES_NOT_CONTAIN:**
* Matches if the concatenation of request URL path and query does not contain the contents of
* the {@code value} field. - **URL_PART_DOES_NOT_END_WITH:** Matches if the concatenation of
* request URL path and query does not end with the contents of the {@code value} field. -
* **IP_IS:** Matches if the request originates from one of the IP addresses contained in the
* defined address list. The {@code value} in this case is string with one or multiple IPs or
* CIDR notations separated by new line symbol \
*
*
Example:* "1.1.1.1\ 1.1.1.2\ 1.2.2.1/30" - **IP_IS_NOT:** Matches if the request does not
* originate from any of the IP addresses contained in the defined address list. The {@code
* value} in this case is string with one or multiple IPs or CIDR notations separated by new
* line symbol \
*
*
Example:* "1.1.1.1\ 1.1.1.2\ 1.2.2.1/30" - **IP_IN_LIST:** Matches if the request
* originates from one of the IP addresses contained in the referenced address list. The {@code
* value} in this case is OCID of the address list. - **IP_NOT_IN_LIST:** Matches if the request
* does not originate from any IP address contained in the referenced address list. The {@code
* value} field in this case is OCID of the address list. - **HTTP_HEADER_CONTAINS:** The
* HTTP_HEADER_CONTAINS criteria is defined using a compound value separated by a colon: a
* header field name and a header field value. {@code host:test.example.com} is an example of a
* criteria value where {@code host} is the header field name and {@code test.example.com} is
* the header field value. A request matches when the header field name is a case insensitive
* match and the header field value is a case insensitive, substring match. *Example:* With a
* criteria value of {@code host:test.example.com}, where {@code host} is the name of the field
* and {@code test.example.com} is the value of the host field, a request with the header
* values, {@code Host: www.test.example.com} will match, where as a request with header values
* of {@code host: www.example.com} or {@code host: test.sub.example.com} will not match. -
* **HTTP_METHOD_IS:** Matches if the request method is identical to one of the values listed in
* field. The {@code value} in this case is string with one or multiple HTTP methods separated
* by new line symbol \ The list of available methods: {@code GET}, {@code HEAD}, {@code POST},
* {@code PUT}, {@code DELETE}, {@code CONNECT}, {@code OPTIONS}, {@code TRACE}, {@code PATCH}
*
*
Example:* "GET\ POST"
*
*
- **HTTP_METHOD_IS_NOT:** Matches if the request is not identical to any of the contents
* of the {@code value} field. The {@code value} in this case is string with one or multiple
* HTTP methods separated by new line symbol \ The list of available methods: {@code GET},
* {@code HEAD}, {@code POST}, {@code PUT}, {@code DELETE}, {@code CONNECT}, {@code OPTIONS},
* {@code TRACE}, {@code PATCH}
*
*
Example:* "GET\ POST"
*
*
- **COUNTRY_IS:** Matches if the request originates from one of countries in the {@code
* value} field. The {@code value} in this case is string with one or multiple countries
* separated by new line symbol \ Country codes are in ISO 3166-1 alpha-2 format. For a list of
* codes, see [ISO's website](https://www.iso.org/obp/ui/#search/code/). *Example:* "AL\ DZ\ AM"
* - **COUNTRY_IS_NOT:** Matches if the request does not originate from any of countries in the
* {@code value} field. The {@code value} in this case is string with one or multiple countries
* separated by new line symbol \ Country codes are in ISO 3166-1 alpha-2 format. For a list of
* codes, see [ISO's website](https://www.iso.org/obp/ui/#search/code/). *Example:* "AL\ DZ\ AM"
* - **USER_AGENT_IS:** Matches if the requesting user agent is identical to the contents of the
* {@code value} field. *Example:* {@code Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:35.0)
* Gecko/20100101 Firefox/35.0} - **USER_AGENT_IS_NOT:** Matches if the requesting user agent is
* not identical to the contents of the {@code value} field. *Example:* {@code Mozilla/5.0 (X11;
* Ubuntu; Linux x86_64; rv:35.0) Gecko/20100101 Firefox/35.0}
*
* @return the value
*/
public Condition getCondition() {
return condition;
}
/** The criteria value. */
@com.fasterxml.jackson.annotation.JsonProperty("value")
private final String value;
/**
* The criteria value.
*
* @return the value
*/
public String getValue() {
return value;
}
/** When enabled, the condition will be matched with case-sensitive rules. */
@com.fasterxml.jackson.annotation.JsonProperty("isCaseSensitive")
private final Boolean isCaseSensitive;
/**
* When enabled, the condition will be matched with case-sensitive rules.
*
* @return the value
*/
public Boolean getIsCaseSensitive() {
return isCaseSensitive;
}
@Override
public String toString() {
return this.toString(true);
}
/**
* Return a string representation of the object.
*
* @param includeByteArrayContents true to include the full contents of byte arrays
* @return string representation
*/
public String toString(boolean includeByteArrayContents) {
java.lang.StringBuilder sb = new java.lang.StringBuilder();
sb.append("AccessRuleCriteria(");
sb.append("super=").append(super.toString());
sb.append("condition=").append(String.valueOf(this.condition));
sb.append(", value=").append(String.valueOf(this.value));
sb.append(", isCaseSensitive=").append(String.valueOf(this.isCaseSensitive));
sb.append(")");
return sb.toString();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof AccessRuleCriteria)) {
return false;
}
AccessRuleCriteria other = (AccessRuleCriteria) o;
return java.util.Objects.equals(this.condition, other.condition)
&& java.util.Objects.equals(this.value, other.value)
&& java.util.Objects.equals(this.isCaseSensitive, other.isCaseSensitive)
&& super.equals(other);
}
@Override
public int hashCode() {
final int PRIME = 59;
int result = 1;
result = (result * PRIME) + (this.condition == null ? 43 : this.condition.hashCode());
result = (result * PRIME) + (this.value == null ? 43 : this.value.hashCode());
result =
(result * PRIME)
+ (this.isCaseSensitive == null ? 43 : this.isCaseSensitive.hashCode());
result = (result * PRIME) + super.hashCode();
return result;
}
}