xmlBlaster 2.2.0 API

org.xmlBlaster.util.admin
Interface I_AdminPlugin

All Superinterfaces:
I_AdminUsage
All Known Subinterfaces:
CacheQueueInterceptorPluginMBean, CheckpointMBean, ClusterManagerMBean, CorbaDriverMBean, EmailDriverMBean, EmailExecutorMBean, EventPluginMBean, FilePollerPluginMBean, FileWatcherPluginMBean, I_AdminMap, I_AdminPop3Driver, I_AdminQueue, I_AdminService, I_Checkpoint, PersistenceCachePluginMBean, Pop3DriverMBean, RequestReplyExecutorMBean, SocketDriverMBean, SocketExecutorMBean, XbStompDriverMBean, XmlRpcDriverMBean
All Known Implementing Classes:
CacheQueueInterceptorPlugin, CallbackEmailDriver, Checkpoint, ClusterManager, CorbaDriver, EmailCallbackImpl, EmailConnection, EmailDriver, EmailExecutor, EventPlugin, FilePollerPlugin, FileWatcherPlugin, HandleClient, PersistenceCachePlugin, Pop3Driver, RequestReplyExecutor, SocketCallbackImpl, SocketCbConnection, SocketDriver, SocketExecutor, XbStompDriver, XmlRpcDriver

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

xmlBlaster 2.2.0 API

Copyright © 1999-2014 The xmlBlaster.org contributers.