|
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.protocol.xmlrpc.XmlRpcDriver
public class XmlRpcDriver
XmlRpc driver class to invoke the xmlBlaster server over HTTP XMLRPC.
This driver needs to be registered in xmlBlaster.properties and will be started on xmlBlaster startup, for example:ProtocolPlugin[XMLRPC][1.0]=org.xmlBlaster.protocol.xmlrpc.XmlRpcDriver CbProtocolPlugin[XMLRPC][1.0]=org.xmlBlaster.protocol.xmlrpc.CallbackXmlRpcDriverThe variable plugin/xmlrpc/port (default 8080) sets the http web server port, you may change it in xmlBlaster.properties or on command line:
java -jar lib/xmlBlaster.jar -plugin/xmlrpc/port 9080The interface I_Driver is needed by xmlBlaster to instantiate and shutdown this driver implementation.
Field Summary | |
---|---|
private AddressServer |
addressServer
Our configuration |
private I_Authenticate |
authenticate
The singleton handle for this xmlBlaster server |
protected ContextNode |
contextNode
|
static int |
DEFAULT_HTTP_PORT
|
private Global |
glob
|
protected boolean |
isActive
|
private static java.util.logging.Logger |
log
|
protected java.lang.Object |
mbeanHandle
My JMX registration, can be done optionally by implementing classes |
private java.lang.String |
ME
|
private PluginInfo |
pluginInfo
|
private org.apache.xmlrpc.webserver.WebServer |
webServer
The xml-rpc HTTP web server |
private I_XmlBlaster |
xmlBlasterImpl
The singleton handle for this xmlBlaster server |
private XmlRpcUrl |
xmlRpcUrl
The URL which clients need to use to access this server |
Constructor Summary | |
---|---|
XmlRpcDriver()
|
Method Summary | |
---|---|
void |
activate()
Activate xmlBlaster access through this protocol. |
void |
deActivate()
Deactivate xmlBlaster access (standby), no clients can connect. |
AddressServer |
getAddressServer()
The server configuration of this plugin |
java.lang.String |
getEnvPrefix()
|
java.lang.String |
getName()
Get a human readable name of this driver. |
java.lang.String |
getProtocolId()
Access the xmlBlaster internal name of the protocol driver. |
java.lang.String |
getRawAddress()
Get the address how to access this driver. |
java.lang.String |
getType()
Enforced by I_Plugin |
java.lang.String |
getUsageUrl()
|
java.lang.String |
getVersion()
Enforced by I_Plugin |
private void |
init(Global glob,
AddressServer addressServer,
I_Authenticate authenticate,
I_XmlBlaster xmlBlasterImpl)
Start xmlBlaster XMLRPC access. |
void |
init(Global glob,
PluginInfo pluginInfo)
This method is called by the PluginManager (enforced by I_Plugin). |
boolean |
isActive()
JMX |
boolean |
isShutdown()
JMX |
void |
setUsageUrl(java.lang.String url)
|
void |
shutdown()
Instructs XMLRPC driver to shut down. |
java.lang.String |
usage()
Command line usage. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private java.lang.String ME
private Global glob
private PluginInfo pluginInfo
private static java.util.logging.Logger log
private I_Authenticate authenticate
private I_XmlBlaster xmlBlasterImpl
public static final int DEFAULT_HTTP_PORT
private org.apache.xmlrpc.webserver.WebServer webServer
private XmlRpcUrl xmlRpcUrl
private AddressServer addressServer
protected java.lang.Object mbeanHandle
protected ContextNode contextNode
protected boolean isActive
Constructor Detail |
---|
public XmlRpcDriver()
Method Detail |
---|
public java.lang.String getName()
getName
in interface I_Driver
public java.lang.String getProtocolId()
getProtocolId
in interface I_Driver
public java.lang.String getType()
getType
in interface I_AdminPlugin
getType
in interface I_Plugin
public java.lang.String getVersion()
getVersion
in interface I_AdminPlugin
getVersion
in interface I_Plugin
public void init(Global glob, PluginInfo pluginInfo) throws XmlBlasterException
init
in interface I_Plugin
XmlBlasterException
I_Plugin.init(org.xmlBlaster.util.Global,org.xmlBlaster.util.plugin.PluginInfo)
public java.lang.String getRawAddress()
getRawAddress
in interface I_Driver
getRawAddress
in interface XmlRpcDriverMBean
private void init(Global glob, AddressServer addressServer, I_Authenticate authenticate, I_XmlBlaster xmlBlasterImpl) throws XmlBlasterException
glob
- Global handle to access logging, property and commandline argsauthenticate
- Handle to access authentication serverxmlBlasterImpl
- Handle to access xmlBlaster core
XmlBlasterException
public AddressServer getAddressServer()
public void activate() throws XmlBlasterException
activate
in interface I_Driver
activate
in interface I_AdminService
XmlBlasterException
public void deActivate()
deActivate
in interface I_Driver
deActivate
in interface I_AdminService
public void shutdown() throws XmlBlasterException
shutdown
in interface I_AdminPlugin
shutdown
in interface I_Plugin
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.public java.lang.String getEnvPrefix()
public java.lang.String usage()
usage
in interface I_Driver
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 boolean isActive()
isActive
in interface I_AdminService
I_AdminService.isActive()
public boolean isShutdown()
isShutdown
in interface I_AdminPlugin
I_AdminPlugin.isShutdown()
|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |