mx4j.tools.mail

Class SMTP

Implemented Interfaces:
javax.management.MBeanRegistration, javax.management.NotificationListener, SMTPMBean

public class SMTP
extends java.lang.Object
implements SMTPMBean, javax.management.NotificationListener, javax.management.MBeanRegistration

This MBean is meant to send a mail given certain situation. It may be used to listen to a monitor or timer and send a mail.

To use it you need to add to your classpath the mail.jar from the JavaMail API and the activation.jar from the Java Activation Framework.

Besides you need to configure all the required fields, at least the serverHost and To fields and if your server requires login also the serverUsername and serverPassword fields

The subject and content fields are subject to keyword expansions, i.e. some keyworks put between $ signs will be exapnded this can be used to give a more informative message. The current available expansions are

$date$ -> Current date formatted with locale format $time$ -> Current tim formatted with locale format $datetime$ -> Current date and time formatted with locale format $notification$ -> Notification type $observed$ -> ObjectName of the observed object $objectname$ -> This MBean's objectname

Version:
$Revision: 1.7 $

Method Summary

String
getBCC()
String
getCC()
String
getContent()
String
getFromAddress()
String
getFromName()
String
getMimeType()
String
getNotificationName()
javax.management.ObjectName
getObservedObject()
String
getServerHost()
int
getServerPort()
String
getServerUsername()
String
getSubject()
int
getTimeout()
String
getTo()
void
handleNotification(javax.management.Notification notification, Object handback)
boolean
isLoginToServer()
void
postDeregister()
void
postRegister(Boolean registrationDone)
void
preDeregister()
javax.management.ObjectName
preRegister(javax.management.MBeanServer server, javax.management.ObjectName name)
Gathers some basic data
protected void
registerListener()
void
sendMail()
void
setBCC(String bccAddresses)
void
setCC(String ccAddresses)
void
setContent(String content)
void
setFromAddress(String fromAddress)
void
setFromName(String fromName)
void
setLoginToServer(boolean login)
void
setMimeType(String mimeType)
void
setNotificationName(String notificationName)
void
setObservedObject(javax.management.ObjectName targetMBeanName)
void
setServerHost(String host)
void
setServerPassword(String password)
void
setServerPort(int port)
void
setServerUsername(String username)
void
setSubject(String subject)
void
setTimeout(int timeout)
void
setTo(String toAddresses)
protected void
unregisterListener()

Method Details

getBCC

public String getBCC()
Specified by:
getBCC in interface SMTPMBean


getCC

public String getCC()
Specified by:
getCC in interface SMTPMBean


getContent

public String getContent()
Specified by:
getContent in interface SMTPMBean


getFromAddress

public String getFromAddress()
Specified by:
getFromAddress in interface SMTPMBean


getFromName

public String getFromName()
Specified by:
getFromName in interface SMTPMBean


getMimeType

public String getMimeType()
Specified by:
getMimeType in interface SMTPMBean


getNotificationName

public String getNotificationName()
Specified by:
getNotificationName in interface SMTPMBean


getObservedObject

public javax.management.ObjectName getObservedObject()
Specified by:
getObservedObject in interface SMTPMBean


getServerHost

public String getServerHost()
Specified by:
getServerHost in interface SMTPMBean


getServerPort

public int getServerPort()
Specified by:
getServerPort in interface SMTPMBean


getServerUsername

public String getServerUsername()
Specified by:
getServerUsername in interface SMTPMBean


getSubject

public String getSubject()
Specified by:
getSubject in interface SMTPMBean


getTimeout

public int getTimeout()
Specified by:
getTimeout in interface SMTPMBean


getTo

public String getTo()
Specified by:
getTo in interface SMTPMBean


handleNotification

public void handleNotification(javax.management.Notification notification,
                               Object handback)
Specified by:
handleNotification in interface javax.management.NotificationListener


isLoginToServer

public boolean isLoginToServer()
Specified by:
isLoginToServer in interface SMTPMBean


postDeregister

public void postDeregister()
Specified by:
postDeregister in interface javax.management.MBeanRegistration


postRegister

public void postRegister(Boolean registrationDone)
Specified by:
postRegister in interface javax.management.MBeanRegistration


preDeregister

public void preDeregister()
            throws java.lang.Exception
Specified by:
preDeregister in interface javax.management.MBeanRegistration


preRegister

public javax.management.ObjectName preRegister(javax.management.MBeanServer server,
                                               javax.management.ObjectName name)
            throws java.lang.Exception
Gathers some basic data
Specified by:
preRegister in interface javax.management.MBeanRegistration


registerListener

protected void registerListener()


sendMail

public void sendMail()
Specified by:
sendMail in interface SMTPMBean


setBCC

public void setBCC(String bccAddresses)
Specified by:
setBCC in interface SMTPMBean


setCC

public void setCC(String ccAddresses)
Specified by:
setCC in interface SMTPMBean


setContent

public void setContent(String content)
Specified by:
setContent in interface SMTPMBean


setFromAddress

public void setFromAddress(String fromAddress)
Specified by:
setFromAddress in interface SMTPMBean


setFromName

public void setFromName(String fromName)
Specified by:
setFromName in interface SMTPMBean


setLoginToServer

public void setLoginToServer(boolean login)
Specified by:
setLoginToServer in interface SMTPMBean


setMimeType

public void setMimeType(String mimeType)
Specified by:
setMimeType in interface SMTPMBean


setNotificationName

public void setNotificationName(String notificationName)
Specified by:
setNotificationName in interface SMTPMBean


setObservedObject

public void setObservedObject(javax.management.ObjectName targetMBeanName)
Specified by:
setObservedObject in interface SMTPMBean


setServerHost

public void setServerHost(String host)
Specified by:
setServerHost in interface SMTPMBean


setServerPassword

public void setServerPassword(String password)
Specified by:
setServerPassword in interface SMTPMBean


setServerPort

public void setServerPort(int port)
Specified by:
setServerPort in interface SMTPMBean


setServerUsername

public void setServerUsername(String username)
Specified by:
setServerUsername in interface SMTPMBean


setSubject

public void setSubject(String subject)
Specified by:
setSubject in interface SMTPMBean


setTimeout

public void setTimeout(int timeout)
Specified by:
setTimeout in interface SMTPMBean


setTo

public void setTo(String toAddresses)
Specified by:
setTo in interface SMTPMBean


unregisterListener

protected void unregisterListener()


Copyright © 2001-2005 The MX4J Contributors. All Rights Reserved.