PingAuthorize Server Documentation Index
Configuration Reference Home

Gateway HTTP Servlet Extension

The Gateway HTTP Servlet Extension forwards client API requests to downstream JSON-based REST API servers, enforcing business rules by applying policies to the requests and responses.

The Gateway HTTP Servlet Extension is a reverse HTTP proxy that acts as a centralized policy enforcement point (PEP) for an organization's REST APIs. To configure API request proxying, define one or more Gateway API Endpoints.

Parent Component
Relations from This Component
Properties
dsconfig Usage

Parent Component

The Gateway HTTP Servlet Extension component inherits from the HTTP Servlet Extension

Relations from This Component

The following components have a direct aggregation relation from Gateway HTTP Servlet Extensions:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ cross-origin-policy
↓ response-header
↓ excluded-api-endpoint
↓ request-limit
↓ response-limit
↓ num-forward-threads

Basic Properties

description

Description
A description for this HTTP Servlet Extension
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

cross-origin-policy

Description
The cross-origin request policy to use for the HTTP Servlet Extension. A cross-origin policy is a group of attributes defining the level of cross-origin request supported by the HTTP Servlet Extension.
Default Value
No cross-origin policy is defined and no CORS headers are recognized or returned.
Allowed Values
The DN of any HTTP Servlet Cross Origin Policy.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

response-header

Description
Specifies HTTP header fields and values added to response headers for all requests. Values specified here must specify both the header field name and the value in conformance with RFC 2616. Fields may only be specified once; multiple values for the same header should be comma-separated. See RFC 7231 for a standard set of field names.
Any response headers configured for this HTTP Servlet Extension will be combined with response headers configured on the corresponding Connection Handler. In the case of duplicates, the headers configured on this HTTP Servlet Extension will be used instead of the headers configured on the Connection Handler.
Default Value
None
Allowed Values
Colon-separated header field name and value
Multi-Valued
Yes
Required
No
Admin Action Required
HTTP Connection Handlers hosting this HTTP Servlet Extension must be disabled and then re-enabled, or the server restarted, in order for this change to take effect.

excluded-api-endpoint

Description
Specifies any Gateway API Endpoints that will not be handled by the Gateway HTTP Servlet Extension.
Default Value
All configured Gateway API Endpoints are handled by the Gateway HTTP Servlet Extension.
Allowed Values
The DN of any Gateway API Endpoint.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

request-limit

Description
The maximum number of bytes allowed per request body. The server will return the status 413 Request Entity Too Large if a request exceeds the configured limit.
Default Value
No size limit will be enforced on requests.
Allowed Values
A positive integer representing a size. Lower limit is 1.
Multi-Valued
No
Required
No
Admin Action Required
The Gateway HTTP Servlet Extension must be disabled and re-enabled for changes to this setting to take effect. In order for this modification to take effect, the component must be restarted, either by disabling and re-enabling it, or by restarting the server

response-limit

Description
The maximum number of bytes allowed per response body. The server will return the status 502 Bad Gateway if a response exceeds the configured limit.
Default Value
No size limit will be enforced on responses.
Allowed Values
A positive integer representing a size. Lower limit is 1.
Multi-Valued
No
Required
No
Admin Action Required
The Gateway HTTP Servlet Extension must be disabled and re-enabled for changes to this setting to take effect. In order for this modification to take effect, the component must be restarted, either by disabling and re-enabling it, or by restarting the server

num-forward-threads

Description
The number of threads used to forward responses to the API backend.
Default Value
The number of threads will be calculated from the available CPU cores.
Allowed Values
An integer value. Lower limit is 0.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured HTTP Servlet Extensions:

dsconfig list-http-servlet-extensions
     [--property {propertyName}] ...

To view the configuration for an existing HTTP Servlet Extension:

dsconfig get-http-servlet-extension-prop
     --extension-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing HTTP Servlet Extension:

dsconfig set-http-servlet-extension-prop
     --extension-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Gateway HTTP Servlet Extension:

dsconfig create-http-servlet-extension
     --extension-name {name}
     --type gateway
     [--set {propertyName}:{propertyValue}] ...

To delete an existing HTTP Servlet Extension:

dsconfig delete-http-servlet-extension
     --extension-name {name}