Oracle® Fusion Middleware

API Gateway User Guide

11g Release 2 (11.1.2.1.0)

Oracle API Gateway User Guide, 11g Release 2 (11.1.2.1.0)

Copyright © 1999, 2013, Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

This software is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications which may create a risk of personal injury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure the safe use of this software. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software in dangerous applications.

Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

This software and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services. This documentation is in prerelease status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.

The information contained in this document is for informational sharing purposes only and should be considered in your capacity as a customer advisory board member or pursuant to your beta trial agreement only. It is not a commitment to deliver any material, code, or functionality, and should not be relied upon in making purchasing decisions. The development, release, and timing of any features or functionality described in this document remains at the sole discretion of Oracle.

This document in any form, software or printed matter, contains proprietary information that is the exclusive property of Oracle. Your access to and use of this confidential material is subject to the terms and conditions of your Oracle Software License and Service Agreement, which has been executed and with which you agree to comply. This document and information contained herein may not be disclosed, copied, reproduced, or distributed to anyone outside Oracle without prior written consent of Oracle. This document is not part of your license agreement nor can it be incorporated into any contractual agreement with Oracle or its subsidiaries or affiliates.


Contents

1. Getting Started
Oracle API Gateway Overview
Overview
Integration
Performance
Governance
Security
Oracle API Gateway Architecture
Overview
Basic Architecture
Policy Development
API Gateway Administration
API Service Administration
System Administration
Managed Domain Architecture
Oracle API Gateway Concepts
Overview
Product Concepts
Starting the API Gateway Tools
Overview
Before you Begin
Launching API Gateway Manager
Starting Policy Studio
Getting Started Tutorial
Virtualizing a Service
Overview
Accessing the Example Service
Creating a Workspace in API Service Manager
Step 1—Basic Information
Step 2—Service Exposure
Step 3—Request Processing
Step 4—Routing
Step 5—Response Processing
Step 6—Monitoring
Step 7—Tags
Deploying to a Group
Accessing the Virtualized Service
Monitoring a Service
Monitoring Services
Overview
Enabling Monitoring
Viewing Real-time Monitoring
Viewing Message Traffic
Viewing Message Content
Viewing Performance Statistics
Detecting Malformed Messages
Monitoring System Data
Configuring Trace and Log Settings
Using Oracle API Gateway Analytics
Troubleshooting
Overview
Viewing API Gateway Trace Files
Setting API Gateway Trace Levels
Configuring API Gateway Trace Files
Running Trace at DEBUG level
Running Trace at DATA level
Integrating Trace Output with Apache log4J
Configuring Logging Output
Configuring Log Level and Message
Getting Help
License Acknowledgments
Overview
Acknowledgments
Oracle Contact Details
Contact Details
2. Sample Policies
Configuring the Sample Policies
Overview
Enabling the Sample Services Interface
Configuring a Different Sample Services Interface
StockQuote Demo Service
Remote Host Settings
Conversion Sample Policy
Overview
REST to SOAP Policy
Running the Conversion Sample
Security Sample Policies
Overview
Signature Verification
Encryption and Decryption
Throttling Sample Policy
Overview
Throttling Policy
Running the Throttling Sample
Virtualized Service Sample Policy
Overview
Virtualized Service policies
Running the Virtualized Service Sample
Stress Testing with Send Request (SR)
Overview
Basic SR Examples
Advanced SR Examples
SR Arguments
Sending a Request with API Gateway Explorer
Overview
Creating a Request in API Gateway Explorer
Further Information
3. Managing API Services
Introduction to API Service Manager
Overview
Accessing API Service Manager
Deploying to a Group
Resetting your Configuration
Managing API Services
Overview
Virtualizing a Service in API Service Manager
Step 1—Basic Information
Step 2—Service Exposure
Step 3—Request Processing
Step 4—Routing
Step 5—Response Processing
Step 6—Monitoring
Step 7—Tags
Deploying to a Group
4. Governance
Configuring Security Policies from WSDL Files
Overview
Importing a WSDL File
Configuring Policy Settings
Configuring Policy Filters
Editing a Policy
Removing Security Tokens
Further Information
Securing a Virtual Service using Policies
Overview
Importing a WSDL File
Configuring a Security Policy
Configuring Policy Settings
Configuring Policy Filters
Editing a Security Policy
Using WCF WS-Policies
Removing Security Tokens
Further Information
Configuring Policies Manually
Overview
Configuration
Configuring Global Policies
Overview
Global Policy Roles
Selecting a Global Policy
Configuring Global Policies in a Policy Shortcut Chain
Configuring Global Policies for a Service
Showing Global Policies
Configuring Policy Packages
Overview
Configuring a Policy Package
Applying a Policy Package
Applying a Policy Package to a Service
5. Managing Deployments
Getting Started with Managing Deployments
Overview
Connecting to a Server in the Policy Studio
Editing Server Configuration in the Policy Studio
Managing Deployments in the API Gateway Manager
Managing Admin Users in the API Gateway Manager
Configuring Policies in the Policy Studio
Deploying Configuration
Overview
Creating a Deployment Archive in the Policy Studio
Deploying a Deployment Archive in the Policy Studio
Deploying a Factory Configuration in the Policy Studio
Deploying a Currently Loaded Configuration in the Policy Studio
Deployment Summary in the Policy Studio
Deploying an Archive in API Gateway Manager
Deploying on the Command Line
Deploying the API Gateway in Multiple Environments
Overview
Configuring Environment Variables
Configuring Certificates as Environment Variables
Managing Admin Users
Overview
Admin User Privileges
Admin User Roles
Adding a New Admin User
Removing an Admin User
Resetting an Admin User Password
Managing Admin User Roles
Configuring Role-Based Access Control (RBAC)
Overview
Local Admin User Store
Access Control List
Configuring Users and Roles
Management Service Roles and Permissions
Using Active Directory for Authentication and RBAC of Management Services
Overview
Step 1: Create an Active Directory Group
Step 2: Create an Active Directory User
Step 3: Create an LDAP Connection
Step 4: Create an LDAP Repository
Step 5: Create a Test Policy for LDAP Authentication and RBAC
Step 6: Use the LDAP Policy to Protect Management Services
Adding an LDAP User with Limited Access to Management Services
Using OpenLDAP for Authentication and RBAC of Management Services
Overview
Step 1: Create an OpenLDAP Group for RBAC Roles
Step 2: Add RBAC Roles to the OpenLDAP RBAC Group
Step 3: Add Users to the OpenLDAP RBAC Group
Step 4: Create an LDAP Connection
Step 5: Create an OpenLDAP Repository
Step 6: Create a Test Policy for LDAP Authentication and RBAC
Step 7: Use the OpenLDAP Policy to Protect Management Services
6. General Configuration
Startup Instructions
Overview
Setting Passphrases
Starting the Node Manager
Starting the API Gateway
Connecting to the API Gateway
Connection Details
Overview
Connecting to a URL
Connecting to a File
Unlocking a Server Connection
Global Configuration
Overview
Server Configuration
API Gateway Settings
Web Services Repository
Processes
Policies
Certificates and Keys
API Gateway User Store
System Alerts
External Connections
Caches
Black list and White list
Schema Cache
Scripts
Stylesheets
References
Server Configuration
Overview
Deploy
API Gateway Settings
Overview
Default Settings
Audit Log
Namespace
MIME/DIME
Traffic Monitor
Metrics
Session Settings
Cache
Access Log
Security Service Module
Kerberos
Tivoli
Policy Studio Preferences
Overview
Management Services
Policy Colors
Proxy Settings
Runtime Dependencies
Server Connection
SSL Settings
Status Bar
Trace Level
Web and XML
WS-I Settings
Policy Studio Viewing Options
Overview
Filtering the Tree
Configuring Viewing Options
Configuring the Policy Filter Palette
Web Service Repository
Overview
Testing WS-I Compliance
Registering the WSDL File
Loading the WSDL File
Selecting WSDL Operations
WS-Policy Options
Deploy Policy
Secure Virtual Service
WSDL Import Summary
What is Created?
Publishing the WSDL
Setting the Encryption Passphrase
Encryption Passphrase Overview
Setting the Group Passphrase in the Policy Studio
Entering the Group Passphrase in the Policy Studio
Specifying the Passphrase in a File or on Startup
Default Settings
Overview
Settings
Namespace Settings
Overview
SOAP Namespace
Signature ID Attribute
WSSE Namespace
MIME/DIME Settings
Overview
Configuration
Session Settings
Overview
Configuration
Exporting API Gateway Configuration
Overview
What is Exported
Exporting Configuration Items
Exporting All API Gateway Configuration
Importing API Gateway Configuration
Overview
Importing Configuration
Viewing Differences
What is Imported
7. Reporting
Configuring the API Gateway for API Gateway Analytics
Overview
Connecting to the API Gateway
Configuring the Database Connection
Configuring the Database Logging
Configuring Monitoring Settings
Deploying to the API Gateway
Using Oracle API Gateway Analytics
Overview
Launching API Gateway Analytics
System
API Services
Remote Hosts
Clients
Audit Trail
Reports
Custom Reporting
Scheduled Reports
Overview
Database Configuration
Scheduled Reports Configuration
SMTP Configuration
Real-Time Monitoring Settings
Overview
Configuring Metrics Settings
Configuring Reports Settings
Configuring Traffic Monitoring
Overview
Configuration
Purging the Reports Database
Overview
Running the dbpurger Command
Example Commands
8. API Gateway Instances
Configuring API Gateway Instances
Overview
Add Remote Host
Add HTTP Services
Add SMTP Services
Add File Transfer Services
Add Policy Execution Scheduler
Messaging System
FTP Poller
Directory Scanner
POP Client
TIBCO
API Gateway Settings
API Gateway Logging
Cryptographic Acceleration
Configuring HTTP Services
Overview
HTTP Services Groups
HTTP and HTTPS Interfaces
HTTPS Interfaces Only
Relative Paths
Web Service Resolvers
Static Content Provider
Servlet Applications
Management Services
Changing the Management Services Port
Configuring SMTP Services
Overview
Adding an SMTP Service
Adding an SMTP Interface
Configuring Policy Handlers for SMTP Commands
Adding an HELO/EHLO Policy Handler
Adding an AUTH Policy Handler
Adding a MAIL Policy Handler
Adding a RCPT Policy Handler
Adding a DATA Policy Handler
SMTP Authentication
SMTP Content-Transfer-Encoding
Deployment Example
File Transfer Service
Overview
General Configuration
File Upload
Secure Services
Commands
Access Control
Messages
Directory
Policy Execution Scheduling
Overview
Cron Expressions
Adding a Schedule
Adding a Policy Execution Scheduler
FTP Poller
Overview
General Settings
Scan Details
Connection Type
FTP and FTPS Connections
FTPS Connections
SFTP Connections
Directory Scanner
Overview
Directory to Scan
Directory for Output
Completed Directory
Working Directory
Policy to Use
Packet Sniffers
Overview
Configuration
Messaging System
Overview
Configuring a JMS Service
Configuring a JMS Session
Configuring a JMS Consumer
Configuring the JMS Wizard
Remote Host Settings
Overview
General Settings
Address and Load Balancing Settings
Advanced Settings
Configuring an HTTP Watchdog
Overview
Configuration
Configuring Conditions for HTTP Interfaces
Overview
Requires Endpoint Condition
Requires Link Condition
POP Client
Overview
Configuration
TIBCO Integration
Overview
TIBCO Rendezvous Integration
TIBCO Enterprise Messaging Service Integration
Cryptographic Acceleration
Overview
General Configuration
Conversations for Crypto Engines
Cryptographic Acceleration Conversation: Request-Response
Conversations for Crypto Engines
TIBCO Rendezvous Daemon
Overview
Configuration
TIBCO Rendezvous Listener
Overview
Configuration
TIBCO Enterprise Messaging Service Consumer
Overview
Configuration
Oracle Security Service Module Settings (10g)
Overview
Prerequisites
Settings
Name Authority Definition
Further Information
9. Resources
Certificates and Keys
Overview
Viewing Certificates and Private Keys
Configuring an X.509 Certificate
Configuring a Private Key
Global Options
Managing Certificates and Keystores
Configuring Key Pairs
Configuring PGP Key Pairs
API Gateway Users
Overview
Users
Adding Users
Attributes
Groups
Adding Groups
Updating Users or Groups
Global Schema Cache
Overview
Adding Schemas to the Cache
Testing WSDL Files for WSI Compliance
Organizing Schemas with Schema Containers
Schema Validation
External Connections
Overview
Authentication Repository Profiles
Connection Sets
Database Connections
ICAP Servers
JMS Services
Kerberos Connections
LDAP Connections
OCSP Connections
Proxy Servers
RADIUS Clients
SiteMinder
SMTP Servers
SOA Security Manager
Syslog Servers
TIBCO
Tivoli
URL Connection Sets
XKMS Connections
Global Caches
Overview
Local Caches
Distributed Caches
Distributed Cache Settings
Example of Caching Response Messages
10. Attributes
Compare Attribute
Overview
Configuration
Extract REST Request Attributes
Overview
Configuration
Extract WSS Timestamp
Overview
Configuration
Extract WSS UsernameToken
Overview
Configuration
Extract WSS Header
Overview
Configuration
Get Cookie
Overview
Configuration
Attribute Storage
Retrieve Attribute from Database
Overview
General Configuration
Database
Advanced
Retrieve Attributes from Directory Server
Overview
General Configuration
Database
Advanced
Retrieve Attribute from HTTP Header
Overview
Configuration
Insert SAML Attribute Assertion
Overview
General Configuration
Assertion Details
Assertion Location
Subject Confirmation Method
Advanced
Retrieve Attributes with JSON Path
Overview
Configuration
JSON Path Examples
Retrieve Attribute from Message
Overview
Configuration
Retrieve Attribute from SAML Attribute Assertion
Overview
Details
Trusted Issuers
Subject Configuration
Lookup Attributes
SAML PDP Attributes
Overview
Request Configuration
Response Configuration
Retrieve Attribute from User Store
Overview
General Configuration
Database
Advanced
11. Authentication
Attribute Authentication
Overview
Configuration
Authenticate API Key
Overview
General Settings
API Key Settings
Advanced
CA SOA Security Manager Authentication
Overview
Agent Configuration
Message Details Configuration
XmlToolkit.properties File
HTML Form-based Authentication
Overview
General Settings
Session Settings
HTTP Basic Authentication
Overview
Configuration
HTTP Digest Authentication
Overview
Configuration
HTTP Header Authentication
Overview
Configuration
IP Address
Overview
Configuration
Configuring Subnet Masks
SAML Authentication
Overview
General Settings
Details
Trusted Issuers
SAML PDP Authentication
Overview
Request Configuration
Response Configuration
Insert SAML Authentication Assertion
Overview
General Configuration
Assertion Details
Assertion Location
Subject Confirmation Method
Advanced
Insert Timestamp
Overview
Configuration
Insert WS-Security Username Token
Overview
General Configuration
Credential Details
Advanced
Kerberos Client Authentication
Overview
Kerberos Client
Kerberos Token Profile
Kerberos Service Authentication
Overview
Kerberos Service
Kerberos Standard
Message Level
Transport Level
Advanced SPNEGO
Kerberos Configuration
Overview
Kerberos Configuration File - krb5.conf
Advanced Settings
Native GSS Library
Kerberos Clients
Overview
Ticket Granting Ticket Source
Kerberos Principal
Secret Key
Advanced Tab
Kerberos Services
Overview
Kerberos Endpoint Tab
Advanced Tab
Kerberos Principals
Overview
Configuration
Kerberos Keytab
Overview
Configuration
SAML Authentication XML-Signature Verification
Overview
Configuration
XML Signature Authentication
Overview
Configuration
SSL Authentication
Overview
Configuration
Security Token Service Client
Overview
Example Request
General Settings
Request Settings
Issue: POP Key
Issue: On Behalf Of Token
Issue: Token Scope and Lifetime
Validate: Target
Policies Settings
Routing
Response Settings
Advanced Settings
WS-Security Username Authentication
Overview
General Configuration
Token Validation
Token Verification via Repository
12. Authorization
Attributes
Overview
Configuration
Certificate Attributes
Overview
Configuration
RSA Access Manager Authorization
Overview
General Details
Connection Details
Authorization Details
Entrust GetAccess Authorization
Overview
GetAccess WS-Trust STS
GetAccess SAML PDP
Insert SAML Authorization Assertion
Overview
General Configuration
Assertion Details
Assertion Location
Subject Confirmation Method
Advanced
RBAC Filter
Overview
Configuration
SAML Authorization Assertion
Overview
General Settings
Details
Trusted Issuers
Optional Settings
SAML PDP Authorization
Overview
Request Configuration
Response
Tivoli Integration
Overview
Integration Architecture
Prerequisites
Global Tivoli Configuration
Tivoli Authorization
Tivoli Authentication
Tivoli Attribute Retrieval
Tivoli Authorization
Overview
Adding a Tivoli Client
Adding Users and Web Services to Tivoli
Configuring Tivoli Authorization
Tivoli Authentication Refresh
Retrieve Attributes from Tivoli
Overview
Configuration
CA SOA Security Manager Authorization
Overview
Configuration
SAML Authorization XML-Signature Verification
Overview
Configuration
XACML Policy Enforcement Point
Overview
Example XACML Request
General Settings
XACML Settings
Routing Settings
Advanced Settings
13. CA SiteMinder
SiteMinder Certificate Authentication
Overview
Configuration
SiteMinder Session Validation
Overview
Configuration
SiteMinder Logout
Overview
Configuration
SiteMinder Authorization
Overview
Configuration
SiteMinder/SOA Security Manager Connection
Overview
SiteMinder and SOA Security Manager Connection Details
SOA Security Manager Connection Details Only
14. Certificates
Static CRL Certificate Validation
Overview
Configuration
Dynamic CRL Certificate Validation
Overview
Configuration
CRL LDAP Validation
Overview
Configuration
CRL Responder
Overview
Configuration
Create Thumbprint from Certificate
Overview
Configuration
Certificate Validity
Overview
Configuration
Find Certificate
Overview
Configuration
Extract Certificate Attributes
Overview
Generated Message Attributes
Configuration
Certificate Chain Check
Overview
Configuration
OCSP Certificate Validation
Overview
Configuration
OCSP Certificate Validation Connection
Overview
Configuration
Validate Server's Certificate Store
Overview
Configuration
Deployment Example
XKMS Certificate Validation
Overview
Configuration
XKMS Certificate Validation Connection
Overview
Configuration
15. Cache
Cache Attribute
Overview
Configuration
Create Key
Overview
Configuration
Is Cached?
Overview
Configuration
Removed Cached Attribute
Overview
Configuration
16. Content Filtering
ClamAV Anti-Virus
Overview
Configuration
Content Type Filtering
Overview
Allow or Deny Types
Configuring MIME/DIME Types
Content Validation
Overview
Manual XPath Configuration
XPath Wizard
HTTP Header Validation
Overview
Configuring HTTP Header Regular Expressions
Configuring Threatening Content Regular Expressions
ICAP Filter
Overview
Configuration
Example Policies
Further Information
McAfee Anti-Virus
Overview
Configuring a McAfee Anti-Virus Filter
Configuring Custom Options
Reporting Message Status
Loading McAfee Updates
Message Size
Overview
Configuration
Query String Validation
Overview
Request Query String
Configuring Query String Attribute Regular Expressions
Configuring Threatening Content Regular Expressions
Schema Validation
Overview
Schema to Use
Part of Message to Match
Advanced
Reporting Schema Validation Errors
JSON Schema Validation
Overview
Configuration
Generating a JSON Schema Using Jython
Sophos Anti-Virus
Overview
General Settings
Sophos Configuration Settings
Threatening Content
Overview
Scanning Details
MIME Types
Throttling
Overview
General Settings
Cache Settings
Using Multiple Throttling Filters
Validate Message Attributes
Overview
Configuring Message Attribute Regular Expressions
Threatening Content Regular Expressions
Validate REST Request
Overview
General Configuration
REST Request Parameter Restrictions
Validate Timestamp
Overview
Configuration
WS-SecurityPolicy Layout
Overview
Configuration
XML Complexity
Overview
Configuration
17. Conversion
Add HTTP Header
Overview
Configuration
JSON Add Node
Overview
Configuration
Examples
Add XML Node
Overview
General Configuration
Configure where to Insert the New Nodes
Node Source
Configure New Node Details
Attribute Node Details
Examples
Contivo Transformation
Overview
Configuration
Multipart Bodypart Conversion
Overview
Configuration
Create Cookie
Overview
Configuration
Create REST Request
Overview
Configuration
Set HTTP Verb
Overview
Configuration
Insert MTOM Attachment
Overview
Configuration
JSON to XML
Overview
Configuration
Examples
Extract MTOM Attachment
Overview
Configuration
Load File
Overview
Configuration
Remove Attachments
Overview
Configuration
Remove HTTP Header
Overview
Configuration
JSON Remove Node
Overview
Configuration
Examples
Remove XML Node
Overview
Configuration
Restore Message
Overview
Configuration
Store Message
Overview
Configuration
Set Message
Overview
Configuration
XSLT Transformation
Overview
Stylesheet Location
Stylesheet Parameters
Advanced
XML to JSON
Overview
Configuration
18. Encryption
Generate Key
Overview
Configuration
PGP Decrypt
Overview
Configuration
PGP Encrypt
Overview
Configuration
SMIME Decryption
Overview
Configuration
SMIME Encryption
Overview
General Configuration
Recipients
Advanced
XML-Decryption
Overview
Configuration
Auto-generation using the XML Decryption Wizard
XML-Decryption Settings
Overview
XML Encryption Overview
Node(s) to Decrypt
Decryption Key
Options
Auto-generation using the XML Decryption Wizard
XML-Encryption
Overview
Configuration
Auto-generation using the XML Encryption Settings Wizard
XML-Encryption Settings
Overview
XML Encryption Overview
Encryption Key
Key Info
Recipients
What to Encrypt
Advanced
Auto-generation using the XML Encryption Settings Wizard
XML Encryption Wizard
Overview
Configuration
19. Integrity
XML Signature Generation
Overview
Signing Key
What to Sign
Where to Place Signature
Advanced
Additional
Algorithm Suite
Options
XML Signature Verification
Overview
Signature Verification
What Must Be Signed
Advanced
PGP Sign
Overview
Configuration
PGP Verify
Overview
Configuration
SMIME Sign
Overview
Configuration
SMIME Verify
Overview
Configuration
20. Fault Handlers
Generic Error
Overview
General Configuration
Generic Error Contents
JSON Error
Overview
General Configuration
JSON Error Contents
Customized JSON Errors
SOAP Fault
Overview
SOAP Fault Format
SOAP Fault Contents
Customized SOAP Faults
21. Monitoring
System Alerting
Overview
Configuring an Alert Destination
Configuring an Alert Filter
Audit Log Settings
Overview
Configuring Log Output
Log to Text File
Log to XML File
Log to Database
Log to Local Syslog
Log to Remote Syslog
Log to System Console
Access Log Settings
Overview
Log Format
Configuring the Access Log
Log Level and Message
Overview
Configuration
Log Message Payload
Overview
Configuration
Log Access Filter
Overview
Log Format
Configuration
Service Level Agreement (SLA) Filter
Overview
Response Time Requirements
HTTP Status Requirements
Communications Failure Requirements
Select Alerting System
Set Service Context
Overview
Configuration
22. OAuth
API Gateway OAuth 2.0 Introduction
Overview
OAuth 2.0 Definitions
OAuth 2.0 Authentication Flows
Further Information
Configuring and Managing OAuth 2.0
Overview
Enabling OAuth 2.0 Management
Pre-registered Client Applications
Managing Registered Clients
Sample Clients
Token Management
API Manager REST API
Database-Backed API Manager
OAuth Database Schemas
OpenSSL Commands
OAuth 2.0 Message Attributes
API Gateway OAuth 2.0 Authentication Flows
Overview
Authorization Code (or Web Server) Flow
Implicit Grant (or User Agent) Flow
Resource Owner Password Credentials Flow
Client Credentials Grant Flow
OAuth 2.0 JWT Flow
Revoke Token
Token Info Service
OAuth Access Token Information
Overview
Access Token Info Settings
Monitoring
Access Token using Authorization Code
Overview
Application Validation
Access Token
Monitoring
Access Token using Client Credentials
Overview
Application Validation
Access Token
Monitoring
Access Token using JWT
Overview
Application Validation
Access Token
Monitoring
Authorization Code Flow
Overview
Validation/Templates
Authz Code Details
Access Token Details
Monitoring
Authorize Transaction
Overview
Validation/Templates
Authz Code Details
Access Token Details
Monitoring
Refresh Access Token
Overview
Application Validation
Access Token
Monitoring
Resource Owner Credentials
Overview
Application Validation
Access Token
Monitoring
Revoke a Token
Overview
Revoke Token Settings
Monitoring
Validate Access Token
Overview
Configuration
23. Oracle Access Manager
Oracle Access Manager Authorization
Overview
Configuration
Oracle Access Manager Log in with Certificate
Overview
General Configuration
Resource Configuration
Session Configuration
OAM Access Server SDK Configuration
Logout from Oracle Access Manager SSO Session
Overview
Configuration
Oracle Access Manager SSO Token Validation
Overview
Configuration
24. Oracle Entitlements Server
Oracle Entitlements Server 10g Authorization
Overview
General
Settings
Application Context
Get Roles from Oracle Entitlements Server 10g
Overview
General
Settings
Application Context
Oracle Entitlements Server 11g Authorization
Overview
Configuration
25. Resolvers
Relative Path Resolver
Overview
Configuration
SOAP Action Resolver
Overview
Configuration
Operation Name
Overview
Configuration
26. Routing
Getting Started with Routing Configuration
Overview
Proxy or Endpoint Server
Service Virtualization
Choosing the Correct Routing Filters
Case 1: Proxy without Service Virtualization
Case 2: Proxy with Service Virtualization
Case 3: Endpoint without Service Virtualization
Case 4: Endpoint with Service Virtualization
Case 5: Simple Redirect
Case 6: Routing on to an HTTP Proxy
Summary
Routing Wizard
Overview
Configuration
Call Internal Service
Overview
Configuration
Connection
Overview
General Configuration
Trusted Certificates
Client SSL Authentication
HTTP Authentication
Kerberos Authentication
Behavior
Advanced
Connect to URL
Overview
General Configuration
Trusted Certificates
Client SSL Authentication
HTTP Authentication
Kerberos Authentication
Behavior
Advanced
Request Details
Dynamic Router
Overview
Configuration
Extract Path Parameters
Overview
Configuration
Required Input and Generated Output
Possible Outcomes
File Download
Overview
General Settings
File Details
Connection Type
FTP and FTPS Connections
FTPS Connections
SFTP Connections
File Upload
Overview
General Settings
File Details
Connection Type
FTP and FTPS Connections
FTPS Connections
SFTP Connections
HTTP Redirect
Overview
Configuration
HTTP Status Code
Overview
Configuration
Insert WS-Addressing
Overview
Configuration
Messaging System Filter
Overview
Request Settings
Response Settings
Read WS-Addressing
Overview
Configuration
Rewrite URL
Overview
Configuration
Save to File
Overview
Configuration
SMTP Routing
Overview
General Settings
Message Settings
Static Router
Overview
Configuration
TIBCO Rendezvous Routing
Overview
Configuration
TIBCO Enterprise Messaging Service Routing Filter
Overview
Connection
Request
Response
TIBCO Enterprise Messaging Service Connection
Overview
Configuration
Wait for Response Packets
Overview
Packet Sniffer Configuration
Sniffing Response Packets
Proxy Servers
Overview
Configuration
27. Security Services
DSS Signature Generation Service
Overview
Configuration
DSS Signature Verification
Overview
Configuration
Encrypt and Decrypt Web Services
Overview
Configuration
STS Web Service
Overview
Configuration
28. WS-Trust
Consume WS-Trust Message
Overview
Consume WS-Trust Message Types
Message Consumption
Advanced
Create WS-Trust Message
Overview
Create WS-Trust Message Type
Message Creation
RST Creation
RSTR Creation
Advanced Settings
29. Extensibility
Advanced Filter View
Overview
Configuration
Selecting Configuration Values at Runtime
Overview
Selector Syntax
Example Selector Expressions
Extracting Message Attributes
Key Property Stores
Overview
KPS Backing Data Stores
Configuring a Key Property Store
Scripting Language Filter
Overview
Writing a Script
Configuring a Script Filter
Adding a Script to the Library
Writing a Custom Filter using the Oracle API Gateway SDK
Overview
Policies, Filters, and Message Attributes
Oracle API Gateway SDK Overview
Tutorial Prerequisites
Oracle API Gateway SDK Sample Overview
Step 1: Create the Typedocs
Step 2: Create the Filter Class
Step 3: Create Processor Class
Step 4: Create Policy Studio Classes
Step 5: Build Classes
Step 6: Load TypeDocs
Step 7: Construct a Policy
Step 8: Configure the SimpleFilter
Conclusion
30. Utility
Abort Filter
Overview
Configuration
Check Group Membership
Overview
Configuration
Possible Paths
Configuration Web Service
Overview
Copy/Modify Attributes
Overview
Configuration
Evaluate Expression
Overview
Configuration
Execute External Process
Overview
Configuration
False Filter
Overview
Configuration
HTTP Parser
Overview
Configuration
Insert BST
Overview
Configuration
Invoke Policy per Message Body
Overview
Configuration
Locate XML Nodes
Overview
Configuration
Pause Filter
Overview
Configuration
Policy Shortcut
Overview
Configuration
Policy Shortcut Chain
Overview
General Configuration
Add a Policy Shortcut
Edit a Policy Shortcut
Quote of the Day
Overview
Configuration
Reflect Message Filter
Overview
Configuration
Reflect Message And Attributes Filter
Overview
Configuration
Remove Attribute
Overview
Configuration
Set Response Status
Overview
Configuration
Set Attribute
Overview
Configuration
String Replace Filter
Overview
Configuration
Switch on Attribute Value
Overview
Configuration
Adding a Switch Case
Time Filter
Overview
General Configuration
Basic Time Options
Advanced Time Options
Trace Filter
Overview
Configuration
True Filter
Overview
Configuration
31. Web Services
Web Service Filter
Overview
General Settings
Routing
Validation
Message Interception Points
WSDL
Monitoring
Return WSDL
Overview
Configuration
Set Web Service Context
Overview
Configuration
32. Common Configuration
Authentication Repository
Overview
Local Repositories
LDAP Repositories
CA SiteMinder Repositories
Database Repositories
Entrust GetAccess Repositories
Oracle Access Manager Repositories
Oracle Entitlements Server 10g Repositories
RADIUS Repositories
RSA Access Manager Repositories
Tivoli Repositories
Certificate Chain Check
Overview
Configuration
Certificate Validation
Overview
Configuration
Configuring URL Groups
Compressed Content Encoding
Overview
Encoding of HTTP Responses
Encoding of HTTP Requests
Delimiting the End of an HTTP Message
Configuring Content Encoding
Further Information
Configuring Connection Groups
Overview
Configuring a Connection Group
Configuring a Connection
Configuring Cron Expressions
Overview
Creating a Cron Expression using the Time Tabs
Entering a Cron Expression
Testing the Cron Expression
Further Information
Database Connection
Overview
Configuring the Database Connection
Database Connection Pool Settings
Connection Validation
Test the Connection
Database Query
Overview
Configuration
Configuring ICAP Servers
Overview
General Settings
Server Settings
Security Settings
Advanced Settings
Further Information
Configuring LDAP Directories
Overview
General Configuration
Authentication Configuration
Testing the LDAP Connection
Additional JNDI Properties
RADIUS Clients
Overview
Configuration
SAML PDP Response XML-Signature Verification
Overview
Configuration
Signature Location
Overview
Configuration
SMTP Servers
Overview
Configuration
Configuring a Transparent Proxy
Overview
Configuring Transparent Proxy Mode for Incoming Interfaces
Configuring Transparent Proxy Mode for Outgoing Calls
Configuration Example
Retrieving WSDL Files from a UDDI Registry
Overview
UDDI: A Brief Introduction
UDDI Definitions
Configuring a Registry Connection
WSDL Search
Quick Search
Name Search
Advanced Search
Advanced Options
Publish
Connecting to a UDDI Registry
Overview
Configuring a Registry Connection
Securing a Connection to a UDDI Registry
Publishing WSDL Files to a UDDI Registry
Overview
Finding WSDL Files
Publishing WSDL Files
Step 1: Enter Virtualized Service Address and WSDL URL for Publishing in UDDI Registry
Step 2: View WSDL to UDDI Mapping Result
Step 3: Select a Registry for Publishing
Step 4: Select a Duplicate Publishing Approach
Step 5: Create or Search for Business
Step 6: Publish WSDL
LDAP User Search
Configure Directory Search
Configuring URL Groups
Overview
Configuration
What To Sign
Overview
ID Configuration
Node Locations
XPath Configuration
XPath Predicates
Message Attribute
Configuring XPath Expressions
Overview
Manual Configuration
XPath Wizard
33. Reference
Message Attribute Reference
Message Filter Reference
WS-Policy Reference
Glossary of Terms