|
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.protocol.RequestReplyExecutor org.xmlBlaster.util.protocol.email.EmailExecutor org.xmlBlaster.protocol.email.CallbackEmailDriver
public class CallbackEmailDriver
Sends a MsgUnitRaw back to a client using Email.
Activate the email callback driver in xmlBlaster.properies first, for example:
CbProtocolPlugin[email][1.0]=\ org.xmlBlaster.protocol.email.CallbackEmailDriver,\ mail.smtp.bcc=sniffer@localhost,\ inlineExtension=*,\ compress/minSize=200,\ compress/type=zlib,\ mail.subject=XmlBlaster generated mail,\ parserClass=org.xmlBlaster.util.xbformat.XmlScriptParserThe parserClass is optional, the default message serialization is XbfParser.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.xmlBlaster.util.protocol.email.EmailExecutor |
---|
EmailExecutor.LoopProtection |
Field Summary | |
---|---|
private CallbackAddress |
callbackAddress
|
private static java.util.logging.Logger |
log
|
private java.lang.String |
ME
|
private PluginInfo |
pluginInfo
|
Fields inherited from class org.xmlBlaster.util.protocol.email.EmailExecutor |
---|
bcc, BOUNCE_MAILFROM_KEY, BOUNCE_MAILTO_KEY, BOUNCE_MESSAGEID_KEY, cc, fromAddress, messageIdFileName, msgInfoParserClassName, payloadFileNamePrefix, pop3Driver, senderLoopProtectionMap, smtpClient, SUBJECT_MESSAGEID_TOKEN, subjectTemplate, toAddress |
Fields inherited from class org.xmlBlaster.util.protocol.RequestReplyExecutor |
---|
addressConfig, addressServer, cbClient, compressZlib, compressZlibStream, contextNode, glob, mbeanHandle, minSizeForCompression, ONEWAY, pingResponseTimeout, prefix, progressListener, responseListenerMap, responseTimeout, updateResponseTimeout, useEmailExpiryTimestamp, WAIT_ON_RESPONSE |
Constructor Summary | |
---|---|
CallbackEmailDriver()
|
Method Summary | |
---|---|
java.lang.String |
getEnvPrefix()
The command line key prefix |
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 |
getVersion()
Enforced by I_Plugin |
void |
init(Global glob,
CallbackAddress callbackAddress)
This init() is called after the init(Global, PluginInfo) |
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. |
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()
This method shuts down the driver. |
Methods inherited from class org.xmlBlaster.util.protocol.email.EmailExecutor |
---|
createMessageId, getBcc, getCc, getDefaultResponseTimeout, getDefaultUpdateResponseTimeout, getEmailSessionId, getEmailSessionId, getFrom, getLoopProtectionList, getLoopProtections, getMsgInfoParserClassName, getPop3Driver, getSecretSessionId, getSmtpClient, getTo, getUsageUrl, incomingMessage, init, isLoopingMail, isShutdown, removeFromLoopProtection, sendEmail, sendEmail, sendEmail, sendEmail, sendMessage, setBcc, setCc, setEmailSessionId, setEmailSessionId, setFrom, setSecretSessionId, setTo, setUsageUrl, usage |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.xmlBlaster.protocol.I_CallbackDriver |
---|
registerProgressListener |
Methods inherited from interface org.xmlBlaster.util.protocol.RequestReplyExecutorMBean |
---|
getMinSizeForCompression, getPingResponseTimeout, getResponseTimeout, getResponseTimeout, getUpdateResponseTimeout, interruptInvocation, isCompressZlib, isCompressZlibStream, isUseEmailExpiryTimestamp, setCompressZlib, setCompressZlibStream, setMinSizeForCompression, setPingResponseTimeout, setResponseTimeout, setUpdateResponseTimeout, setUseEmailExpiryTimestamp |
Field Detail |
---|
private java.lang.String ME
private static java.util.logging.Logger log
private CallbackAddress callbackAddress
private PluginInfo pluginInfo
Constructor Detail |
---|
public CallbackEmailDriver()
Method Detail |
---|
public java.lang.String getName()
getName
in interface I_CallbackDriver
public java.lang.String getProtocolId()
getProtocolId
in interface I_CallbackDriver
public java.lang.String getType()
getType
in interface I_AdminPlugin
getType
in interface I_Plugin
getType
in class RequestReplyExecutor
public java.lang.String getVersion()
getVersion
in interface I_AdminPlugin
getVersion
in interface I_Plugin
public java.lang.String getEnvPrefix()
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_CallbackDriver
public void init(Global glob, CallbackAddress callbackAddress) throws XmlBlasterException
init
in interface I_CallbackDriver
callbackAddress
- Contains the email TO: address
XmlBlasterException
public 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>
XmlBlasterException
public void sendUpdateOneway(MsgUnitRaw[] msgArr) throws XmlBlasterException
sendUpdateOneway
in interface I_CallbackDriver
sendUpdateOneway
in class EmailExecutor
msgArr
- Array of all messages to send, is guaranteed to never be null
XmlBlasterException
- Is never from the client (oneway).public java.lang.String ping(java.lang.String qos) throws XmlBlasterException
ping
in interface I_CallbackDriver
ping
in class EmailExecutor
qos
-
XmlBlasterException
- If client not reachableorg.xmlBlaster.protocol.I_XmlBlaster#ping(String)
public void shutdown()
shutdown
in interface I_AdminPlugin
shutdown
in interface I_Plugin
shutdown
in class EmailExecutor
public boolean isAlive()
isAlive
in interface I_CallbackDriver
isAlive
in class EmailExecutor
|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |