Router service The OpenIDM router service provides the uniform interface to all objects in OpenIDM: managed objects, system objects, configuration objects, and so on.

The router object as shown in conf/router.json defines an array of filter objects. { "filters": [ filter object, ... ] } The required filters array defines a list of filters to be processed on each router request. Filters are processed in the order they are specified in this array.

Filter objects are defined as follows. { "pattern": string, "methods": [ string, ... ], "condition": script object, "onRequest": script object, "onResponse": script object, "onFailure": script object } "pattern" string, optional Specifies a regular expression pattern matching the JSON pointer of the object to trigger scripts. If not specified, all identifiers (including null) match. "methods" array of strings, optional One or more methods for which the script(s) should be triggered. Supported methods are: "create", "read", "update", "delete", "patch", "query", "action". If not specified, then all methods are matched. "condition" script object, optional Specifies a script that is called first to determine if the script should be triggered. If the condition yields "true", then the other script(s) are executed. If not specified, the script(s) are called unconditionally. "onRequest" script object, optional Specifies a script to execute before the request is dispatched to the resource. If the script throws an exception, the method is is not performed, and a client error response is provided. "onResponse" script object, optional Specifies a script to execute after the request is successfully dispatched to the resource and a response is returned. Throwing an exception from this script does not undo the method already performed. "onFailure" script object, optional Specifies a script to execute if the request resulted in an exception being thrown. Throwing an exception from this script does not undo the method already performed.

Scripts are provided with the following scope. { "openidm": openidm-functions object, "request": resource-request object, "response": resource-response object, "exception": exception object } "openidm" openidm-functions object Provides access to OpenIDM resources. "request" resource-request object The resource-request context, which has one or more parent context. Provided in scope of "condition", "onRequest", "onResponse" and "onException" scripts. "response" openidm-functions object The response to the resource-request. Only provided in the scope of the "onResponse" script. "exception" exception object The exception value that was thrown as a result of processing the request. Only provided in the scope of the "onException" script. An exception object is defined as follows. { "error": integer, "reason": string, "detail": string } "error" integer The numeric code of the exception. "reason" string The short reason phrase of the exception. "detail" string The detailed message for the exception.

The following example executes a script after a managed user object is created or updated. { "filters": [ { "pattern": "^managed/user/.*", "methods": [ "create", "update" ], "onResponse": { "type": "text/javascript", "file": "scripts/afterUpdateUser.js" } } ] }