ServerHook (TIBCO Software, Inc.)

java.lang.Object
- com.datasynapse.gridserver.server.ServerHook

```
public abstract class ServerHook
extends java.lang.Object
```
The ServerHook class can be implemented to "hook" into the Manager's event processing mechanism. Hooks are added and managed in the Gridserver Administration Tool using the Hook Admin page.
The class definition for the hook must be contained in a JAR file in the appropriate hook directory (WEB-INF/hooks/Broker or WEB-INF/hooks/Director).
A hook may have bean properties (such as set[Property] and get[Property] methods) which allow for setting of properties in the hooks.xml file.
The hook will receive any defined event as it occurs. Depending on if it is registered as a Broker or Director hook, it will receive a different subset of the available Server Events. See ServerEvent for a complete list of Events and if they are Broker- or Director-specific.
The ServerHookManager posts predefined events to all hooks, in order using a single thread. The thread is independent of the Manager, so that hooks do not interfere with the Manager. A maximum amount of events is set in the Manager, to handle the case in which the hook event processing is slower than event posting on the Manager. In this case, an error is logged and the event is discarded.

Constructor Summary

Constructors
Constructor and Description

ServerHook()

Constructors
Constructor and Description
`ServerHook()`

Method Summary

Methods
Modifier and Type	Method and Description
`abstract void`	`destroy()` Called when the hook is removed or changed.
`protected void`	`enabledSet(boolean enabled)` This method is called whenever the `Enabled` property is set, including at startup.
`java.lang.String`	`getDescription()` Gets the description of this hook.
`boolean`	`getEnabled()` Gets whether the hook is enabled.
`java.lang.String`	`getName()` Gets the name of this hook.
`abstract void`	`handleEvent(ServerEvent ev)` User-implemented event handler.
`abstract void`	`init()` Called when the hook is added (when the Manager starts, or if added or changed from the Hook Editor).
`void`	`setDescription(java.lang.String description)` Sets the description of this hook.
`void`	`setEnabled(boolean enabled)` Sets whether the hook is enabled.
`void`	`setName(java.lang.String name)` Sets the name of this hook.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ServerHook
```
public ServerHook()
```
- Method Detail
  - init
```
public abstract void init()
```
    Called when the hook is added (when the Manager starts, or if added or changed from the Hook Editor). Called whether or not enabled.
  - destroy
```
public abstract void destroy()
```
    Called when the hook is removed or changed. Called whether or not enabled.
  - handleEvent
```
public abstract void handleEvent(ServerEvent ev)
```
    User-implemented event handler.
    
    Parameters:
    ev - the event that was received
  - enabledSet
```
protected void enabledSet(boolean enabled)
```
    This method is called whenever the Enabled property is set, including at startup. You can override this method to change the Hook behavior when the propery is changed, that is, to implement your own enable/disable procedures. Note that you must use the enabled parameter rather than getEnabled(), as this method will be called prior to setting the enabled value for this hook. This is in case your method throws an unchecked Exception or Error, in which case the enabled value will not change.
    
    Parameters:
    enabled - The enabled property value.
  - getName
```
public java.lang.String getName()
```
    Gets the name of this hook.
    
    Returns:
    the name which will be shown on the Hook Admin page
  - setName
```
public void setName(java.lang.String name)
```
    Sets the name of this hook.
    
    Parameters:
    name - the name which will be shown on the Hook Admin page
  - getDescription
```
public java.lang.String getDescription()
```
    Gets the description of this hook.
    
    Returns:
    the description which will be shown on the Hook Admin page
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Sets the description of this hook.
    
    Parameters:
    description - the description which will be shown on the Hook Admin page
  - setEnabled
```
public final void setEnabled(boolean enabled)
```
    Sets whether the hook is enabled. If not, the hook will not receive events. It will also call enabledSet, so that user-defined enable/disbale procecures will be executed.
    
    Parameters:
    enabled - Whether the hook is enabled, true by default
  - getEnabled
```
public final boolean getEnabled()
```
    Gets whether the hook is enabled.
    
    Returns:
    Whether the hook is enabled, false by default

Class ServerHook

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServerHook

Method Detail

init

destroy

handleEvent

enabledSet

getName

setName

getDescription

setDescription

setEnabled

getEnabled