|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.scooterframework.admin.Plugin
public abstract class Plugin
Plugin class has methods to manage a plug-in. Scooter framework will call these methods. Plug-in implementation classes should implement these methods if they want framework to manage their life cycles.
Field Summary | |
---|---|
static java.lang.String |
KEY_PLUGIN_CLASS_NAME
Key to represent plugin class name property. |
static java.lang.String |
KEY_PLUGIN_NAME
Key to represent plugin name property. |
protected LogUtil |
log
|
Constructor Summary | |
---|---|
protected |
Plugin(java.util.Properties p)
|
Method Summary | |
---|---|
java.lang.String |
getName()
Returns the plugin name |
java.lang.String |
getPluginClassName()
Returns the plugin class name |
java.util.Properties |
getProperties()
Returns the properties of the plugin. |
java.lang.String |
getProperty(java.lang.String name)
Returns property value. |
java.lang.String |
getProperty(java.lang.String name,
java.lang.String defaultValue)
Returns property value. |
java.lang.String |
getVersion()
Returns the plugin version |
boolean |
isAlive()
Returns status of the plugin. |
void |
onStart()
Do something when the plugin is started. |
void |
onStop()
Do something when the plugin is stopped. |
java.lang.String |
toString()
Returns a string representation of the plugin. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected LogUtil log
public static final java.lang.String KEY_PLUGIN_NAME
public static final java.lang.String KEY_PLUGIN_CLASS_NAME
Constructor Detail |
---|
protected Plugin(java.util.Properties p)
Method Detail |
---|
public void onStart()
public void onStop()
public boolean isAlive()
public java.lang.String getName()
public java.lang.String getVersion()
public java.lang.String getPluginClassName()
public java.util.Properties getProperties()
public java.lang.String getProperty(java.lang.String name)
name
- property name
public java.lang.String getProperty(java.lang.String name, java.lang.String defaultValue)
name
- property namedefaultValue
- default value related to the property name
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |