Manager Hooks

You can create Manager Hooks on the Broker or the Director. Depending on where the hook resides, it receives a different subset of the Server Events broadcast by the Manager. See the ServerEvents class JavaDoc for available events and the components for which they are relevant. For example, a hook that needs to see the addition or removal of an Engine must run on the Broker, because the ENGINE_ADDED and ENGINE_REMOVED events are Broker specific.

For details on Manager Hook implementation, see the JavaDoc documentation for the ServerHook class. After implementing a Manager Hook, contain its class definition in a JAR file in the shared classes directory (hooks/component, where component is either broker or director).

To register a Manager Hook in the GridServer Administration Tool, go to Admin > System Admin > Manager Hooks. The Hook Admin page enables you to edit, enable, or disable hooks on the Manager. To add a new hook, select Create New Hook from the Global Actions list. This opens a Hook Editor in a new window. Enter a filename for the hook XML file, and select whether to apply the hook to the Director or Broker. Enter the name of a class in the hooks directory and click Update Properties to display an updateable property list. After you enter properties, click Save to edit the hook or Cancel to revert to the last saved version of the hook.

From the Actions control of each hook, you can Enable, Disable, Edit, or Delete an existing hook. Note that you do not need to restart the Manager after deploying the JAR file. However, if you redeploy a JAR file, you must remove and re-add the hook for any new changes to take effect.