de.tivsource.lib.jcyradm

Class JCyrAdm

java.lang.Object

de.tivsource.lib.jcyradm.JCyrAdm

public class JCyrAdm
extends Object

JCyrAdm ist eine Libary die dazu dient eine Verbindung mit einem Cyrus-Imap-Server herzustellen und um dann Verwaltungsoperationen auszuführen (createMailbox, removeMailbox, etc. ).

Author:

Marc Michele

Constructor Summary

Constructors

Constructor and Description
JCyrAdm() Standard Konstruktor der Klasse JCyrAdm, dabei wird die interne Properties-Datei benutzt.
JCyrAdm(String properties) Konstruktor der Klasse JCyrAdm, es muss eine Properties-Datei angegeben werden.

Method Summary

Modifier and Type	Method and Description
void	acl(String mailbox) Mit dieser Methode können die ACLs einer bestimmten Mailbox abgefragt werden.
void	capability() Unfertige Methode !!!!
void	connect(Boolean ssl) Methode um eine Verbindung zum Server aufzubauen, es muss der Parameter "ssl" gesetzt werden.
void	createMailBox(String mailbox) Methode zum erstellen einer Mailbox mit dem Namen "mailbox".
void	deleteAcl(String mailbox, String user) Mit dieser Methode können die Rechte einer Mailbox die für einen bestimmten Benutzer existieren gelöscht werden.
void	deleteMailBox(String mailbox) Hier. // TODO Doku hier
void	disconnect() Methode um die Verbindung zum Server zu trennen.
Map<String,String>	getAcls() TODO Doku
BigDecimal	getLoad() Bevor die Methode getLoad() aufgerufen werden kann, muss die Methode quota(String mailbox) aufgrufen werden.
BigDecimal	getQuota() Bevor die Methode getQuota() aufgerufen werden kann, muss die Methode quota(String mailbox) aufgrufen werden.
BigDecimal	getUsed() Bevor die Methode getUsed() aufgerufen werden kann, muss die Methode quota(String mailbox) aufgrufen werden.
String	getWelcomeMsg() Mit Hilfe dieser Methode kann man sich die Wilkommensnachricht des Server abfragen, die nach dem aufruf der Methode connect(Boolean ssl) empfangen wurde.
void	login() Mit dieser Methode wird der Administrationsbenutzer am Server angemeldet.
void	logout() Mit dieser Methode meldet man sich vom Server ab, es werden auch alle Streams geschlossen.
void	quota(String mailbox) Methode zum berechnen der Quota der aktuellen Mailbox, die Werte können über die entsprechenden Methoden abgerufen werden.
void	setAcl(String mailbox, String user, String acl) Mit dieser Methode können für eine bestimmte Mailbox, Rechte für einen bestimmten Benutzer gesetzt werden.
void	setAdministrator(String set) Hier. // TODO Doku hier
void	setHost(String hostname) Methode zum setzen des Hostnamen oder der IP-Adresse des Servers mit dem eine Verbindung aufgebaut werden soll.
void	setPassword(String set) Hier. // TODO Doku hier
void	setPort(Integer portNumber) Methode um die Port-Nummer des Server zu verändern, normalerweise nicht nötig, wenn der Server auf den Standard-Ports betrieben wird.
void	setQuota(String mailbox, BigDecimal quotaToSet) Methode zum setzten der Quota einer Mailbox.
String	version() Liefert die Version des Server mit dem gerade eine Verbindung aufgebaut ist.

Methods inherited from class java.lang.Object

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

Constructor Detail

JCyrAdm

public JCyrAdm()
        throws NoPropertiesFile,
               NoServerAnswerFile,
               NoLogMessagesFile

Standard Konstruktor der Klasse JCyrAdm, dabei wird die interne Properties-Datei benutzt.

Throws:

NoPropertiesFile - - Ausnahme wenn die Properties-Datei nicht gefunden wird.

NoServerAnswerFile

NoLogMessagesFile

JCyrAdm

public JCyrAdm(String properties)
        throws NoPropertiesFile,
               NoServerAnswerFile,
               NoLogMessagesFile

Konstruktor der Klasse JCyrAdm, es muss eine Properties-Datei angegeben werden.

Parameters:

properties - - Properties-Datei

Throws:

NoPropertiesFile - - Ausnahme wenn die Properties-Datei nicht gefunden wird.

NoServerAnswerFile

NoLogMessagesFile

Method Detail

connect

public final void connect(Boolean ssl)
                   throws IOException

Methode um eine Verbindung zum Server aufzubauen, es muss der Parameter "ssl" gesetzt werden. Wenn TRUE übergeben wird dann wird eine SSL-Verbindung zum angebenen Port aufgebaut.

Parameters:

ssl - - Boolean mit dem zwischen SSL und Plain umgeschaltet wird.

Throws:

IOException - - Unbekannter Host oder Unmöglich den Stream zu öffnen

disconnect

public final void disconnect()
                      throws IOException

Methode um die Verbindung zum Server zu trennen.

Throws:

IOException - - wenn der Stream schon geschlossen ist oder Verbindung abgelaufen ist.

capability

public final void capability()
                      throws IOException

Unfertige Methode !!!! Diese Methode muss dringent überarbeitet werden. Holt die Capability und setzt die Default-ACLs. .

Throws:

IOException - - InputStream/OutputStream geschlossen oder nicht vorhanden

login

public final void login()
                 throws NoServerResponse,
                        UnexpectedServerAnswer,
                        AuthenticationFailure

Mit dieser Methode wird der Administrationsbenutzer am Server angemeldet.

Throws:

NoServerResponse - - Keine Antwort vom Server erhalten.

UnexpectedServerAnswer - - Unerwartete Antwort vom Server.

AuthenticationFailure

logout

public final void logout()
                  throws NoServerResponse,
                         NoServerStream,
                         UnexpectedServerAnswer

Mit dieser Methode meldet man sich vom Server ab, es werden auch alle Streams geschlossen.

Throws:

NoServerResponse - - Keine Antwort vom Server.

NoServerStream - - Kein Stream vom Server vorhanden.

UnexpectedServerAnswer - - Unerwartete Server Antwort erhalten.

acl

public final void acl(String mailbox)
               throws NoValidMailboxName,
                      NoServerResponse,
                      UnexpectedServerAnswer

Mit dieser Methode können die ACLs einer bestimmten Mailbox abgefragt werden.

Parameters:

mailbox - - Die Mailbox für die die ACLs abgefragt werden sollen

Throws:

NoValidMailboxName - - // TODO Dokumentation

NoServerResponse

UnexpectedServerAnswer

setAcl

public final void setAcl(String mailbox,
                         String user,
                         String acl)
                  throws NoValidMailboxName,
                         NoServerResponse,
                         UnexpectedServerAnswer

Mit dieser Methode können für eine bestimmte Mailbox, Rechte für einen bestimmten Benutzer gesetzt werden.

Parameters:

mailbox - - Die Mailbox für die die Rechte gesetzt werden sollen.

user - - Benutzer für die die Rechte gelten sollen.

acl - - Rechte die für den Benutzer gelten sollen.

Throws:

NoValidMailboxName - -

NoServerResponse

UnexpectedServerAnswer

deleteAcl

public final void deleteAcl(String mailbox,
                            String user)
                     throws NoValidMailboxName,
                            NoServerResponse,
                            UnexpectedServerAnswer

Mit dieser Methode können die Rechte einer Mailbox die für einen bestimmten Benutzer existieren gelöscht werden.

Parameters:

mailbox - - Mailbox für die die Rechte gelöscht werden sollen.

user - - Benutzer für den die Rechte gelöscht werden sollen.

Throws:

NoValidMailboxName - - // TODO Dokumentation.

NoServerResponse

UnexpectedServerAnswer

quota

public final void quota(String mailbox)
                 throws IOException,
                        NoMailbox,
                        NoQuota,
                        UnexpectedExtraArguments,
                        NoServerResponse,
                        NoValidMailboxName

Methode zum berechnen der Quota der aktuellen Mailbox, die Werte können über die entsprechenden Methoden abgerufen werden.

Parameters:

mailbox - - Mailbox für die die Quota berechnet werden soll.

Throws:

IOException - - InputStream/OutputStream geschlossen oder nicht vorhanden

NoMailbox - - TODO doku

NoQuota - - TODO doku

UnexpectedExtraArguments - - TODO doku

NoServerResponse - - TODO doku

NoValidMailboxName - - TODO doku

setQuota

public final void setQuota(String mailbox,
                           BigDecimal quotaToSet)
                    throws IOException,
                           NoValidMailboxName

Methode zum setzten der Quota einer Mailbox.

Parameters:

mailbox - - Hier. // TODO Doku hier

quotaToSet - - Hier. // TODO Doku hier

Throws:

IOException - - TODO doku

NoValidMailboxName - -

createMailBox

public final void createMailBox(String mailbox)
                         throws IOException,
                                MailboxExists,
                                NoServerResponse,
                                NoValidMailboxName

Methode zum erstellen einer Mailbox mit dem Namen "mailbox".

Parameters:

mailbox - - String mit dem Namen der Mailbox (i.e. "mailboxname" ohne [user.])

Throws:

IOException - - InputStream/OutputStream geschlossen oder nicht vorhanden

MailboxExists - - Die Mailbox die erstellt werden soll exsistiert bereits.

NoServerResponse - - //TODO Dokumentation

NoValidMailboxName - - //TODO Dokumentation

deleteMailBox

public final void deleteMailBox(String mailbox)
                         throws IOException,
                                NoValidMailboxName

Hier. // TODO Doku hier

Parameters:

mailbox - - Hier. // TODO Doku hier

Throws:

IOException - - InputStream/OutputStream geschlossen oder nicht vorhanden

NoValidMailboxName - -

setHost

public final void setHost(String hostname)

Methode zum setzen des Hostnamen oder der IP-Adresse des Servers mit dem eine Verbindung aufgebaut werden soll. Falls der Host nicht gesetzt ist wird localhost als hostname benutzt.

Parameters:

hostname - - Der Name oder die IP-Adresse des Servers zu dem eine Verbindung aufgebaut werden soll.

setPort

public final void setPort(Integer portNumber)

Methode um die Port-Nummer des Server zu verändern, normalerweise nicht nötig, wenn der Server auf den Standard-Ports betrieben wird.

Parameters:

portNumber - - Port-Nummer die für die Verbindung zum Server benutzt werden soll.

setAdministrator

public final void setAdministrator(String set)

Hier. // TODO Doku hier

Parameters:

set - - Hier. // TODO Doku hier

setPassword

public final void setPassword(String set)

Hier. // TODO Doku hier

Parameters:

set - - Hier. // TODO Doku hier

version

public final String version()
                     throws IOException

Liefert die Version des Server mit dem gerade eine Verbindung aufgebaut ist.

Returns:

String - Cyrus Version

Throws:

IOException - - InputStream/OutputStream geschlossen oder nicht vorhanden

getWelcomeMsg

public final String getWelcomeMsg()

Mit Hilfe dieser Methode kann man sich die Wilkommensnachricht des Server abfragen, die nach dem aufruf der Methode connect(Boolean ssl) empfangen wurde.

Returns:

String - Willkommensnachricht des Servers.

getAcls

public Map<String,String> getAcls()

TODO Doku

Returns:

getUsed

public final BigDecimal getUsed()
                         throws QuotaNotInitialized

Bevor die Methode getUsed() aufgerufen werden kann, muss die Methode quota(String mailbox) aufgrufen werden. Die Methode getUsed() liefert dann den benutzen Teil der Quota der Mailbox.

Returns:

BigDecimal - Benutzer Teil der Quota der Mailbox die mit der Methode quota(String mailbox) übergeben wurde.

Throws:

QuotaNotInitialized - - TODO doku

getQuota

public final BigDecimal getQuota()
                          throws QuotaNotInitialized

Bevor die Methode getQuota() aufgerufen werden kann, muss die Methode quota(String mailbox) aufgrufen werden. Die Methode getQuota() liefert dann die aktuelle Quota der Mailbox.

Returns:

BigDecimal - Quota der Mailbox die mit der Methode quota(String mailbox) übergeben wurde.

Throws:

QuotaNotInitialized - - TODO doku

getLoad

public final BigDecimal getLoad()
                         throws QuotaNotInitialized

Bevor die Methode getLoad() aufgerufen werden kann, muss die Methode quota(String mailbox) aufgrufen werden. Die Methode getLoad() liefert dann die aktuelle Load der Mailbox.

Returns:

BigDecimal - Load der Mailbox die mit der Methode quota(String mailbox) übergeben wurde.

Throws:

QuotaNotInitialized - - TODO doku