org.torweg.pulse.email
Class MailQueueConfiguration

java.lang.Object
  org.torweg.pulse.configuration.AbstractConfigBean
      org.torweg.pulse.email.MailQueueConfiguration

All Implemented Interfaces:

java.io.Serializable, ConfigBean

public class MailQueueConfiguration
extends AbstractConfigBean

the configuration for the MailQueue.

Version:

$Revision: 1388 $

Author:

Thomas Weber

See Also:

Serialized Form

Constructor Summary

MailQueueConfiguration()

Method Summary

long	getInterval() returns the interval for sending sessions in milliseconds.
java.lang.String	getPassword() returns the password to be used for authenticating at the MTA.
int	getPort() returns the port on which the MTA is listening.
java.lang.String	getProtocol() returns the protocol with which to send e-mails.
java.lang.String	getServer() returns the server name of the MTA.
java.io.File	getTempDir() the temporary directory to serialise/deserialise the queue on starts and stops.
java.lang.String	getUser() returns the user to be used for authenticating at the MTA.
void	init(org.jdom.Element conf) initialises the configuration.
void	setPulseRootDir(java.io.File d) sets the pulse container's root directory.

Methods inherited from class org.torweg.pulse.configuration.AbstractConfigBean

buildClass, buildInstance, lastModified, setLastModified

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MailQueueConfiguration

public MailQueueConfiguration()

Method Detail

init

public final void init(org.jdom.Element conf)

initialises the configuration.

The configuration is part of the pulse.xml:

 ...
 <mail-queue interval="10000">
   <protocol>smtp</protocol>
   <server port="25">localhost</server>
   <user>mail-user</user>
   <password>pass</password>
   <temporary-directory>/tmp</temporary-directory>
 </mail-queue>
 ...
 

Parameters:

conf - the configuration element.

setPulseRootDir

public final void setPulseRootDir(java.io.File d)

sets the pulse container's root directory.

Parameters:

d - the root directory

getProtocol

public final java.lang.String getProtocol()

returns the protocol with which to send e-mails.

Returns:

the protocol

getPort

public final int getPort()

returns the port on which the MTA is listening.

Returns:

the port number

getServer

public final java.lang.String getServer()

returns the server name of the MTA.

Returns:

the server name of the MTA

getTempDir

public final java.io.File getTempDir()

the temporary directory to serialise/deserialise the queue on starts and stops.

Returns:

the temporary directory to serialise/deserialise the queue on starts and stops

getUser

public final java.lang.String getUser()

returns the user to be used for authenticating at the MTA.

Returns:

the user or null, if the MTA does not require authentication

getPassword

public final java.lang.String getPassword()

returns the password to be used for authenticating at the MTA.

Returns:

the password to be used for authenticating at the MTA

getInterval

public long getInterval()

returns the interval for sending sessions in milliseconds.

Returns:

the interval for sending sessions in milliseconds