org.jivesoftware.smackx.pep

Class PepManager

java.lang.Object

org.jivesoftware.smack.Manager

org.jivesoftware.smackx.pep.PepManager

public final class PepManager
extends org.jivesoftware.smack.Manager

Manages Personal Event Publishing (XEP-163). A PEPManager provides a high level access to PubSub personal events. It also provides an easy way to hook up custom logic when events are received from another XMPP client through PEPListeners. Use example:

   PepManager pepManager = PepManager.getInstanceFor(smackConnection);
   pepManager.addPepListener(new PepListener() {
       public void eventReceived(EntityBareJid from, EventElement event, Message message) {
           LOGGER.debug("Event received: " + event);
       }
   });
 

Method Summary

Modifier and Type	Method and Description
boolean	addPepListener(PepListener pepListener) Adds a listener to PEPs.
static PepManager	getInstanceFor(org.jivesoftware.smack.XMPPConnection connection)
PubSubManager	getPepPubSubManager()
boolean	isSupported()
void	publish(Item item, java.lang.String node) Publish an event.
boolean	removePepListener(PepListener pepListener) Removes a listener from PEP events.

Methods inherited from class org.jivesoftware.smack.Manager

connection, getAuthenticatedConnectionOrThrow, schedule

Methods inherited from class java.lang.Object

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

Method Detail

getInstanceFor

public static PepManager getInstanceFor(org.jivesoftware.smack.XMPPConnection connection)

getPepPubSubManager

public PubSubManager getPepPubSubManager()

addPepListener

public boolean addPepListener(PepListener pepListener)

Adds a listener to PEPs. The listener will be fired anytime PEP events are received from remote XMPP clients.

Parameters:

pepListener - a roster exchange listener.

Returns:

true if pepListener was added.

removePepListener

public boolean removePepListener(PepListener pepListener)

Removes a listener from PEP events.

Parameters:

pepListener - a roster exchange listener.

Returns:

true, if pepListener was removed.

publish

public void publish(Item item,
                    java.lang.String node)
             throws org.jivesoftware.smack.SmackException.NotConnectedException,
                    java.lang.InterruptedException,
                    org.jivesoftware.smack.SmackException.NoResponseException,
                    org.jivesoftware.smack.XMPPException.XMPPErrorException,
                    PubSubException.NotAPubSubNodeException,
                    PubSubException.NotALeafNodeException

Publish an event.

Parameters:

item - the item to publish.

node - the node to publish on.

Throws:

org.jivesoftware.smack.SmackException.NotConnectedException

java.lang.InterruptedException

org.jivesoftware.smack.XMPPException.XMPPErrorException

org.jivesoftware.smack.SmackException.NoResponseException

PubSubException.NotAPubSubNodeException

PubSubException.NotALeafNodeException

isSupported

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

Throws:

org.jivesoftware.smack.SmackException.NoResponseException

org.jivesoftware.smack.XMPPException.XMPPErrorException

org.jivesoftware.smack.SmackException.NotConnectedException

java.lang.InterruptedException