Skip to content

Axway-API-Management-Plus/Policy-Loop-custom-filter

Repository files navigation

Description

This filter allows you to loop on a Policy. There is actually 4 exit conditions:

  • The looping Policy returns 'false',
  • The loop condition expression returns 'false',
  • The maximum count of iteration has been reached,
  • The maximum loop iteration delay has expired.

API Management Version Compatibilty

This artefact was successfully tested for the following versions:

  • V7.4.0
  • V7.4.1
  • V7.5.3 SP1
  • V7.7
  • 7.7.0-20210830

Compile/Build

In build.gradle file, update dependencies location:

  • Set the variable apim_folder to you API-Gateway installation folder (e.g. opt/Axway/APIM/apigateway)
  • Set the variable ps_folder to you Policy-Studio installation folder (e.g. /opt/Axway/APIM/policystudio)
  • Set the variable filterbase_folder to the version Policy-Studio delivers (check for a folder ...studio/plugins/com.vordel.rcp.filterbase....)
gradlew build

Install

  • Copy the jar file in the API Gateway VORDEL_HOME/ext/lib and restart API Gateway instances
  • Add the jar file to Policy Studio Runtime Dependencies,
  • Import the custom filter set file (CircuitLoopTypeSet.xml) in Policystudio --> Import --> Import custom filters.

Usage

You can choose between while or do/while loop. Each of exit condition can be handled as success (filter returns true) or error (filter returns false). The loop condition is a selector expression (like the evaluate filter). Be aware the maximum loop iteration time is checked AFTER the child policy has returned, it WILL NOT stop the child process.

alt text

Bug and Caveats

Selector expressions used in configuration do not appear as requested attributes in policy studio (to be done)

Changelog

  • Added exit condition error configuration (correct the 'no iteration bug returning false').
  • Corrected recursive policy configuration.

Contributing

Please read Contributing.md for details on our code of conduct, and the process for submitting pull requests to us.

Team

alt text Axway Team

License

Apache License 2.0