de.bea.domingo.groupware
Class Groupware

java.lang.Object
  de.bea.domingo.groupware.Groupware

public final class Groupware
extends java.lang.Object

Main entry point to the groupware functionality of domingo.

Author:

Kurt Riede

Constructor Summary

Groupware(NotesLocation location)
Constructor.

Groupware(NotesLocation location, DNotesMonitor monitor)
Constructor.

Groupware(java.lang.String locationUri)
Constructor.

Groupware(java.lang.String locationUri, DNotesMonitor monitor)
Constructor.

Method Summary

void	close() Closes the groupware instance, including all internal resources of the Notes connection.
java.util.Iterator	getAddressBooks() Returns an iterator over all available public and private addressbooks.
CalendarInterface	getCalendar() Returns an implementation of the calendar interface.
Mailbox	getMailbox() Returns an implementation of the mailbox interface for the current user.
Mailbox	getMailbox(java.lang.String username) Returns an implementation of the mailbox interface for a given user.

Methods inherited from class java.lang.Object

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

Constructor Detail

Groupware

public Groupware(java.lang.String locationUri)
          throws GroupwareException

Constructor. The location is only used to create a domingo session; the mail-server and the path to the mail database is examined from the current user.

If the location is a IIOP location and the mail-server of the current user is not the server as specified in the location the connection will fail.

Parameters:

locationUri - location URI of notes database

Throws:

GroupwareException - if the groupware cannot be initialized

Groupware

public Groupware(java.lang.String locationUri,
                 DNotesMonitor monitor)
          throws GroupwareException

Constructor. The location is only used to create a domingo session; the mail-server and the path to the mail database is examined from the current user.

If the location is a IIOP location and the mail-server of the current user is not the server as specified in the location the connection will fail.

Parameters:

locationUri - location URI of notes database

monitor - a monitor

Throws:

GroupwareException - if the groupware cannot be initialized

Groupware

public Groupware(NotesLocation location)
          throws GroupwareException

Constructor. The location is only used to create a domingo session; the mail-server and the path to the mail database is examined from the current user.

If the location is a IIOP location and the mail-server of the current user is not the server as specified in the location the connection will fail.

Parameters:

location - location of notes database

Throws:

GroupwareException - if the groupware cannot be initialized

Groupware

public Groupware(NotesLocation location,
                 DNotesMonitor monitor)
          throws GroupwareException

Constructor. The location is only used to create a domingo session; the mail-server and the path to the mail database is examined from the current user.

If the location is a IIOP location and the mail-server of the current user is not the server as specified in the location the connection will fail.

Parameters:

location - location of notes database

monitor - a monitor

Throws:

GroupwareException - if the groupware cannot be initialized

Method Detail

getMailbox

public Mailbox getMailbox()
                   throws GroupwareException

Returns an implementation of the mailbox interface for the current user.

Returns:

mailbox interface

Throws:

GroupwareException - if the mailbox cannot be opened

getMailbox

public Mailbox getMailbox(java.lang.String username)
                   throws GroupwareException

Returns an implementation of the mailbox interface for a given user.

Parameters:

username - username

Returns:

mailbox interface

Throws:

GroupwareException - if the mailbox cannot be opened

getCalendar

public CalendarInterface getCalendar()
                              throws GroupwareException

Returns an implementation of the calendar interface.

Returns:

calendar interface

Throws:

GroupwareException - if the calendar database cannot be opened.

getAddressBooks

public java.util.Iterator getAddressBooks()

Returns an iterator over all available public and private addressbooks.

Returns:

Iterator

See Also:

AddressBook

close

public void close()
           throws DNotesRuntimeException

Closes the groupware instance, including all internal resources of the Notes connection.

Throws:

DNotesRuntimeException - if an error occurs during disposal or if not all objects can be disposed