|
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.util.plugin.PluginInfo
public class PluginInfo
Holds data about a plugin (immutable).
Field Summary | |
---|---|
private java.lang.String |
className
e.g. |
private Global |
glob
|
static java.lang.String |
KEY_CLASSPATH
The key into params for the classpath |
private static java.util.logging.Logger |
log
|
private java.lang.String |
ME
|
private java.util.Properties |
params
key/values from "org.xmlBlaster.protocol.soap.SoapDriver,classpath=xerces.jar:soap.jar,MAXSIZE=100" |
private java.lang.String |
propertyKey
e.g. |
private java.lang.String |
propertyName
e.g. |
private java.lang.String |
type
e.g. |
private java.lang.Object |
userData
|
private java.lang.String |
version
e.g. |
Constructor Summary | |
---|---|
PluginInfo(Global glob,
I_PluginManager manager,
java.lang.String typeVersion)
|
|
PluginInfo(Global glob,
I_PluginManager manager,
java.lang.String typeVersion,
ContextNode contextNode)
|
|
PluginInfo(Global glob,
I_PluginManager manager,
java.lang.String type,
java.lang.String version)
|
|
PluginInfo(Global glob,
I_PluginManager manager,
java.lang.String type,
java.lang.String version,
ContextNode contextNode)
From pluginEnvClass and instanceId we build a string to lookup the key in the environment e.g. |
|
PluginInfo(Global glob,
java.lang.String type,
java.lang.String className,
java.util.Properties params)
|
Method Summary | |
---|---|
java.lang.String |
dumpPluginParameters()
Dumps the parameters passed to the plugin. |
java.lang.String |
getClassName()
|
java.lang.String |
getId()
|
private java.lang.String[] |
getParameterArr()
|
java.util.Properties |
getParameters()
|
java.lang.String |
getPrefix()
Gets the prefix for the implementing plugin. |
java.lang.String |
getType()
|
java.lang.String |
getTypeVersion()
|
java.lang.Object |
getUserData()
|
java.lang.String |
getVersion()
|
boolean |
ignorePlugin()
Check if the plugin is marked with "undef", such configurations are not loaded |
private void |
init(Global glob,
I_PluginManager manager,
java.lang.String type_,
java.lang.String version_,
ContextNode contextNode)
see javadoc of constructor |
private void |
parsePropertyValue(java.lang.String rawString)
|
void |
setUserData(java.lang.Object userData)
Use this setUserData() / getUserData() pair to transport some user specific data to postInitialize() if needed |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private Global glob
private static java.util.logging.Logger log
private java.lang.String ME
private java.lang.String propertyName
private java.lang.String propertyKey
private java.lang.String type
private java.lang.String version
private java.lang.String className
public static java.lang.String KEY_CLASSPATH
private java.util.Properties params
private java.lang.Object userData
Constructor Detail |
---|
public PluginInfo(Global glob, java.lang.String type, java.lang.String className, java.util.Properties params)
public PluginInfo(Global glob, I_PluginManager manager, java.lang.String typeVersion) throws XmlBlasterException
manager
- can be null if you only want to parse typeVersiontypeVersion
- null: Choose default plugin pluginManager.getDefaultPluginName() XmlBlasterException
public PluginInfo(Global glob, I_PluginManager manager, java.lang.String typeVersion, ContextNode contextNode) throws XmlBlasterException
manager
- can be null if you only want to parse typeVersiontypeVersion
- null: Choose default plugin pluginManager.getDefaultPluginName() XmlBlasterException
public PluginInfo(Global glob, I_PluginManager manager, java.lang.String type, java.lang.String version, ContextNode contextNode) throws XmlBlasterException
manager
- can be null if you only wanted to parse typeVersiontype
- null: Choose default plugin pluginManager.getDefaultPluginName() pluginEnvClass
- The classname for environment lookup e.g. "queue" or "persistence"instanceId
- The instance name of the plugin e.g. "history" or "topicStore"
XmlBlasterException
public PluginInfo(Global glob, I_PluginManager manager, java.lang.String type, java.lang.String version) throws XmlBlasterException
type
- null: Choose default plugin pluginManager.getDefaultPluginName() XmlBlasterException
Method Detail |
---|
public java.lang.String getId()
public void setUserData(java.lang.Object userData)
public java.lang.Object getUserData()
private void init(Global glob, I_PluginManager manager, java.lang.String type_, java.lang.String version_, ContextNode contextNode) throws XmlBlasterException
XmlBlasterException
private void parsePropertyValue(java.lang.String rawString) throws XmlBlasterException
rawString
- e.g. "org.xmlBlaster.protocol.soap.SoapDriver,classpath=xerces.jar:soap.jar,MAXSIZE=100"
XmlBlasterException
public boolean ignorePlugin()
public java.lang.String getClassName()
public java.util.Properties getParameters()
getParameters
in interface I_PluginConfig
private java.lang.String[] getParameterArr()
public java.lang.String getType()
getType
in interface I_PluginConfig
public java.lang.String getVersion()
getVersion
in interface I_PluginConfig
public java.lang.String getTypeVersion()
public java.lang.String dumpPluginParameters()
QueuePlugin[CACHE][1.0]=org.xmlBlaster.util.queue.cache.CacheQueueInterceptorPlugin,\ persistentQueue=JDBC,\ transientQueue=RAMIt will be returnes as a string:
org.xmlBlaster.util.queue.cache.CacheQueueInterceptorPlugin,persistentQueue=JDBC,transientQueue=RAMThis method can be used to partially change a plugin property like in the following example:
PluginInfo pluginInfo = new PluginInfo(glob, glob.getQueuePluginManager(), "JDBC", "1.0"); Properties p = pluginInfo.getParameters(); p.setProperty("tablePrefix", "test_"); glob.getProperty().set("QueuePlugin[JDBC][1.0]", pluginInfo.dumpPluginParameters());
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getPrefix()
I_PluginConfig
getPrefix
in interface I_PluginConfig
|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |