Contents
You can configure the underlying settings for the API Gateway using the Server Settings node in the Policy Studio tree. Alternatively, select the Tasks > Manage Gateway Settings menu option in the Policy Studio main menu. This topic describes the settings available in the Server Settings screen. Click or expand a tree node on this screen to configure the appropriate settings. You can confirm changes to these settings by clicking the Apply Changes button at the bottom right of each screen.
The top-level General settings are applied to all instances of the API Gateway that use this configuration. For example, you can change the tracing level, various timeouts and cache sizes, and other such global information. For more details, see General settings.
In addition, you can also configure the following settings under the General node:
If you have deployed several API Gateways throughout your network, you should configure a distributed cache. In a distributed cache, each cache is a peer in a group and needs to know where all the other peers in the group are located. The Cache settings enable you to configure settings for peer listeners and peer discovery. For more details, see the API Gateway Policy Developer Guide.
The API Gateway can filter Multipurpose Internet Mail Extensions (MIME) messages based on the content types (or MIME types) of the individual parts of the message. This also applies to Direct Internet Message Encapsulation (DIME), which is a streamlined version of MIME. The MIME/DIME settings list the default MIME/DIME types that the API Gateway can filter on. These types are then used by the Content Types filter to determine which MIME/DIME types to block or allow through to the back end Web service. For more details, see MIME/DIME settings.
The Namespaces settings are used to determine the versions of SOAP, Web Services Security (WSSE) and Web Services Utility (WSU) that the API Gateway supports. For more details, see Namespace settings.
The HTTP Session settings enable you to configure HTTP session management
settings for the selected cache. For example, you can configure the period of time before
expired sessions are cleared from the default HTTP Sessions cache. For more
details, see HTTP Session settings.
The Logging settings enable you to configure the following:
The Transaction Audit Log settings enable you to configure the default message transaction logging behavior of the API Gateway. For example, you can configure the API Gateway to log to a database, text or XML file, local or remote UNIX syslog, or the system console. For more details, see the topic on Transaction audit log settings.
The Transaction Access Log records a summary of all request and response messages that pass through the API Gateway. For example, this includes details such as the remote hostname, username, date and time, first line of the request message, HTTP status code, and number of bytes. For details on configuring these settings per API Gateway, see Transaction access log settings.
The Transaction Event Log provides a summary of each API Gateway message transaction, which is written to a log file, and used to generate metrics for API Gateway monitoring (for example, in the Monitoring view in API Gateway Analytics). For details on configuring these settings per API Gateway, see Transaction event log settings.
The Messaging settings enable you to configure settings for the embedded Apache ActiveMQ server that is available in each API Gateway instance. For example, these include the listening interface, port, shared directory, and so on. For more details, see Embedded ActiveMQ settings.
The Monitoring settings enable you to configure the following:
The Real Time Monitoring settings enable you to configure statistics about messages that API Gateway instances store in a database. The API Gateway Analytics monitoring tool can then poll this database, and produce charts and graphs showing how the API Gateway is performing. For more details, see Real-time monitoring metrics.
The Traffic Monitor settings enable you to configure the web-based Traffic Monitor tool and its message traffic log. For example, you can configure where the data is stored and what message transaction details are recorded in the log. For more details, see Traffic monitoring settings.
The Security settings enable you to configure the following:
You can configure the API Gateway to act as an Oracle Security Service Module (SSM) to enable integration with Oracle Entitlements Server 10g. The API Gateway acts as a Java SSM, which delegates to Oracle Entitlements Server 10g. For example, you can authenticate and authorize a user for a particular resource against an Oracle Entitlements Server 10g repository. For more details, see the API Gateway Policy Developer Guide.
![[Important]](../common_oracle/images/admon/important.png) |
Important |
|---|---|
|
Oracle SSM is required for integration with Oracle OES 10g only. Oracle SSM is not required for integration with Oracle OES 11g. |
You can configure Kerberos settings such as the Kerberos configuration file to the API Gateway, which contains information about the location of the Kerberos Key Distribution Center (KDC), encryption algorithms and keys, and domain realms. You can also configure options for APIs used by the Kerberos system, such as the Generic Security Services (GSS) and Simple and Protected GSSAPI Negotiation (SPNEGO) APIs. For more details, see the API Gateway Policy Developer Guide.
