Accordion | Use to... |
Request Handling | Request handler allows receiving and transforming the incoming message from a client into a custom format as expected by the native API. For example, a Require HTTP / HTTPS action mandates that the incoming requests for an API are received over the HTTP and/or HTTPS protocol. |
Policy Enforcement | Enforces the adherence to real-time policy compliance identifying/authenticating, monitoring, auditing, and measuring and collecting result statistics for an API. |
Response Processing | Response handler allows processing of the response message coming from the native API into a custom format as expected by the client. |
Error Handling | Error handlers are used to format and return error messages. Errors can occur at run-time for various reasons. For example, security errors occur if a username is not correctly validated or authorized; transformation errors occur if transformation action is unable to successfully transform a message; a routing error is raised if a routing endpoint is unavailable, and so on. |
This action... | Use to... | Available in Message Flow Stage... | Applicable for... |
Request Handling > Protocol | |||
Specify the JMS protocol for the API to accept and process the requests. | Receive | ![]() | |
Specify the HTTP and/or HTTPS protocol, SOAP format (for a SOAP-based API), and the HTTP methods (for a REST-based API) for the API to accept and process the requests. | Receive | ![]() ![]() | |
Invoke an XSL transformation in the incoming request before it is submitted to the an API. | Receive | ![]() ![]() | |
Invoke a webMethods Integration Server service to pre-process the request before it is submitted to the an API. | Receive | ![]() ![]() | |
Policy Enforcement > Authentication | |||
Identify and validate the consumer's authentication credentials contained in the request's Authorization header using HTTP basic authentication mechanism. | Routing | ![]() ![]() | |
Identify and validate the consumer's authentication credentials contained in the request's Authorization header using NTLM authentication mechanism. | Routing | ![]() ![]() | |
Identify and validate the consumer's authentication credentials contained in the request's Authorization header using OAuth 2.0 authentication mechanism. | Routing | ![]() ![]() | |
Policy Enforcement > JMS Routing | |||
Specify a JMS queue to which the Mediator is to submit the request, and the destination to which the an API is to return the response. | Routing | ![]() | |
Specify JMS message properties to authenticate client requests before submitting to the an APIs. | Routing | ![]() | |
Specify JMS headers to authenticate client requests before submitting to the an APIs. | Routing | ![]() | |
Policy Enforcement > Logging and Monitoring | |||
Log request/response payloads to a destination you specify. | Enforce | ![]() ![]() | |
Monitor the run-time performance for a specific consumer, and defines the level of performance that the specified consumer should expect from the API. | Enforce | ![]() ![]() | |
Monitor a user-specified set of run-time performance conditions for an API, and sends alerts to a specified destination when these performance conditions are violated. | Enforce | ![]() ![]() | |
Policy Enforcement > Routing | |||
Route requests directly to a native endpoint that you specify. | Routing | ![]() ![]() | |
Route requests to different endpoints based on specific values that appear in the request message. | Routing | ![]() ![]() | |
Routes the requests across multiple endpoints. | Routing | ![]() ![]() | |
Route requests to different endpoints based on specific values that appear in the request message. | Routing | ![]() ![]() | |
Specify the HTTP headers to process the requests. | Routing | ![]() ![]() | |
Policy Enforcement > Security | |||
Mandate that requests be sent via SSL client certificates, and can be used by both SOAP and REST APIs. | Enforce | ![]() | |
Mandate that a request's XML element (which is represented by an XPath expression) be signed. | Enforce | ![]() | |
Mandate that a request's XML element (which is represented by an XPath expression) be encrypted. | Enforce | ![]() | |
Mandate that timestamps be included in the request header. | Enforce | ![]() | |
Uses a WSS Security Assertion Markup Language (SAML) assertion token to validate API consumers. | Enforce | ![]() | |
![]() ![]() | Enforce | ![]() ![]() | |
![]() ![]() | Enforce | ![]() ![]() | |
![]() ![]() | Enforce | ![]() ![]() | |
![]() ![]() | Enforce | ![]() | |
![]() ![]() | Enforce | ![]() | |
![]() ![]() | Enforce | ![]() ![]() | |
![]() ![]() | Enforce | ![]() ![]() | |
![]() ![]() | Enforce | ![]() ![]() | |
Policy Enforcement > Traffic Management | |||
![]() ![]() | Enforce | ![]() ![]() | |
Policy Enforcement > Validation | |||
Validate all XML request and/or response messages against an XML schema referenced in the WSDL. | Enforce | ![]() | |
Response Processing | |||
Invoke an XSL transformation in the SOAP response payloads from XML format to the format required by the consumer. | Response | ![]() ![]() | |
Invoke a webMethods Integration Server service to process the response from the an API before it is returned to the consumer. | Response | ![]() ![]() | |
Error Handling | |||
Return a custom error message (and/or the native provider's service fault content) to the consumer when the native provider returns a service fault. | Response | ![]() |
Stage | Description |
Receive | Request stage is used for processing the request path of the Message Flow. |
Enforce | Enforce stage is used for processing the enforcement path of the Message Flow. The enforce stage is used to identify and validate specific consumers invoking APIs, throttle traffic, log request/response payloads, and monitor run-time performance conditions. |
Routing | Routing stage is used for processing the routing path of the Message Flow. The routing stage is used to perform request-response communication. It represents the boundary between request and response processing for the API. When the routing stage dispatches a request message, request processing is considered finished. When the routing stage receives a response message, response processing begins. |
Response | Response stage is used for processing the response path of the Message Flow. In addition, response stage is used as error handler. |