|
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.socket.CallbackSocketDriver
public class CallbackSocketDriver
One instance of this for each client to send him callback.
This is sort of a dummy needed by the plugin framework which assumed for CORBA/RMI/XMLRPC a separate callback connection
Field Summary | |
---|---|
private CallbackAddress |
callbackAddress
|
private Global |
glob
|
private SocketExecutor |
handler
|
private static java.util.logging.Logger |
log
|
private java.lang.String |
loginName
|
private java.lang.String |
ME
|
private java.lang.String |
msgInfoParserClassName
|
private PluginInfo |
pluginInfo
|
private boolean |
useUdpForOneway
|
Constructor Summary | |
---|---|
CallbackSocketDriver()
Should not be instantiated by plugin loader. |
|
CallbackSocketDriver(java.lang.String loginName)
This constructor is called when the callback shall be delivered by a separate SOCKET connection which we open here (in initialize()) |
|
CallbackSocketDriver(java.lang.String loginName,
SocketExecutor handler)
This constructor is called when 1.on server side when the client arrives in HandleClient 2.the callback shall be tunneled through by the SAME SOCKET connection which the client already has established. |
Method Summary | |
---|---|
CallbackAddress |
getCallbackAddress()
|
SocketExecutor |
getHandler()
|
java.lang.String |
getMsgInfoParserClassName()
Which parser to use. |
java.lang.String |
getName()
Get a human readable name of this driver |
PluginInfo |
getPluginInfo()
|
(package private) I_ProgressListener |
getProgressListener()
|
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 |
getVersion()
Enforced by I_Plugin |
void |
init(Global glob,
CallbackAddress callbackAddress)
Intialize the driver. |
void |
init(Global glob,
PluginInfo pluginInfo)
This method is called by the PluginManager (enforced by I_Plugin). |
boolean |
isAlive()
|
java.lang.String |
ping(java.lang.String qos)
Ping to check if callback server is alive. |
I_ProgressListener |
registerProgressListener(I_ProgressListener listener)
Register a listener for to receive information about the progress of incoming data. |
java.lang.String[] |
sendUpdate(MsgUnitRaw[] msgArr)
This sends the update to the client. |
void |
sendUpdateOneway(MsgUnitRaw[] msgArr)
The oneway variant, without return value. |
void |
shutdown()
I_Plugin.shutdown() |
private void |
shutdown(boolean delayed)
|
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 static java.util.logging.Logger log
private java.lang.String loginName
private SocketExecutor handler
private CallbackAddress callbackAddress
private PluginInfo pluginInfo
private java.lang.String msgInfoParserClassName
private boolean useUdpForOneway
Constructor Detail |
---|
public CallbackSocketDriver()
public CallbackSocketDriver(java.lang.String loginName, SocketExecutor handler)
public CallbackSocketDriver(java.lang.String loginName)
Method Detail |
---|
public java.lang.String getName()
I_CallbackDriver
getName
in interface I_CallbackDriver
public java.lang.String getProtocolId()
getProtocolId
in interface I_CallbackDriver
public java.lang.String getType()
getType
in interface I_Plugin
public java.lang.String getVersion()
getVersion
in interface I_Plugin
public void init(Global glob, PluginInfo pluginInfo)
init
in interface I_Plugin
I_Plugin.init(org.xmlBlaster.util.Global,org.xmlBlaster.util.plugin.PluginInfo)
public java.lang.String getRawAddress()
getRawAddress
in interface I_CallbackDriver
public void init(Global glob, CallbackAddress callbackAddress) throws XmlBlasterException
I_CallbackDriver
init
in interface I_CallbackDriver
callbackAddress
- Contains the callback address,
e.g. the stringified CORBA callback handle of the client or his email address.
XmlBlasterException
public final java.lang.String[] sendUpdate(MsgUnitRaw[] msgArr) throws XmlBlasterException
sendUpdate
in interface I_CallbackDriver
msgArr
- Array of all messages to send, is guaranteed to never be null
<qos> <state id='OK'/> <!-- Client processing state OK | ERROR ... see Constants.java --> </qos>
e.id="CallbackFailed",
- should be caught and handled appropriate
XmlBlasterException
public void sendUpdateOneway(MsgUnitRaw[] msgArr) throws XmlBlasterException
sendUpdateOneway
in interface I_CallbackDriver
msgArr
- Array of all messages to send, is guaranteed to never be null
XmlBlasterException
- Is never from the client (oneway).public final java.lang.String ping(java.lang.String qos) throws XmlBlasterException
ping
in interface I_CallbackDriver
qos
- Currently an empty string ""
XmlBlasterException
- If client not reachableorg.xmlBlaster.protocol.I_XmlBlaster#ping(String)
public I_ProgressListener registerProgressListener(I_ProgressListener listener)
I_CallbackDriver
registerProgressListener
in interface I_CallbackDriver
listener
- Your listener, pass 0 to unregister.
final I_ProgressListener getProgressListener()
public void shutdown()
I_Plugin.shutdown()
shutdown
in interface I_Plugin
private void shutdown(boolean delayed)
public boolean isAlive()
isAlive
in interface I_CallbackDriver
public PluginInfo getPluginInfo()
public CallbackAddress getCallbackAddress()
public java.lang.String getMsgInfoParserClassName()
public SocketExecutor getHandler()
|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |