The progress.data.PluginManager is a JavaScript class that provides class-level methods to create and manage custom JSDO plugins. A JSDO plugin is an object with functions that execute for any supported Data Object operation that you invoke on a client JSDO instance. You can define these functions for a given plugin to customize the default behavior of the associated operation.

To use a JSDO plugin for a Data Object operation you must complete the following tasks:

  • For an OpenEdge Data Object, annotate the ABL Business Entity that implements the operation to identify the name of the JSDO plugin with the operation in the Data Service Catalog.
  • Use the (class-level) methods of this class to add (register) a new JSDO plugin or modify an existing plugin for use by any client JSDO instance that invokes the operation on the server.

For more information on completing these tasks, see the descriptions of the methods of this class.

Currently, the only Data Object operation that supports JSDO plugins is the Read operation (fill( ) method), and the only supported plugin type is a MappingType plugin that allows you to customize both the operation request and the response returned from executing the operation on the server.

The JSDO also defines a single built-in MappingType plugin with the reserved name, "JFP". This built-in plugin supports client handling of requests for Read operations that recognize JSON Filter Pattern (JFP) input. For more information on JFP input and this built-in MappingType plugin, see the description of the fill( ) method. You can customize the default request handling in this built-in "JFP" plugin, as well as add a custom response handler to it. You can also register your own plugins that are based on this built-in plugin (or that are based on any custom plugin previously registered in the document context).

This class has no constructor, but provides class-level methods to manage plugin registration.

Methods

Table 1. progress.data.PluginManager class-level methods
Member Brief description (See also the reference entry)
addPlugin( ) method

Adds (registers) a JSDO plugin object with a specified name in the current document context that can be used with a supported Data Object operation invoked on a JSDO instance.
getPlugin( ) method

Returns a reference to the registered JSDO plugin object with the specified name.

Note

For more information on registering a new custom JSDO plugin or on customizing a previously registered JSDO plugin, as well as on specifying a JSDO plugin for use by a Data Object operation on the server, see the description of the addPlugin( ) method.

See also

fill( ) method