org.jivesoftware.smackx.mam

Class MamManager

java.lang.Object

org.jivesoftware.smack.Manager

org.jivesoftware.smackx.mam.MamManager

public final class MamManager
extends Manager

A Manager for Message Archive Management (XEP-0313).

See Also:

XEP-0313: Message Archive Management

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MamManager.MamPrefsResult MAM preferences result class.
static class	MamManager.MamQueryResult MAM query result class.

Method Summary

Modifier and Type	Method and Description
static MamManager	getInstanceFor(XMPPConnection connection) Get the singleton instance of MamManager.
static MamManager	getInstanceFor(XMPPConnection connection, Jid archiveAddress)
boolean	isSupported() Check if MAM is supported for the XMPP connection managed by this MamManager.
boolean	isSupportedByServer() Deprecated. use isSupported() instead.
MamManager.MamQueryResult	mostRecentPage(Jid chatJid, int max) Obtain the most recent page of a chat.
MamManager.MamQueryResult	page(DataForm dataForm, RSMSet rsmSet) Returns a page of the archive.
MamManager.MamQueryResult	page(java.lang.String node, DataForm dataForm, RSMSet rsmSet) Returns a page of the archive.
MamManager.MamQueryResult	pageAfter(Jid chatJid, java.lang.String messageUid, int max) Obtain page after the last message saved (specific chat).
MamManager.MamQueryResult	pageBefore(Jid chatJid, java.lang.String messageUid, int max) Obtain page before the first message saved (specific chat).
MamManager.MamQueryResult	pageNext(MamManager.MamQueryResult mamQueryResult, int count) Returns the next page of the archive.
MamManager.MamQueryResult	pagePrevious(MamManager.MamQueryResult mamQueryResult, int count) Returns the previous page of the archive.
MamManager.MamQueryResult	queryArchive(java.util.Date start, java.util.Date end) Query archive filtering by start and/or end date.
MamManager.MamQueryResult	queryArchive(java.lang.Integer max) Query archive with a maximum amount of results.
MamManager.MamQueryResult	queryArchive(java.lang.Integer max, java.util.Date start, java.util.Date end, Jid withJid, java.util.List<FormField> additionalFields) Query archive applying filters: max count, start date, end date, from/to JID and with additional fields.
MamManager.MamQueryResult	queryArchive(Jid withJid) Query archive with a JID (only messages from/to the JID).
MamManager.MamQueryResult	queryArchive(java.util.List<FormField> additionalFields) Query Archive adding filters with additional fields.
MamManager.MamQueryResult	queryArchive(java.lang.String node, java.lang.Integer max, java.util.Date start, java.util.Date end, Jid withJid, java.util.List<FormField> additionalFields) Query an message archive like a MUC archive or a PubSub node archive, addressed by an archiveAddress, applying filters: max count, start date, end date, from/to JID and with additional fields.
MamManager.MamQueryResult	queryArchiveWithEndDate(java.util.Date end) Query archive filtering by end date.
MamManager.MamQueryResult	queryArchiveWithStartDate(java.util.Date start) Query archive filtering by start date.
MamManager.MamPrefsResult	retrieveArchivingPreferences() Get the preferences stored in the server.
java.util.List<FormField>	retrieveFormFields() Get the form fields supported by the server.
java.util.List<FormField>	retrieveFormFields(java.lang.String node) Get the form fields supported by the server.
MamManager.MamPrefsResult	updateArchivingPreferences(java.util.List<Jid> alwaysJids, java.util.List<Jid> neverJids, MamPrefsIQ.DefaultBehavior defaultBehavior) Update the preferences in the server.

Methods inherited from class org.jivesoftware.smack.Manager

connection, getAuthenticatedConnectionOrThrow

Methods inherited from class java.lang.Object

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

Method Detail

getInstanceFor

public static MamManager getInstanceFor(XMPPConnection connection)

Get the singleton instance of MamManager.

Parameters:

connection -

Returns:

the instance of MamManager

getInstanceFor

public static MamManager getInstanceFor(XMPPConnection connection,
                                        Jid archiveAddress)

queryArchive

public MamManager.MamQueryResult queryArchive(java.lang.Integer max)
                                       throws SmackException.NoResponseException,
                                              XMPPException.XMPPErrorException,
                                              SmackException.NotConnectedException,
                                              java.lang.InterruptedException,
                                              SmackException.NotLoggedInException

Query archive with a maximum amount of results.

Parameters:

max -

Returns:

the MAM query result

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

java.lang.InterruptedException

SmackException.NotLoggedInException

queryArchive

public MamManager.MamQueryResult queryArchive(Jid withJid)
                                       throws SmackException.NoResponseException,
                                              XMPPException.XMPPErrorException,
                                              SmackException.NotConnectedException,
                                              java.lang.InterruptedException,
                                              SmackException.NotLoggedInException

Query archive with a JID (only messages from/to the JID).

Parameters:

withJid -

Returns:

the MAM query result

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

java.lang.InterruptedException

SmackException.NotLoggedInException

queryArchive

public MamManager.MamQueryResult queryArchive(java.util.Date start,
                                              java.util.Date end)
                                       throws SmackException.NoResponseException,
                                              XMPPException.XMPPErrorException,
                                              SmackException.NotConnectedException,
                                              java.lang.InterruptedException,
                                              SmackException.NotLoggedInException

Query archive filtering by start and/or end date. If start == null, the value of 'start' will be equal to the date/time of the earliest message stored in the archive. If end == null, the value of 'end' will be equal to the date/time of the most recent message stored in the archive.

Parameters:

start -

end -

Returns:

the MAM query result

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

java.lang.InterruptedException

SmackException.NotLoggedInException

queryArchive

public MamManager.MamQueryResult queryArchive(java.util.List<FormField> additionalFields)
                                       throws SmackException.NoResponseException,
                                              XMPPException.XMPPErrorException,
                                              SmackException.NotConnectedException,
                                              java.lang.InterruptedException,
                                              SmackException.NotLoggedInException

Query Archive adding filters with additional fields.

Parameters:

additionalFields -

Returns:

the MAM query result

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

java.lang.InterruptedException

SmackException.NotLoggedInException

queryArchiveWithStartDate

public MamManager.MamQueryResult queryArchiveWithStartDate(java.util.Date start)
                                                    throws SmackException.NoResponseException,
                                                           XMPPException.XMPPErrorException,
                                                           SmackException.NotConnectedException,
                                                           java.lang.InterruptedException,
                                                           SmackException.NotLoggedInException

Query archive filtering by start date. The value of 'end' will be equal to the date/time of the most recent message stored in the archive.

Parameters:

start -

Returns:

the MAM query result

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

java.lang.InterruptedException

SmackException.NotLoggedInException

queryArchiveWithEndDate

public MamManager.MamQueryResult queryArchiveWithEndDate(java.util.Date end)
                                                  throws SmackException.NoResponseException,
                                                         XMPPException.XMPPErrorException,
                                                         SmackException.NotConnectedException,
                                                         java.lang.InterruptedException,
                                                         SmackException.NotLoggedInException

Query archive filtering by end date. The value of 'start' will be equal to the date/time of the earliest message stored in the archive.

Parameters:

end -

Returns:

the MAM query result

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

java.lang.InterruptedException

SmackException.NotLoggedInException

queryArchive

public MamManager.MamQueryResult queryArchive(java.lang.Integer max,
                                              java.util.Date start,
                                              java.util.Date end,
                                              Jid withJid,
                                              java.util.List<FormField> additionalFields)
                                       throws SmackException.NoResponseException,
                                              XMPPException.XMPPErrorException,
                                              SmackException.NotConnectedException,
                                              java.lang.InterruptedException,
                                              SmackException.NotLoggedInException

Query archive applying filters: max count, start date, end date, from/to JID and with additional fields.

Parameters:

max -

start -

end -

withJid -

additionalFields -

Returns:

the MAM query result

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

java.lang.InterruptedException

SmackException.NotLoggedInException

queryArchive

public MamManager.MamQueryResult queryArchive(java.lang.String node,
                                              java.lang.Integer max,
                                              java.util.Date start,
                                              java.util.Date end,
                                              Jid withJid,
                                              java.util.List<FormField> additionalFields)
                                       throws SmackException.NoResponseException,
                                              XMPPException.XMPPErrorException,
                                              SmackException.NotConnectedException,
                                              java.lang.InterruptedException,
                                              SmackException.NotLoggedInException

Query an message archive like a MUC archive or a PubSub node archive, addressed by an archiveAddress, applying filters: max count, start date, end date, from/to JID and with additional fields. When archiveAddress is null the default, the server will be requested.

Parameters:

node - The PubSub node name, can be null

max -

start -

end -

withJid -

additionalFields -

Returns:

the MAM query result

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

java.lang.InterruptedException

SmackException.NotLoggedInException

page

public MamManager.MamQueryResult page(DataForm dataForm,
                                      RSMSet rsmSet)
                               throws SmackException.NoResponseException,
                                      XMPPException.XMPPErrorException,
                                      SmackException.NotConnectedException,
                                      java.lang.InterruptedException,
                                      SmackException.NotLoggedInException

Returns a page of the archive.

Parameters:

dataForm -

rsmSet -

Returns:

the MAM query result

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

java.lang.InterruptedException

SmackException.NotLoggedInException

page

public MamManager.MamQueryResult page(java.lang.String node,
                                      DataForm dataForm,
                                      RSMSet rsmSet)
                               throws SmackException.NoResponseException,
                                      XMPPException.XMPPErrorException,
                                      SmackException.NotConnectedException,
                                      java.lang.InterruptedException,
                                      SmackException.NotLoggedInException

Returns a page of the archive.

Parameters:

node - The PubSub node name, can be null

dataForm -

rsmSet -

Returns:

the MAM query result

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

java.lang.InterruptedException

SmackException.NotLoggedInException

pageNext

public MamManager.MamQueryResult pageNext(MamManager.MamQueryResult mamQueryResult,
                                          int count)
                                   throws SmackException.NoResponseException,
                                          XMPPException.XMPPErrorException,
                                          SmackException.NotConnectedException,
                                          java.lang.InterruptedException,
                                          SmackException.NotLoggedInException

Returns the next page of the archive.

Parameters:

mamQueryResult - is the previous query result

count - is the amount of messages that a page contains

Returns:

the MAM query result

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

java.lang.InterruptedException

SmackException.NotLoggedInException

pagePrevious

public MamManager.MamQueryResult pagePrevious(MamManager.MamQueryResult mamQueryResult,
                                              int count)
                                       throws SmackException.NoResponseException,
                                              XMPPException.XMPPErrorException,
                                              SmackException.NotConnectedException,
                                              java.lang.InterruptedException,
                                              SmackException.NotLoggedInException

Returns the previous page of the archive.

Parameters:

mamQueryResult - is the previous query result

count - is the amount of messages that a page contains

Returns:

the MAM query result

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

java.lang.InterruptedException

SmackException.NotLoggedInException

pageBefore

public MamManager.MamQueryResult pageBefore(Jid chatJid,
                                            java.lang.String messageUid,
                                            int max)
                                     throws XMPPException.XMPPErrorException,
                                            SmackException.NotLoggedInException,
                                            SmackException.NotConnectedException,
                                            java.lang.InterruptedException,
                                            SmackException.NoResponseException

Obtain page before the first message saved (specific chat).

Note that the messageUid is the XEP-0313 UID and not the stanza ID of the message.

Parameters:

chatJid -

messageUid - the UID of the message of which messages before should be received.

max -

Returns:

the MAM query result

Throws:

XMPPException.XMPPErrorException

SmackException.NotLoggedInException

SmackException.NotConnectedException

java.lang.InterruptedException

SmackException.NoResponseException

pageAfter

public MamManager.MamQueryResult pageAfter(Jid chatJid,
                                           java.lang.String messageUid,
                                           int max)
                                    throws XMPPException.XMPPErrorException,
                                           SmackException.NotLoggedInException,
                                           SmackException.NotConnectedException,
                                           java.lang.InterruptedException,
                                           SmackException.NoResponseException

Obtain page after the last message saved (specific chat).

Note that the messageUid is the XEP-0313 UID and not the stanza ID of the message.

Parameters:

chatJid -

messageUid - the UID of the message of which messages after should be received.

max -

Returns:

the MAM query result

Throws:

XMPPException.XMPPErrorException

SmackException.NotLoggedInException

SmackException.NotConnectedException

java.lang.InterruptedException

SmackException.NoResponseException

mostRecentPage

public MamManager.MamQueryResult mostRecentPage(Jid chatJid,
                                                int max)
                                         throws XMPPException.XMPPErrorException,
                                                SmackException.NotLoggedInException,
                                                SmackException.NotConnectedException,
                                                java.lang.InterruptedException,
                                                SmackException.NoResponseException

Obtain the most recent page of a chat.

Parameters:

chatJid -

max -

Returns:

the MAM query result

Throws:

XMPPException.XMPPErrorException

SmackException.NotLoggedInException

SmackException.NotConnectedException

java.lang.InterruptedException

SmackException.NoResponseException

retrieveFormFields

public java.util.List<FormField> retrieveFormFields()
                                             throws SmackException.NoResponseException,
                                                    XMPPException.XMPPErrorException,
                                                    SmackException.NotConnectedException,
                                                    java.lang.InterruptedException,
                                                    SmackException.NotLoggedInException

Get the form fields supported by the server.

Returns:

the list of form fields.

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

java.lang.InterruptedException

SmackException.NotLoggedInException

retrieveFormFields

public java.util.List<FormField> retrieveFormFields(java.lang.String node)
                                             throws SmackException.NoResponseException,
                                                    XMPPException.XMPPErrorException,
                                                    SmackException.NotConnectedException,
                                                    java.lang.InterruptedException,
                                                    SmackException.NotLoggedInException

Get the form fields supported by the server.

Parameters:

node - The PubSub node name, can be null

Returns:

the list of form fields.

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

java.lang.InterruptedException

SmackException.NotLoggedInException

isSupported

public boolean isSupported()
                    throws SmackException.NoResponseException,
                           XMPPException.XMPPErrorException,
                           SmackException.NotConnectedException,
                           java.lang.InterruptedException

Check if MAM is supported for the XMPP connection managed by this MamManager.

Returns:

true if MAM is supported for the XMPP connection, falseotherwhise.

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

java.lang.InterruptedException

Since:

4.2.1

See Also:

XEP-0313 § 7. Determining support

isSupportedByServer

@Deprecated
public boolean isSupportedByServer()
                                        throws SmackException.NoResponseException,
                                               XMPPException.XMPPErrorException,
                                               SmackException.NotConnectedException,
                                               java.lang.InterruptedException

Deprecated. use isSupported() instead.

Returns true if Message Archive Management is supported by the server.

Returns:

true if Message Archive Management is supported by the server.

Throws:

SmackException.NotConnectedException

XMPPException.XMPPErrorException

SmackException.NoResponseException

java.lang.InterruptedException

retrieveArchivingPreferences

public MamManager.MamPrefsResult retrieveArchivingPreferences()
                                                       throws SmackException.NoResponseException,
                                                              XMPPException.XMPPErrorException,
                                                              SmackException.NotConnectedException,
                                                              java.lang.InterruptedException,
                                                              SmackException.NotLoggedInException

Get the preferences stored in the server.

Returns:

the MAM preferences result

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

java.lang.InterruptedException

SmackException.NotLoggedInException

updateArchivingPreferences

public MamManager.MamPrefsResult updateArchivingPreferences(java.util.List<Jid> alwaysJids,
                                                            java.util.List<Jid> neverJids,
                                                            MamPrefsIQ.DefaultBehavior defaultBehavior)
                                                     throws SmackException.NoResponseException,
                                                            XMPPException.XMPPErrorException,
                                                            SmackException.NotConnectedException,
                                                            java.lang.InterruptedException,
                                                            SmackException.NotLoggedInException

Update the preferences in the server.

Parameters:

alwaysJids - is the list of JIDs that should always have messages to/from archived in the user's store

neverJids - is the list of JIDs that should never have messages to/from archived in the user's store

defaultBehavior - can be "roster", "always", "never" (see XEP-0313)

Returns:

the MAM preferences result

Throws:

SmackException.NoResponseException

XMPPException.XMPPErrorException

SmackException.NotConnectedException

java.lang.InterruptedException

SmackException.NotLoggedInException