The top-level General settings screen in Policy Studio enables you to set global configuration settings to optimize the behavior of the API Gateway for your environment.
To configure the General settings, in the Policy Studio main menu, select Tasks > Manage Gateway Settings > General. Alternatively, in the Policy Studio tree, select the Server Settings node, and click General. To confirm updates to these settings, click Apply changes at the bottom right of the screen.
After changing any settings, you must deploy to the API Gateway for the changes to be enforced. You can do this in the Policy Studio main menu by selecting Server > Deploy. Alternatively, click the Deploy button in the toolbar, or press F6.
You can configure the following settings in the Default Settings screen:
Setting | Description | |||
---|---|---|---|---|
Trace level |
Enables you to set the trace level for the API Gateway at
runtime. Select the appropriate option from the Trace
Level drop-down list. Defaults to INFO .
|
|||
Active timeout |
When the API Gateway receives a large HTTP request, it reads the
request off the network when it becomes available. If the time
between reading successive blocks of data exceeds the Active
Timeout specified in milliseconds, the API Gateway closes
the connection. This guards against a host closing the connection
in the middle of sending data.
For example, if the host's network connection is pulled out of the
machine while in the middle of sending data to the API Gateway. When
the API Gateway has read all the available data off the network, it
waits the Active Timeout period before closing the
connection. Defaults to You can configure this setting on a per-host basis using the Remote Hosts interface. For more details, see the API Gateway User Guide. |
|||
Date format |
Configures the format of the date for the purposes of tracing, logging, and
reporting. Defaults to MM.dd.yyyy HH:mm:ss,SSS . For more information,
see http://docs.oracle.com/javase/6/docs/api/java/
|
|||
Cache refresh interval |
Configures the number of seconds that the server caches data loaded
from an external source (external database, LDAP directory, and so on)
before refreshing the data from that source. The default value is
5 seconds. If you do not wish any caching to occur,
set this value to 0 .
|
|||
Idle timeout |
The API Gateway supports HTTP 1.1 persistent connections. The Idle
Timeout specified in milliseconds is the time that the API Gateway
waits after sending a message over a persistent connection before it closes
the connection.
Typically, the host tells the API Gateway that it wants to use a persistent
connection. The API Gateway acknowledges this instruction and decides to keep
the connection open for a certain amount of time after sending the message
to the host. If the connection is not reused within the Idle
Timeout period, the API Gateway closes the connection. Defaults to
You can configure this setting on a per-host basis using the Remote Hosts interface. For more details, see the API Gateway User Guide. |
|||
LDAP service provider |
Specifies the service provider used for looking up an LDAP server
(for example, com.sun.jndi.ldap.LdapCtxFactory ).
The provider is typically used to connect to LDAP directories for
certificate and attribute retrieval.
|
|||
Maximum memory per request |
The maximum amount of memory in bytes that the API Gateway can allocate to each
request. This setting helps protect against denial of service caused by undue
pressure on memory.
|
|||
Realm | Specifies the realm for authentication purposes. | |||
Schema pool size | Sets the size of the Schema Parser pool. | |||
Server brand | Specifies the branding to be used in the API Gateway. | |||
SSL session cache size |
Specifies the number of idle SSL sessions that can be kept in memory.
You can use this setting to improve performance because the slowest part
of establishing the SSL connection is cached. A new connection does not
need to go through full authentication if it finds its target in the cache.
Defaults to 32 .
If there are more than 32 simultaneous SSL sessions, this does not prevent
another SSL connection from being established, but means that no more SSL
sessions are cached. A cache size of |
|||
Token drift time | Specifies the number of seconds drift allowed for WS-Security tokens. This is important in cases where the API Gateway is checking the date on incoming WS-Security tokens. It is likely that the machine on which the token was created is out-of-sync with the machine on which the API Gateway is running. The drift time allows for differences in the respective machine clock times. | |||
Allowed number of operations to limit XPath transforms |
Specifies the total number of node operations permitted in XPath
transformations. Complex XPath expressions (or those constructed together
with content to produce expensive processing) might lead to a denial-of-service
risk. Defaults to 4096 .
|
|||
Input encodings |
Click the browse button to specify the HTTP content encodings that the API Gateway instance
can accept from peers. The available content encodings include gzip and
deflate . Defaults to no context encodings. For more details,
see the API Gateway User Guide.
|
|||
Output encodings |
Click the browse button to specify the HTTP content encodings that the API Gateway instance
can apply to outgoing messages. The available content encodings include gzip
and deflate . Defaults to no context encodings. For more details,
see the API Gateway User Guide.
|
|||
Server's SSL cert's name must match name of requested server | Ensures that the certificate presented by the server matches the name of the host address being connected to. This prevents host spoofing and man-in-the-middle attacks. This setting is enabled by default. | |||
Send desired server name to server during TLS negotiation | Specifies whether to add a field to outbound TLS/SSL calls that shows the name that the client used to connect. For example, this can be useful if the server handles several different domains, and needs to present different certificates depending on the name that the client used to connect. This setting is not selected by default. | |||
Add correlation ID to outbound headers |
Specifies whether to insert the correlation ID in outbound messages. For the
HTTP transport, this means that an X-CorrelationID header is added
to the outbound message. This is a transaction ID that is tagged to each message
transaction that passes through the API Gateway, and which is used for traffic
monitoring in the API Gateway Manager web console.
You can use the correlation ID to search for messages in the console. You can
also access the its value using the |