de.kosi.server
Interface MailerInterface

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

MailerInterfaceImpl

public interface MailerInterface

extends java.rmi.Remote

Interface to configure the mailer.

ChangeLog:

 $Log: MailerInterface.java,v $
 Revision 1.2  2001/06/04 14:21:10  jiriki
 Made source more comliant to coding guidelines.

 Revision 1.1.1.1  2001/04/29 18:05:18  jiriki
 Imported sources from zola.

 Revision 1.3  2001/04/24 23:19:22  wombat
 - Implemented I18N features of server
 - Implemented actions for Admin Client
 - Other changes is AdminClient

 Revision 1.2  2001/04/11 17:40:49  wombat
 Updated Documentation.

 Revision 1.1  2001/04/09 17:55:27  wombat
 Mail Interface Konfiguration eingefügt.

 

Version:

$Revision: 1.2 $ ($Date: 2001/06/04 14:21:10 $)

Author:

Jan-Ole Janssen, Niklas Mehner, Time Sticher

Method Summary

java.lang.String	getHost() Return the SMTP server, that is used to send mail.
java.util.Vector	getMailTextNames() Return an array containing the names of mails that can be send.
java.lang.String	getSenderAddress() Return the email address, that is used to send mail.
boolean	isDebugging() Wether debug output is printed to stdio.
void	sendTestMail(java.lang.String eMail, java.lang.String textName, java.util.Locale locale) Send a test mail.
void	setDebug(boolean debug) Set wether debug output is printed to stdio.
void	setHost(java.lang.String hostname) Set the SMTP server, that is used to send mail.
void	setSenderAddress(java.lang.String eMail) Set the email address, that is used to send mail.

Method Detail

isDebugging

public boolean isDebugging()
                    throws java.rmi.RemoteException,
                           KosiAccessException,
                           InvalidSessionException

Wether debug output is printed to stdio.

Returns:

True if debug output is printed to stdio.

Throws:

java.rmi.RemoteException - If the remote call fails.

KosiAccessException - If called by an user, that has no administration permission.

InvalidSessionException - If called from an invalid session cotext.

setDebug

public void setDebug(boolean debug)
              throws java.rmi.RemoteException,
                     KosiAccessException,
                     InvalidSessionException

Set wether debug output is printed to stdio.

Parameters:

debug - True if debug output is to be printed to stdio.

Throws:

java.rmi.RemoteException - If the remote call fails.

KosiAccessException - If called by an user, that has no administration permission.

InvalidSessionException - If called from an invalid session cotext.

getHost

public java.lang.String getHost()
                         throws java.rmi.RemoteException,
                                KosiAccessException,
                                InvalidSessionException

Return the SMTP server, that is used to send mail.

Returns:

Name of the server.

Throws:

java.rmi.RemoteException - If the remote call fails.

KosiAccessException - If called by an user, that has no administration permission.

InvalidSessionException - If called from an invalid session cotext.

setHost

public void setHost(java.lang.String hostname)
             throws java.rmi.RemoteException,
                    KosiAccessException,
                    InvalidSessionException

Set the SMTP server, that is used to send mail.

Parameters:

hostname - Name of the server.

Throws:

java.rmi.RemoteException - If the remote call fails.

KosiAccessException - If called by an user, that has no administration permission.

InvalidSessionException - If called from an invalid session cotext.

getSenderAddress

public java.lang.String getSenderAddress()
                                  throws java.rmi.RemoteException,
                                         KosiAccessException,
                                         InvalidSessionException

Return the email address, that is used to send mail.

Returns:

EMail address.

Throws:

java.rmi.RemoteException - If the remote call fails.

KosiAccessException - If called by an user, that has no administration permission.

InvalidSessionException - If called from an invalid session cotext.

setSenderAddress

public void setSenderAddress(java.lang.String eMail)
                      throws java.rmi.RemoteException,
                             KosiAccessException,
                             InvalidSessionException

Set the email address, that is used to send mail.

Parameters:

eMail - EMail address.

Throws:

java.rmi.RemoteException - If the remote call fails.

KosiAccessException - If called by an user, that has no administration permission.

InvalidSessionException - If called from an invalid session cotext.

sendTestMail

public void sendTestMail(java.lang.String eMail,
                         java.lang.String textName,
                         java.util.Locale locale)
                  throws java.rmi.RemoteException,
                         KosiAccessException,
                         InvalidSessionException,
                         javax.mail.MessagingException

Send a test mail.

Parameters:

eMail - EMail address to send the testmail to.

textName - Name of the text to send. This must be one of the Names returned by getTextNames.

locale - Locale the message is sent in.

Throws:

java.rmi.RemoteException - If the remote call fails.

KosiAccessException - If called by an user, that has no administration permission.

InvalidSessionException - If called from an invalid session cotext.

javax.mail.MessagingException - If the mail could not be send.

getMailTextNames

public java.util.Vector getMailTextNames()
                                  throws java.rmi.RemoteException,
                                         KosiAccessException,
                                         InvalidSessionException

Return an array containing the names of mails that can be send. These can be used as input for sendTestMail().

Returns:

Array containing names of mails.

Throws:

java.rmi.RemoteException - If the remote call fails.

KosiAccessException - If called by an user, that has no administration permission.

InvalidSessionException - If called from an invalid session cotext.