|
JPF 0.10 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.java.plugin.Plugin
This is base for "home" class of plug-in runtime. Using this class,
plug-in code can get access to plug-in framework
(manager
,
registry
) which was loaded it.
It is also used by manager during plug-in life cycle management (activation
and deactivation).
Plug-in vendor may provide it's own implementation of this class if some
actions should be performed during plug-in activation/deactivation. When no
class specified, framework provides default "empty" implementation that does
nothing when plug-in started and stopped.
Field Summary | |
protected org.apache.commons.logging.Log |
log
Makes logging service available for descending classes. |
Constructor Summary | |
protected |
Plugin()
Constructor to be used by plug-in manager for plug-in instantiation. |
|
Plugin(PluginManager aManager,
PluginDescriptor descr)
Deprecated. Define no-arguments constructor instead of
this one if you need to run come code during class
instantiation. Not though that it is not recommended to put
any code within class constructor, use plug-in "lifecyle"
methods doStart() and doStop() for that
purposes. |
Method Summary | |
protected abstract void |
doStart()
This method will be called once during plug-in activation before any access to any code from this plug-in. |
protected abstract void |
doStop()
This method will be called once during plug-in deactivation. |
PluginDescriptor |
getDescriptor()
|
PluginManager |
getManager()
|
boolean |
isActive()
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected final org.apache.commons.logging.Log log
Constructor Detail |
protected Plugin()
Class.newInstance()
public Plugin(PluginManager aManager, PluginDescriptor descr)
no-arguments constructor
instead of
this one if you need to run come code during class
instantiation. Not though that it is not recommended to put
any code within class constructor, use plug-in "lifecyle"
methods doStart()
and doStop()
for that
purposes.
aManager
- manager, which controls this plug-indescr
- descriptor of this plug-inMethod Detail |
public final PluginDescriptor getDescriptor()
public final PluginManager getManager()
public final boolean isActive()
true
if this plug-in is in active stateprotected abstract void doStart() throws java.lang.Exception
java.lang.Exception
- if an error has occurred during plug-in start-upprotected abstract void doStop() throws java.lang.Exception
doStart()
method will be called again (but for another
instance of this class).
java.lang.Exception
- if an error has occurred during plug-in shutdownpublic java.lang.String toString()
Object.toString()
|
JPF 0.10 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |