|
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.EmailDriver
public class EmailDriver
Email driver class to invoke the xmlBlaster server over ordinary emails.
This "email:" driver needs to be registered in xmlBlasterPlugins.xml and will be started on xmlBlaster startup by the runlevel manager as configured. The interface I_Driver is needed by xmlBlaster to instantiate and shutdown this driver implementation. All adjustable parameters are explained inusage()
MsgInfo
,
The protocol.email requirementNested Class Summary |
---|
Nested classes/interfaces inherited from class org.xmlBlaster.util.protocol.email.EmailExecutor |
---|
EmailExecutor.LoopProtection |
Field Summary | |
---|---|
private I_Authenticate |
authenticate
The singleton handle for this authentication server |
private Global |
glob
|
private static java.util.logging.Logger |
log
|
private java.lang.String |
ME
|
private PluginInfo |
pluginInfo
|
private boolean |
stripSecurityQosCDATA
The address configuration |
private I_XmlBlaster |
xmlBlasterImpl
The singleton handle for this xmlBlaster server |
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, mbeanHandle, minSizeForCompression, ONEWAY, pingResponseTimeout, prefix, progressListener, responseListenerMap, responseTimeout, updateResponseTimeout, useEmailExpiryTimestamp, WAIT_ON_RESPONSE |
Constructor Summary | |
---|---|
EmailDriver()
Creates the driver. |
Method Summary | |
---|---|
void |
activate()
Activate xmlBlaster access through this protocol. |
void |
deActivate()
Deactivate xmlBlaster access (standby), no clients can connect. |
(package private) I_Authenticate |
getAuthenticate()
Access the handle to the xmlBlaster authenication core |
java.lang.String |
getEmailSessionId(MsgInfo msgInfo)
Overwrites EmailExecutor as we are a singleton handling different clients. |
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 |
(package private) I_XmlBlaster |
getXmlBlaster()
Access the handle to the xmlBlaster core |
private void |
init(Global glob,
AddressServer addressServer,
I_Authenticate authenticate,
I_XmlBlaster xmlBlasterImpl)
Start xmlBlaster EMAIL access. |
void |
init(Global glob,
PluginInfo pluginInfo)
This method is called by the PluginManager (enforced by I_Plugin). |
boolean |
receiveReply(MsgInfo receiver,
boolean udp)
Handle connect/disconnect |
void |
sessionAdded(ClientEvent e)
Implements I_ClientListener |
void |
sessionPreRemoved(ClientEvent e)
Invoked before a client does a logout |
void |
sessionRemoved(ClientEvent e)
Invoked when client does a logout |
void |
sessionUpdated(ClientEvent e)
Invoked on successful client login |
void |
shutdown()
Close the listener port, the driver shuts down. |
void |
subjectAdded(ClientEvent e)
Invoked on first successful client login, when SubjectInfo is created |
void |
subjectRemoved(ClientEvent e)
Invoked when client does its last logout |
java.lang.String |
usage()
Command line usage. |
Methods inherited from class org.xmlBlaster.util.protocol.email.EmailExecutor |
---|
createMessageId, getBcc, getCc, getDefaultResponseTimeout, getDefaultUpdateResponseTimeout, getEmailSessionId, getFrom, getLoopProtectionList, getLoopProtections, getMsgInfoParserClassName, getPop3Driver, getSecretSessionId, getSmtpClient, getTo, getUsageUrl, incomingMessage, init, isAlive, isLoopingMail, isShutdown, ping, removeFromLoopProtection, sendEmail, sendEmail, sendEmail, sendEmail, sendMessage, sendUpdateOneway, setBcc, setCc, setEmailSessionId, setEmailSessionId, setFrom, setSecretSessionId, setTo, setUsageUrl |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
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 static java.util.logging.Logger log
private java.lang.String ME
private Global glob
private I_Authenticate authenticate
private I_XmlBlaster xmlBlasterImpl
private boolean stripSecurityQosCDATA
private PluginInfo pluginInfo
Constructor Detail |
---|
public EmailDriver()
Method Detail |
---|
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
getType
in class RequestReplyExecutor
public java.lang.String getEnvPrefix()
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
I_Authenticate getAuthenticate()
I_XmlBlaster getXmlBlaster()
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 void activate() throws XmlBlasterException
activate
in interface I_Driver
XmlBlasterException
public java.lang.String getEmailSessionId(MsgInfo msgInfo)
getEmailSessionId
in class EmailExecutor
msgInfo
-
public final boolean receiveReply(MsgInfo receiver, boolean udp) throws XmlBlasterException, java.io.IOException
receiveReply
in class RequestReplyExecutor
XmlBlasterException
java.io.IOException
public void deActivate() throws XmlBlasterException
deActivate
in interface I_Driver
XmlBlasterException
public void shutdown()
shutdown
in interface I_AdminPlugin
shutdown
in interface I_Plugin
shutdown
in class EmailExecutor
public java.lang.String usage()
usage
in interface I_Driver
usage
in interface I_AdminUsage
usage
in class EmailExecutor
public java.lang.String getName()
I_Driver
getName
in interface I_Driver
public void sessionAdded(ClientEvent e)
sessionAdded
in interface I_ClientListener
public void sessionUpdated(ClientEvent e)
I_ClientListener
sessionUpdated
in interface I_ClientListener
public void subjectAdded(ClientEvent e)
I_ClientListener
subjectAdded
in interface I_ClientListener
public void sessionPreRemoved(ClientEvent e)
I_ClientListener
sessionPreRemoved
in interface I_ClientListener
public void sessionRemoved(ClientEvent e)
I_ClientListener
sessionRemoved
in interface I_ClientListener
public void subjectRemoved(ClientEvent e)
I_ClientListener
subjectRemoved
in interface I_ClientListener
|
xmlBlaster 2.2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |