org.xmlBlaster.contrib.socketgetter
Class SocketGetterPlugin

java.lang.Object
  org.xmlBlaster.contrib.GlobalInfo
      org.xmlBlaster.contrib.socketgetter.SocketGetterPlugin

All Implemented Interfaces:

I_Info, org.xmlBlaster.util.plugin.I_Plugin

public class SocketGetterPlugin
extends GlobalInfo

SocketGetterPlugin is a plugin wrapper if you want to run SocketGetter inside xmlBlaster.
The configuration of this plugin in the xmlBlasterPlugins.xml may look like:

  <plugin id='SocketGetter' className='org.xmlBlaster.contrib.socketgetter.SocketGetterPlugin'>
     <action do='LOAD' onStartupRunlevel='9' sequence='9' onFail='resource.configuration.pluginFailed'/>
     <action do='STOP' onShutdownRunlevel='6' sequence='1'/>
 
     <attribute id='port'>9876</attribute>
  </plugin>
 

Author:

Heinrich Götzger

See Also:

SocketGetter

Field Summary

Fields inherited from class org.xmlBlaster.contrib.GlobalInfo

global, LOWER_CASE, ORIGINAL_ENGINE_GLOBAL, pluginInfo, UNTOUCHED, UPPER_CASE

Fields inherited from interface org.xmlBlaster.contrib.I_Info

ID, JMX_PREFIX

Constructor Summary

SocketGetterPlugin()
Default constructor, you need to call doInit() thereafter.

Method Summary

protected void	doInit(org.xmlBlaster.util.Global global_, org.xmlBlaster.util.plugin.PluginInfo pluginInfo)
void	shutdown() Cleans up the resource.

Methods inherited from class org.xmlBlaster.contrib.GlobalInfo

dump, get, getBoolean, getGlobal, getInt, getKeys, getLong, getObject, getObjectKeys, getOriginalGlobal, getRaw, getStrippedString, getType, getVersion, init, loadPlugin, put, putObject, putRaw, replaceAllEntries, setStrippedHostname

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SocketGetterPlugin

public SocketGetterPlugin()

Default constructor, you need to call doInit() thereafter.

See Also:

doInit(Global, PluginInfo)

Method Detail

doInit

protected void doInit(org.xmlBlaster.util.Global global_,
                      org.xmlBlaster.util.plugin.PluginInfo pluginInfo)
               throws org.xmlBlaster.util.XmlBlasterException

Specified by:

doInit in class GlobalInfo

Parameters:

global_ - The global passed by the RunLevelManager, this is not the object owned by the plugin. It is the original global.

Throws:

org.xmlBlaster.util.XmlBlasterException

See Also:

I_Plugin.init(org.xmlBlaster.util.Global, org.xmlBlaster.util.plugin.PluginInfo)

shutdown

public void shutdown()
              throws org.xmlBlaster.util.XmlBlasterException

Description copied from interface: org.xmlBlaster.util.plugin.I_Plugin

Cleans up the resource.

Specified by:

shutdown in interface org.xmlBlaster.util.plugin.I_Plugin

Overrides:

shutdown in class GlobalInfo

Throws:

org.xmlBlaster.util.XmlBlasterException - if an exception occurs. The exception is handled by the RunLevelManager depending on how the plugin has been configured with the action:

<action do='STOP' onShutdownRunlevel='2' sequence='5' onFail='resource.configuration.pluginFailed'> If onFail is defined to something, the RunLevelManager will stop.

See Also:

I_Plugin.shutdown()