|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.xmlBlaster.engine.runlevel.PluginConfig
public class PluginConfig
This class contains the information on how to configure a certain pluginand when a certain plugin is invoked by the run level manager
<plugin id='storage:CACHE' className='org.xmlBlaster.engine.msgstore.cache.PersistenceCachePlugin'> <attribute id='transientQueue'>storage:RAM</attribute> <attribute id='persistentQueue'>storage:JDBC</attribute> </plugin>
Field Summary | |
---|---|
private java.util.Vector |
actions
|
private java.util.Properties |
attributes
the properties for the plugin |
private java.lang.String |
className
the complete class name for the plugin to be loaded |
private ContextNode |
contextNode
|
private boolean |
create
Shall this plugin be instantiated? |
static boolean |
DEFAULT_CREATE
|
private RunLevelAction |
downAction
stores the action for the down going run level (if none it will be null) |
private Global |
glob
|
private java.lang.String |
id
the id specifying a given plugin configuration |
private java.lang.String |
jarPath
the coloumn separated list of jar files on which to look for the class |
private static java.util.logging.Logger |
log
|
private JmxMBeanHandle |
mbeanHandle
My JMX registration |
(package private) Timestamp |
uniqueTimestamp
timestamp used to get uniquity (since runlevel + sequeuence is not unique) |
private RunLevelAction |
upAction
stores the action for the upgoing run level (if none it will be null) |
private java.util.HashSet |
wrappedAttributes
|
Constructor Summary | |
---|---|
PluginConfig(Global glob)
Really minimal constructor |
|
PluginConfig(Global glob,
java.lang.String id,
boolean create,
java.lang.String className)
Minimal constructor |
|
PluginConfig(Global glob,
java.lang.String id,
boolean create,
java.lang.String className,
java.util.Properties attributes)
Construtor where we can define attributes (no need to define actions) |
|
PluginConfig(Global glob,
java.lang.String id,
boolean create,
java.lang.String className,
java.lang.String jar,
java.util.Properties attributes,
java.util.Vector actions)
This constructor takes all parameters needed |
Method Summary | |
---|---|
void |
addAction(RunLevelAction action)
|
void |
addAttribute(java.lang.String key,
java.lang.String value)
|
void |
addAttribute(java.lang.String key,
java.lang.String value,
boolean replacePlaceHolder)
|
RunLevelAction[] |
getActions()
|
java.lang.String |
getClassName()
|
RunLevelAction |
getDownAction()
|
java.lang.String |
getId()
|
PluginInfo |
getPluginInfo()
returns the PluginInfo object out of this configuration |
RunLevelAction |
getUpAction()
|
java.lang.String |
getUsageUrl()
|
boolean |
isCreate()
Shall the plugin be created? |
void |
registerMBean()
|
void |
setClassName(java.lang.String className)
|
void |
setCreate(boolean create)
Shall the plugin be created? Called from JMX (jconsole) |
void |
setCreateInternal(boolean create)
Shall the plugin be created? Called from SAX parser |
void |
setId(java.lang.String id)
|
void |
setJar(java.lang.String jar)
|
void |
setUsageUrl(java.lang.String url)
|
void |
shutdown()
|
java.lang.String |
toString()
|
java.lang.String |
toXml()
|
java.lang.String |
toXml(java.lang.String extraOffset)
returns an xml litteral string representing this object. |
void |
unwrapAttributeFromCDATA(java.lang.String attributeKey)
When the attribute is written to a string in the toXml methods it is wrapped inside a CDATA. |
java.lang.String |
usage()
|
void |
wrapAttributeInCDATA(java.lang.String attributeKey)
When the attribute is written to a string in the toXml methods it is wrapped inside a CDATA in case you pass 'true' here. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private final Global glob
private static java.util.logging.Logger log
private java.lang.String id
private java.lang.String className
public static boolean DEFAULT_CREATE
private boolean create
private java.lang.String jarPath
private java.util.Vector actions
private RunLevelAction upAction
private RunLevelAction downAction
private java.util.Properties attributes
private java.util.HashSet wrappedAttributes
Timestamp uniqueTimestamp
private JmxMBeanHandle mbeanHandle
private ContextNode contextNode
Constructor Detail |
---|
public PluginConfig(Global glob, java.lang.String id, boolean create, java.lang.String className, java.lang.String jar, java.util.Properties attributes, java.util.Vector actions)
public PluginConfig(Global glob, java.lang.String id, boolean create, java.lang.String className, java.util.Properties attributes)
public PluginConfig(Global glob, java.lang.String id, boolean create, java.lang.String className)
public PluginConfig(Global glob)
Method Detail |
---|
public java.lang.String getId()
public boolean isCreate()
isCreate
in interface PluginConfigMBean
public void setCreate(boolean create)
setCreate
in interface PluginConfigMBean
create
- true/falsepublic void setCreateInternal(boolean create)
create
- true/falsepublic java.lang.String getClassName()
public void addAction(RunLevelAction action)
public RunLevelAction getUpAction()
public RunLevelAction getDownAction()
public void addAttribute(java.lang.String key, java.lang.String value)
addAttribute
in interface I_AttributeUser
value
- ${xy} are replaced since xmlBlaster v2.2public void addAttribute(java.lang.String key, java.lang.String value, boolean replacePlaceHolder)
addAttribute
in interface I_AttributeUser
replacePlaceHolder
- if true ${xy} are replacedpublic RunLevelAction[] getActions()
public void setId(java.lang.String id)
public void registerMBean()
public void shutdown()
public void setClassName(java.lang.String className)
public void setJar(java.lang.String jar)
public PluginInfo getPluginInfo()
public void wrapAttributeInCDATA(java.lang.String attributeKey)
wrapAttributeInCDATA
in interface I_AttributeUser
public void unwrapAttributeFromCDATA(java.lang.String attributeKey)
unwrapAttributeFromCDATA
in interface I_AttributeUser
public java.lang.String toXml(java.lang.String extraOffset)
public java.lang.String toXml()
public java.lang.String usage()
usage
in interface I_AdminUsage
public java.lang.String getUsageUrl()
getUsageUrl
in interface I_AdminUsage
public void setUsageUrl(java.lang.String url)
setUsageUrl
in interface I_AdminUsage
public java.lang.String toString()
toString
in class java.lang.Object
|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |