com.atlassian.mail.server

Class AbstractMailServer

java.lang.Object

com.atlassian.mail.server.AbstractMailServer

All Implemented Interfaces:

MailServer, Serializable

Direct Known Subclasses:

PopMailServerImpl, SMTPMailServerImpl

public abstract class AbstractMailServer
extends Object
implements MailServer, Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isAuthenticating
protected org.apache.log4j.Logger	log

Constructor Summary

Constructors

Modifier	Constructor and Description
	AbstractMailServer()
protected	AbstractMailServer(long timeout)
	AbstractMailServer(Long id, String name, String description, MailProtocol protocol, String hostName, String port, String username, String password, long timeout, String socksHost, String socksPort)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
protected abstract javax.mail.Authenticator	getAuthenticator()
long	getConnectionTimeout()
boolean	getDebug()
PrintStream	getDebugStream()
String	getDescription()
String	getHostname()
Long	getId()
MailProtocol	getMailProtocol()
protected void	getMoreDebugInfoAboutCreatedSession(javax.mail.Session session)
String	getName()
String	getPassword()
String	getPort()
Properties	getProperties()
protected javax.mail.Session	getSessionFromServerManager(Properties props, javax.mail.Authenticator authenticator)
String	getSocksHost()
String	getSocksPort()
long	getTimeout()
String	getUsername()
int	hashCode()
boolean	isTlsRequired()
protected Properties	loadSystemProperties(Properties p) This allows users of atlassian mail to add command line properties to modify session defaults See JRA-11452 The hierarchy now is - default properties, then from the command line, then properties added via setProperties
protected void	propertyChanged() Call this method whenever a property of the server changes.
void	setConnectionTimeout(long timeout)
void	setDebug(boolean debug)
void	setDebugStream(PrintStream debugStream) If debug is enabled, output from underlying javamail will go to this stream.
void	setDescription(String description)
void	setHostname(String serverName)
void	setId(Long id)
void	setLogger(org.apache.log4j.Logger logger)
void	setMailProtocol(MailProtocol protocol)
void	setName(String name)
void	setPassword(String password)
void	setPort(String port)
void	setProperties(Properties props)
void	setSocksHost(String socksHost)
void	setSocksPort(String socksPort)
void	setTimeout(long timeout)
void	setTlsRequired(boolean tlsRequired)
void	setUsername(String username)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.mail.server.MailServer

getSession, getType

Field Detail

log

protected transient org.apache.log4j.Logger log

isAuthenticating

protected boolean isAuthenticating

Constructor Detail

AbstractMailServer

public AbstractMailServer()

AbstractMailServer

protected AbstractMailServer(long timeout)

AbstractMailServer

public AbstractMailServer(Long id,
                          String name,
                          String description,
                          MailProtocol protocol,
                          String hostName,
                          String port,
                          String username,
                          String password,
                          long timeout,
                          String socksHost,
                          String socksPort)

Method Detail

getAuthenticator

protected abstract javax.mail.Authenticator getAuthenticator()

getId

public Long getId()

Specified by:

getId in interface MailServer

setId

public void setId(Long id)

Specified by:

setId in interface MailServer

getName

public String getName()

Specified by:

getName in interface MailServer

setName

public void setName(String name)

Specified by:

setName in interface MailServer

getDescription

public String getDescription()

Specified by:

getDescription in interface MailServer

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface MailServer

getHostname

public String getHostname()

Specified by:

getHostname in interface MailServer

setHostname

public void setHostname(String serverName)

Specified by:

setHostname in interface MailServer

getUsername

public String getUsername()

Specified by:

getUsername in interface MailServer

setUsername

public void setUsername(String username)

Specified by:

setUsername in interface MailServer

getPassword

public String getPassword()

Specified by:

getPassword in interface MailServer

setPassword

public void setPassword(String password)

Specified by:

setPassword in interface MailServer

getMailProtocol

public MailProtocol getMailProtocol()

Specified by:

getMailProtocol in interface MailServer

setMailProtocol

public void setMailProtocol(MailProtocol protocol)

Specified by:

setMailProtocol in interface MailServer

getPort

public String getPort()

Specified by:

getPort in interface MailServer

setPort

public void setPort(String port)

Specified by:

setPort in interface MailServer

getTimeout

public long getTimeout()

Specified by:

getTimeout in interface MailServer

getConnectionTimeout

public long getConnectionTimeout()

setTimeout

public void setTimeout(long timeout)

Specified by:

setTimeout in interface MailServer

setConnectionTimeout

public void setConnectionTimeout(long timeout)

getSocksHost

public String getSocksHost()

Specified by:

getSocksHost in interface MailServer

setSocksHost

public void setSocksHost(String socksHost)

Specified by:

setSocksHost in interface MailServer

getSocksPort

public String getSocksPort()

Specified by:

getSocksPort in interface MailServer

setSocksPort

public void setSocksPort(String socksPort)

Specified by:

setSocksPort in interface MailServer

isTlsRequired

public boolean isTlsRequired()

setTlsRequired

public void setTlsRequired(boolean tlsRequired)

getProperties

public Properties getProperties()

Specified by:

getProperties in interface MailServer

Returns:

the set of dynamic properties applied to thsi server, may very wel be null in which case the mail server properties can be obtained from the session

setProperties

public void setProperties(Properties props)

Specified by:

setProperties in interface MailServer

setDebug

public void setDebug(boolean debug)

Specified by:

setDebug in interface MailServer

setDebugStream

public void setDebugStream(PrintStream debugStream)

Description copied from interface: MailServer

If debug is enabled, output from underlying javamail will go to this stream.

Specified by:

setDebugStream in interface MailServer

Parameters:

debugStream - An optional stream to send debug messages to. If null, System.out is used.

getDebug

public boolean getDebug()

Specified by:

getDebug in interface MailServer

getDebugStream

public PrintStream getDebugStream()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

propertyChanged

protected void propertyChanged()

Call this method whenever a property of the server changes. Subclasses should override it to clear any cached information.

loadSystemProperties

protected Properties loadSystemProperties(Properties p)

This allows users of atlassian mail to add command line properties to modify session defaults See JRA-11452 The hierarchy now is - default properties, then from the command line, then properties added via setProperties

Parameters:

p - the default properties for the current mail session

Returns:

the properties with the system properties loaded

setLogger

public void setLogger(org.apache.log4j.Logger logger)

Specified by:

setLogger in interface MailServer

getMoreDebugInfoAboutCreatedSession

protected void getMoreDebugInfoAboutCreatedSession(javax.mail.Session session)

getSessionFromServerManager

protected javax.mail.Session getSessionFromServerManager(Properties props,
                                                         javax.mail.Authenticator authenticator)
                                                  throws MailException

Throws:

MailException