com.atlassian.mail.server.managers

Class AbstractMailServerManager

java.lang.Object

com.atlassian.mail.server.managers.AbstractMailServerManager

All Implemented Interfaces:

MailServerManager

Direct Known Subclasses:

XMLMailServerManager

public abstract class AbstractMailServerManager
extends Object
implements MailServerManager

Date: Dec 9, 2002

Field Summary

Fields inherited from interface com.atlassian.mail.server.MailServerManager

SERVER_TYPES

Constructor Summary

Constructors

Constructor and Description
AbstractMailServerManager()

Method Summary

Modifier and Type	Method and Description
abstract Long	create(MailServer mailServer)
abstract void	delete(Long mailServerId)
abstract PopMailServer	getDefaultPopMailServer()
abstract SMTPMailServer	getDefaultSMTPMailServer()
abstract MailServer	getMailServer(Long id)
abstract MailServer	getMailServer(String name)
protected MailServerConfigurationHandler	getMailServerConfigurationHandler()
abstract List<PopMailServer>	getPopMailServers() Gets a list of all the configured POP mail servers.
abstract List<String>	getServerNames()
javax.mail.Session	getSession(Properties props, javax.mail.Authenticator auth)
abstract List<SMTPMailServer>	getSmtpMailServers() Gets a list of all the configured SMTP mail servers.
void	init(Map params)
boolean	isDefaultSMTPMailServerDefined() Whether a "default" SMTP Mail Server has been defined.
void	setMailServerConfigurationHandler(MailServerConfigurationHandler mailServerConfigurationHandler) Implementations of this interface are supposed to call registered here MailServerConfigurationHandler immediately after they construct MailServer objects.
abstract void	update(MailServer mailServer)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMailServerManager

public AbstractMailServerManager()

Method Detail

init

public void init(Map params)

Specified by:

init in interface MailServerManager

getMailServer

@Nullable
public abstract MailServer getMailServer(Long id)
                                            throws MailException

Specified by:

getMailServer in interface MailServerManager

Throws:

MailException

getMailServer

@Nullable
public abstract MailServer getMailServer(String name)
                                            throws MailException

Specified by:

getMailServer in interface MailServerManager

Throws:

MailException

getServerNames

public abstract List<String> getServerNames()
                                     throws MailException

Specified by:

getServerNames in interface MailServerManager

Throws:

MailException

getSmtpMailServers

public abstract List<SMTPMailServer> getSmtpMailServers()

Description copied from interface: MailServerManager

Gets a list of all the configured SMTP mail servers.

Specified by:

getSmtpMailServers in interface MailServerManager

Returns:

A list of all the configured SMTP mail servers.

getPopMailServers

public abstract List<PopMailServer> getPopMailServers()

Description copied from interface: MailServerManager

Gets a list of all the configured POP mail servers.

Specified by:

getPopMailServers in interface MailServerManager

Returns:

A list of all the configured POP mail servers.

create

public abstract Long create(MailServer mailServer)
                     throws MailException

Specified by:

create in interface MailServerManager

Throws:

MailException

update

public abstract void update(MailServer mailServer)
                     throws MailException

Specified by:

update in interface MailServerManager

Throws:

MailException

delete

public abstract void delete(Long mailServerId)
                     throws MailException

Specified by:

delete in interface MailServerManager

Throws:

MailException

getDefaultSMTPMailServer

@Nullable
public abstract SMTPMailServer getDefaultSMTPMailServer()

Specified by:

getDefaultSMTPMailServer in interface MailServerManager

isDefaultSMTPMailServerDefined

public boolean isDefaultSMTPMailServerDefined()

Description copied from interface: MailServerManager

Whether a "default" SMTP Mail Server has been defined.

Specified by:

isDefaultSMTPMailServerDefined in interface MailServerManager

Returns:

true if a "default" SMTP Mail Server has been defined; otherwise, false.

getDefaultPopMailServer

@Nullable
public abstract PopMailServer getDefaultPopMailServer()

Specified by:

getDefaultPopMailServer in interface MailServerManager

getSession

public javax.mail.Session getSession(Properties props,
                                     javax.mail.Authenticator auth)

Specified by:

getSession in interface MailServerManager

setMailServerConfigurationHandler

public void setMailServerConfigurationHandler(@Nullable
                                              MailServerConfigurationHandler mailServerConfigurationHandler)

Description copied from interface: MailServerManager

Implementations of this interface are supposed to call registered here MailServerConfigurationHandler immediately after they construct MailServer objects. You can use it to further customise MailServer objects managed by this manager - e.g. initialize MailServer fields basing on application specific needs. This method is used to make up for lack of dependency injection while constructing MailServerManager implementation by ConfigLoader.ConfigLoader(String)

Specified by:

setMailServerConfigurationHandler in interface MailServerManager

Parameters:

mailServerConfigurationHandler - callback called upon creation of MailServer objects

getMailServerConfigurationHandler

protected MailServerConfigurationHandler getMailServerConfigurationHandler()