The plug-in adapter is the entry point of the plug-in to the Orchestrator server. The plug-in adapter serves as the datastore for the plugged-in technology in the Orchestrator server, creates the plug-in factory, and manages events that occur in the plugged-in technology.

To create a plug-in adapter, you create a Java class that implements the IPluginAdaptor interface.

The plug-in adapter class that you create manages the plug-in factory, events, and triggers in the plugged-in technology. The IPluginAdaptor interface provides methods that you use to perform these tasks.

The plug-in adapter performs the following principal roles.

Creates a factory

The most important role of the plug-in adapter is to load and unload one plug-in factory instance for every connection from Orchestrator to the plugged-in technology. The plug-in adapter class calls the IPluginAdaptor.createPluginFactory() method to create an instance of a class that implements the IPluginFactory interface.

Manages events

The plug-in adapter is the interface between the Orchestrator server and the plugged-in technology. The plug-in adapter manages the events that Orchestrator performs or watches for on the objects in the plugged-in technology. The adapter manages events through event publishers. Event publishers are instances of the IPluginEventPublisher interface that the adapter creates by calling the IPluginAdaptor.registerEventPublisher() method. Event publishers set triggers and gauges on objects in the plugged-in technology, to allow Orchestrator to launch defined actions if certain events occur on the object, or if the object's values pass certain thresholds. Similarly, you can define PluginTrigger and PluginWatcher instances that define events that Wait Event elements in long-running workflows await.

Sets the plug-in name

You provide a name for the plug-in in the vso.xml file. The plug-in adapter gets this name from the vso.xml file and publishes it in the Orchestrator client Inventory view.

Installs licenses

You can call methods to install any license files that the plugged-in technology requires in the adapter implement.

For full details of the IPluginAdaptor interface, all of its methods, and all of the other classes of the plug-in API, see Orchestrator Plug-In API Reference.