CentraSite Documentation : Runtime Governance with CentraSite : Virtualized APIs in CentraSite Business UI : Assigning Run-Time Actions to a Virtualized API : Before You Begin
Before You Begin
The Virtualize <API_Name> (Step 2 of 3) wizard specifies the list of actions to govern the run-time behavior for the virtualized API.
When you define the actions for a virtualized API, keep the following points in mind:
*A run-time policy configuration is valid if:
*it consists of at least one action in each of these stages - Receive and Routing.
*there is a valid endpoint configured in the Route to field of the Routing action.
*When you drag an action from the Policy Actions area, the respective step in the Message Flow area highlights where the action fits in, thus making the navigation from Policy Actions area to the Message Flow area more intuitive.
*Not all stages support the full set of actions. Every action happens only within a respective step. For example, the “Evaluate” actions occur only on the Enforce stage; while the “Routing” actions occur only on the Routing stage.
*Mediator executes the policy actions configured for the virtualized API in a predefined order. For information about how Mediator executes actions (and how to avoid policy conflicts), see Effective Policies.
*Some actions are mutually dependent. That is, a specific action must be used in conjunction with another particular action. For example, a Message Flow area that includes the Set JMS Headers action must also include the JMS Routing Rule action.
*Some actions are mutually exclusive. That is, a specific action cannot be used in conjunction with another particular action. For example, a Message Flow area that includes the JMS Routing Rule action cannot include the Straight Through Routing action.
*Some of the actions are allowed to appear multiple times within a message flow step.
For those actions that can appear in a message flow only once (for example, Evaluate IP Address), Mediator will choose only one, which might cause problems or unintended results.
*You can view a tooltip text for any accordion by moving the cursor over the accordion name. The tooltip text gives a summary of the accordion’s purpose.
*If you modify the policy action for a virtualized API which is already published to a Mediator gateway, CentraSite automatically republishes the modified virtualized API.
*If you want to enable the REST support for a Virtual SOAP-based API, ensure that the Enable REST Support action is included in the Receive stage for the API. For more information, see Exposing a Virtual SOAP API as Virtual REST API
If you include the Enable REST Support policy action in a SOAP API configuration, clients who can only send REST requests can now invoke a REST-enabled SOAP API using both a SOAP request and a REST request in Mediator, and using a REST request in API-Portal.
*If you are using Mediator as your gateway, you must include at least one Evaluate * action in order to identify or validate the consumers. For common usage cases of identification and validation actions, see Usage Cases for Identifying/Authenticating Clients.
For information about the individual run-time actions that are supported out-of-the-box, see Built-In Run-Time Actions Reference for APIs.
*Be aware that actions from the WS-I category cannot be combined with other types of actions. Also be aware that when you add a WS-I action to the action list, CentraSite will automatically add dependent actions to the list as necessary.
*When you configure certain policy actions, for example, a Context Based Routing action, a Throttling Traffic Optimization action, or a Monitor Service Level Agreement (SLA) action, the action's Configure dialog would exhibit the following behavior:
*If the API provider has configured the API Key Consumption Settings for API key and/or OAuth2 token authentication, the Consumer Applications drop-down lists all of the consumer applications that are identified by asset instances of the API-Key and/or OAuth2 Client type and are linked to the API, and all of the consumer applications that are identified by asset instances of the type Application in the CentraSite registry.
*If the API provider has not configured the API Key Consumption Settings for API key and/or OAuth2 token authentication, the Consumer Applications drop-down lists all of the consumer applications that are identified by asset instances of the type Application in the CentraSite registry.
Copyright © 2005-2016 Software AG, Darmstadt, Germany.

Product LogoContact Support   |   Community   |   Feedback