com.sap.ip.collaboration.gw.api.framework.groupware

Interface ITransport

All Known Subinterfaces:

ICalendarReadTransport, ICalendarSendTransport, IMailSendTransport, IReadTransport, ISendTransport

public interface ITransport

This interface represents a 'groupware transport', which is nothing but a connector to a groupware server used for accessing/ maintaining different groupware items. This keeps the architecture generic and it is easy to plug in a new transport. There could be concrete implementations of the transport interfaces like MSExchangeCalendarTransport, or LotusDomino CalendarTransport etc..

Method Summary

String	getServerAlias() Returns the alias name of the server used by the transport.
GroupwareItemType	getSupportedItemType() Returns the groupware item type supported by the transport i.e Mail, Calendar, Task etc.
String	getTransportDescription(Locale locale) Returns the description of the groupware transport.
String	getTransportName() Returns the name of the groupware transport.
TransportType	getTransportType() Returns the transport type of the groupware transport i.e.
void	initialize(IGWResourceManager rManager, List configuration) Initializes the groupware transport with different congiguration properties.
void	terminate() Terminates the groupware transport.

Method Detail

getTransportType

public TransportType getTransportType()

Returns the transport type of the groupware transport i.e. READ, SEND or BOTH.

Returns:

transport type

getSupportedItemType

public GroupwareItemType getSupportedItemType()

Returns the groupware item type supported by the transport i.e Mail, Calendar, Task etc.

Returns:

groupware item type

getTransportName

public String getTransportName()

Returns the name of the groupware transport.

Returns:

transport name

getTransportDescription

public String getTransportDescription(Locale locale)

Returns the description of the groupware transport.

Parameters:

locale - locale information

Returns:

description Transport Description.

initialize

public void initialize(IGWResourceManager rManager,
                       List configuration)
                throws GroupwareException

Initializes the groupware transport with different congiguration properties.

Throws:

GroupwareException - If Transport is not Configured.

terminate

public void terminate()
               throws GroupwareException

Terminates the groupware transport.

Throws:

GroupwareException - When error occurs

getServerAlias

public String getServerAlias()

Returns the alias name of the server used by the transport.

Returns:

server name used by the transport.