org.xmlBlaster.util.admin
Interface I_AdminPlugin

All Superinterfaces:

I_AdminUsage

All Known Subinterfaces:

CacheQueueInterceptorPluginMBean, CheckpointMBean, EmailExecutorMBean, FilePollerPluginMBean, I_AdminMap, I_AdminPop3Driver, I_AdminQueue, I_AdminService, I_Checkpoint, Pop3DriverMBean, RequestReplyExecutorMBean, SocketExecutorMBean

All Known Implementing Classes:

CacheQueueInterceptorPlugin, Checkpoint, EmailCallbackImpl, EmailConnection, EmailExecutor, FilePollerPlugin, Pop3Driver, RequestReplyExecutor, SocketCallbackImpl, SocketExecutor

public interface I_AdminPlugin
extends I_AdminUsage

Declares available methods to control arbitrary plugins.

Since:

1.0.8

Author:

xmlBlaster@marcelruff.info

Method Summary

java.lang.String	getType() The unique name of the plugin (together with the version).
java.lang.String	getVersion() The version of the plugin
boolean	isShutdown() Check status
void	shutdown() Shutdown the plugin, free resources.

Methods inherited from interface org.xmlBlaster.util.admin.I_AdminUsage

getUsageUrl, setUsageUrl, usage

Method Detail

getType

java.lang.String getType()

The unique name of the plugin (together with the version).

Returns:

For example "IOR"

getVersion

java.lang.String getVersion()

The version of the plugin

Returns:

For example "1.0"

shutdown

void shutdown()
              throws java.lang.Exception

Shutdown the plugin, free resources.

Throws:

java.lang.Exception

isShutdown

boolean isShutdown()

Check status

Returns:

true if down