Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ExtendHttpResponseHeaderValueRule

An object that represents the action of modifying a response header value. This rule applies only to HTTP listeners.

This rule adds a prefix, a suffix, or both to the header value.

*NOTES:**

This rule requires a value for a prefix, suffix, or both.

The system does not support this rule for headers with multiple values.

The system does not distinquish between underscore and dash characters in headers. That is, it treats {@code example_header_name} and {@code example-header-name} as identical. If two such headers appear in a request, the system applies the action to the first header it finds. The affected header cannot be determined in advance. Oracle recommends that you do not rely on underscore or dash characters to uniquely distinguish header names.

Properties

Const action

action: string = "EXTEND_HTTP_RESPONSE_HEADER_VALUE"

header

header: string

A header name that conforms to RFC 7230.

Example: {@code example_header_name}

Optional prefix

prefix: undefined | string

A string to prepend to the header value. The resulting header value must still conform to RFC 7230. With the following exceptions:

  • value cannot contain {@code $}
  • value cannot contain patterns like {@code {variable_name}}. They are reserved for future extensions. Currently, such values are invalid.

    Example: {@code example_prefix_value}

Optional suffix

suffix: undefined | string

A string to append to the header value. The resulting header value must still conform to RFC 7230. With the following exceptions:

  • value cannot contain {@code $}
  • value cannot contain patterns like {@code {variable_name}}. They are reserved for future extensions. Currently, such values are invalid.

    Example: {@code example_suffix_value}

Methods

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Rule): object

getJsonObj

  • getJsonObj(obj: Rule): object