@Generated(value="OracleSDKGenerator", comments="API Version: 20181116") public final class AccessRuleCriteria extends Object
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 AccessRuleCriteria.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 AccessRuleCriteria.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 |
AccessRuleCriteria.Builder |
static class |
AccessRuleCriteria.Condition
The criteria the access rule and JavaScript Challenge uses to determine if action should be taken on a request.
|
Constructor and Description |
---|
AccessRuleCriteria(AccessRuleCriteria.Condition condition,
String value,
Boolean isCaseSensitive)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static AccessRuleCriteria.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
AccessRuleCriteria.Condition |
getCondition()
The criteria the access rule and JavaScript Challenge uses to determine if action should be taken on a request.
|
Boolean |
getIsCaseSensitive()
When enabled, the condition will be matched with case-sensitive rules.
|
String |
getValue()
The criteria value.
|
int |
hashCode() |
AccessRuleCriteria.Builder |
toBuilder() |
String |
toString() |
@ConstructorProperties(value={"condition","value","isCaseSensitive"}) @Deprecated public AccessRuleCriteria(AccessRuleCriteria.Condition condition, String value, Boolean isCaseSensitive)
public static AccessRuleCriteria.Builder builder()
Create a new builder.
public AccessRuleCriteria.Builder toBuilder()
public AccessRuleCriteria.Condition getCondition()
The criteria the access rule and JavaScript Challenge uses to determine if action should be taken on a request.
value
field. URL must start with a /
.value
field. URL must start with a /
.value
field. URL must start with a /
.value
field.value
field.value
field. The value must be a valid regular expression recognized by the PCRE library in Nginx (https://www.pcre.org).value
field.value
field.value
field.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 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 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 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. host:test.example.com
is an example of a criteria value where host
is the header field name and 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 host:test.example.com
, where host
is the name of the field and test.example.com
is the value of the host field, a request with the header values, Host: www.test.example.com
will match, where as a request with header values of host: www.example.com
or 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 value
in this case is string with one or multiple HTTP methods separated by new line symbol \
The list of available methods: GET
, HEAD
, POST
, PUT
, DELETE
, CONNECT
, OPTIONS
, TRACE
, PATCH
Example:* "GET\ POST"
- **HTTP_METHOD_IS_NOT:** Matches if the request is not identical to any of the contents of the value
field. The value
in this case is string with one or multiple HTTP methods separated by new line symbol \
The list of available methods: GET
, HEAD
, POST
, PUT
, DELETE
, CONNECT
, OPTIONS
, TRACE
, PATCH
Example:* "GET\ POST"
- **COUNTRY_IS:** Matches if the request originates from one of countries in the value
field. The 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 value
field. The 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 value
field.
*Example:* 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 value
field.
*Example:* Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:35.0) Gecko/20100101 Firefox/35.0
public String getValue()
The criteria value.
public Boolean getIsCaseSensitive()
When enabled, the condition will be matched with case-sensitive rules.
Copyright © 2016–2022. All rights reserved.