|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.im.provider.ArchiveProvider
Archive Provider base class. Archives are used to keep a log of messages and other information processed by the server. If an archive provider is configured, it is invoked any time a message is handled by the server. This includes conference messages, notifications, invites, news messages, requests to join or leave a conference. This class does nothing other than providing placeholder for methods. Methods need to be overwritten in order for archiving to work. All archive providers must extend this class or subclass thereof.
Constructor Summary | |
ArchiveProvider()
|
Method Summary | |
void |
close()
close the archive and dispose of held resources |
void |
onClose(java.lang.String conferenceAddress,
java.lang.String uid)
invoked when a private conference is terminated |
void |
onConferenceMessage(java.lang.String conferenceAddress,
ReadOnlyMessage message)
invoked when a message is added to a conference |
void |
onInvite(java.lang.String conferenceAddress,
ReadOnlyMessage message)
invoked when a user creates a private conference |
void |
onJoin(java.lang.String conferenceAddress,
java.lang.String uid)
invoked when a user joins a conference |
void |
onLeave(java.lang.String conferenceAddress,
java.lang.String uid)
invoked when a user leaves conference |
void |
onLogin(java.lang.String uid)
invoked when a user signs on |
void |
onLogout(java.lang.String uid)
invoked when a user signs off |
void |
onMessage(java.util.List accessList,
ReadOnlyMessage message)
invoked when a message is handled by the server. |
void |
onMessage(ReadOnlyMessage message)
invoked when a message is handled by the server. |
void |
onSetup(java.lang.String conferenceAddress,
java.lang.String uid)
invoked when a user creates a private conference |
void |
open()
open the archive |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ArchiveProvider()
Method Detail |
public void onLogin(java.lang.String uid)
uid
- identifier of the authenticated userpublic void onLogout(java.lang.String uid)
uid
- user identifierpublic void onSetup(java.lang.String conferenceAddress, java.lang.String uid)
conferenceAddress
- address of the conferenceuid
- unique identifier of the user who setup
the conferencepublic void onJoin(java.lang.String conferenceAddress, java.lang.String uid)
conferenceAddress
- address of the conferenceuid
- unique identifier of the new participantpublic void onLeave(java.lang.String conferenceAddress, java.lang.String uid)
conferenceAddress
- address of the conferenceuid
- unique identifier of the leaving participantpublic void onClose(java.lang.String conferenceAddress, java.lang.String uid)
conferenceAddress
- address of the conferenceuid
- identifier of the user who closed the
conferencepublic void onInvite(java.lang.String conferenceAddress, ReadOnlyMessage message)
conferenceAddress
- address of the conferencemessage
- invite messagepublic void onMessage(ReadOnlyMessage message)
message
- messagecom.iplanet.collaboration.Message
public void onMessage(java.util.List accessList, ReadOnlyMessage message)
message
- messageaccessList
- list of user or group identifiers that should
have access to this archived message.com.iplanet.collaboration.Message
public void onConferenceMessage(java.lang.String conferenceAddress, ReadOnlyMessage message)
conferenceAddress
- address of the conferencemessage
- message
The originator address, message identifier,
message content, and other message attributes can be obtained
using the methods in the Message interface.com.iplanet.collaboration.Message
public void open() throws java.lang.Exception
java.lang.Exception
- failure to open and initialize the
archive.public void close()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |