Chaining processors, Custom policies, or Event listeners
Custom Policies were formerly known as Adapters (custom). This page uses the updated terminology throughout. For example, what was previously called "Chain Adapter" is now "Chain Custom Policy."
Chaining
Chaining is the process of linking multiple processors into a single configuration so they run in a defined sequence for an endpoint. Cloud API Management supports multiple pre-processing and post-processing steps for chained processors.
Types of chaining
Chaining a processor using Mashery Proxy Processor Chain
You can chain a processor using the Mashery_Proxy_Processor_Chain (a Cloud API Management processor) or an SDK-based processor. Mashery_Proxy_Processor_Chain implements pre-process or post-process traffic events. Refer to Proxy processor chain configuration values for more information.
Chaining a processor using Chain Custom Policy
Chain custom policy can chain Traffic Event Listeners, Processors, in Cloud API Management (SaaS) and Boomi Cloud API Management - Local Edition (on-premise).
A custom policy enables multiple traffic processing components, such as Processors and Traffic Event Listeners, to be linked or chained in sequence within a traffic policy.
The Traffic Event Listener is a component in the Traffic Manager framework that listens for and responds to traffic events (such as request arrival or response completion) within a traffic policy pipeline. Custom policies that implement the Traffic Event Listener interface, such as the Cloud API Management Circuit Breaker Service Policy, can be chained using the chain custom policy.
For chaining custom policies, use the following Cloud API Management-provided policies:
- OAuth2 JWT Authentication Policy
- OAuth2 Shared Token Policy
- Cloud API Management Circuit Breaker Service Policy
These processors cannot be created using the Cloud API Management SDK.
You cannot change the authentication event using Proxy Processor Chain (Mashery_Proxy_Processor_Chain) or Chain Custom Policy (com.mashery.proxy.customer.generic.oauth2-jwt-authenticator), but can only chain pre-processing and post-processing.
Possible chaining combination in Cloud API Management
The following table summarizes the available chain combinations in Cloud API Management (SaaS-based):
| Chain Combination | SDK-based Policies | Cloud API Management-provided Policies | Chain Custom Policy: Using OAuth2 JWT Authentication Connector | Chain Custom Policy: OAuth2 Shared TokenConnector |
|---|---|---|---|---|
| SDK-based Policies | ❌ Not supported | ❌ Not supported | ❌ Not supported | ❌ Not supported |
| Cloud API Management-provided Policies | ❌ Not supported | ✅ Using Mashery Proxy Processor Chain | ✅ Using OAuth2 JWT Authentication | ✅ Using OAuth2 Shared TokenConnector |
| Chain Policy: OAuth2 JWT Authentication | ❌ Not supported | ✅ Using OAuth2 JWT Authentication Connector | ❌ Not supported | ❌ Not supported |
| Chain Policy: OAuth2 Shared Token | ❌ Not supported | ✅ Using OAuth2 Shared Token | ❌ Not supported | ❌ Not supported |
| Chain Policy: JSON Threat Protection | ❌ Not supported | ✅ Using Mashery Proxy Processor Chain | ❌ Not supported | ❌ Not supported |
| Chain Policy: XML Threat Protection | ❌ Not supported | ✅ Using Mashery Proxy Processor Chain | ❌ Not supported | ❌ Not supported |
| Chain Policy: Circuit Breaker Service | ❌ Not supported | ✅ Using Chain Policy Circuit Breaker Service | ❌ Not supported | ❌ Not supported |
