Package org.jivesoftware.smackx.muclight

Class MultiUserChatLightManager

java.lang.Object

org.jivesoftware.smack.Manager

org.jivesoftware.smackx.muclight.MultiUserChatLightManager

public final class MultiUserChatLightManager
extends Manager

Multi-User Chat Light manager class.

Method Summary

Modifier and Type	Method	Description
void	blockRoom(DomainBareJid mucLightService, Jid roomJid)	Block a room.
void	blockRooms(DomainBareJid mucLightService, List<Jid> roomsJids)	Block rooms.
void	blockUser(DomainBareJid mucLightService, Jid userJid)	Block a user.
void	blockUsers(DomainBareJid mucLightService, List<Jid> usersJids)	Block users.
static MultiUserChatLightManager	getInstanceFor(XMPPConnection connection)	Get a instance of a MUC Light manager for the given connection.
List<DomainBareJid>	getLocalServices()	Returns a collection with the XMPP addresses of the MUC Light services.
MultiUserChatLight	getMultiUserChatLight(EntityBareJid jid)	Obtain the MUC Light.
List<Jid>	getOccupiedRooms(DomainBareJid mucLightService)	Returns a List of the rooms the user occupies.
List<Jid>	getRoomsBlocked(DomainBareJid mucLightService)	Get rooms blocked.
List<Jid>	getUsersAndRoomsBlocked(DomainBareJid mucLightService)	Get users and rooms blocked.
List<Jid>	getUsersBlocked(DomainBareJid mucLightService)	Get users blocked.
boolean	isFeatureSupported(DomainBareJid mucLightService)	Returns true if Multi-User Chat Light feature is supported by the server.
void	unblockRoom(DomainBareJid mucLightService, Jid roomJid)	Unblock a room.
void	unblockRooms(DomainBareJid mucLightService, List<Jid> roomsJids)	Unblock rooms.
void	unblockUser(DomainBareJid mucLightService, Jid userJid)	Unblock a user.
void	unblockUsers(DomainBareJid mucLightService, List<Jid> usersJids)	Unblock users.

Methods inherited from class org.jivesoftware.smack.Manager

connection, getAuthenticatedConnectionOrThrow, schedule, schedule, scheduleBlocking

Methods inherited from class java.lang.Object

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

Method Detail

getInstanceFor

public static MultiUserChatLightManager getInstanceFor(XMPPConnection connection)

Get a instance of a MUC Light manager for the given connection.

Parameters:

connection - TODO javadoc me please

Returns:

a MUCLight manager.

getMultiUserChatLight

public MultiUserChatLight getMultiUserChatLight(EntityBareJid jid)

Obtain the MUC Light.

Parameters:

jid - TODO javadoc me please

Returns:

the MUCLight.

isFeatureSupported

public boolean isFeatureSupported(DomainBareJid mucLightService)
                           throws SmackException.NoResponseException,
                                  XMPPException.XMPPErrorException,
                                  SmackException.NotConnectedException,
                                  InterruptedException

Returns true if Multi-User Chat Light feature is supported by the server.

Parameters:

mucLightService - TODO javadoc me please

Returns:

true if Multi-User Chat Light feature is supported by the server.

Throws:

SmackException.NotConnectedException - if the XMPP connection is not connected.

XMPPException.XMPPErrorException - if there was an XMPP error returned.

SmackException.NoResponseException - if there was no response from the remote entity.

InterruptedException - if the calling thread was interrupted.

getOccupiedRooms

public List<Jid> getOccupiedRooms(DomainBareJid mucLightService)
                           throws SmackException.NoResponseException,
                                  XMPPException.XMPPErrorException,
                                  SmackException.NotConnectedException,
                                  InterruptedException

Returns a List of the rooms the user occupies.

Parameters:

mucLightService - TODO javadoc me please

Returns:

a List of the rooms the user occupies.

Throws:

XMPPException.XMPPErrorException - if there was an XMPP error returned.

SmackException.NoResponseException - if there was no response from the remote entity.

SmackException.NotConnectedException - if the XMPP connection is not connected.

InterruptedException - if the calling thread was interrupted.

getLocalServices

public List<DomainBareJid> getLocalServices()
                                     throws SmackException.NoResponseException,
                                            XMPPException.XMPPErrorException,
                                            SmackException.NotConnectedException,
                                            InterruptedException

Returns a collection with the XMPP addresses of the MUC Light services.

Returns:

a collection with the XMPP addresses of the MUC Light services.

Throws:

XMPPException.XMPPErrorException - if there was an XMPP error returned.

SmackException.NoResponseException - if there was no response from the remote entity.

SmackException.NotConnectedException - if the XMPP connection is not connected.

InterruptedException - if the calling thread was interrupted.

getUsersAndRoomsBlocked

public List<Jid> getUsersAndRoomsBlocked(DomainBareJid mucLightService)
                                  throws SmackException.NoResponseException,
                                         XMPPException.XMPPErrorException,
                                         SmackException.NotConnectedException,
                                         InterruptedException

Get users and rooms blocked.

Parameters:

mucLightService - TODO javadoc me please

Returns:

the list of users and rooms blocked

Throws:

SmackException.NoResponseException - if there was no response from the remote entity.

XMPPException.XMPPErrorException - if there was an XMPP error returned.

SmackException.NotConnectedException - if the XMPP connection is not connected.

InterruptedException - if the calling thread was interrupted.

getRoomsBlocked

public List<Jid> getRoomsBlocked(DomainBareJid mucLightService)
                          throws SmackException.NoResponseException,
                                 XMPPException.XMPPErrorException,
                                 SmackException.NotConnectedException,
                                 InterruptedException

Get rooms blocked.

Parameters:

mucLightService - TODO javadoc me please

Returns:

the list of rooms blocked

Throws:

SmackException.NoResponseException - if there was no response from the remote entity.

XMPPException.XMPPErrorException - if there was an XMPP error returned.

SmackException.NotConnectedException - if the XMPP connection is not connected.

InterruptedException - if the calling thread was interrupted.

getUsersBlocked

public List<Jid> getUsersBlocked(DomainBareJid mucLightService)
                          throws SmackException.NoResponseException,
                                 XMPPException.XMPPErrorException,
                                 SmackException.NotConnectedException,
                                 InterruptedException

Get users blocked.

Parameters:

mucLightService - TODO javadoc me please

Returns:

the list of users blocked

Throws:

SmackException.NoResponseException - if there was no response from the remote entity.

XMPPException.XMPPErrorException - if there was an XMPP error returned.

SmackException.NotConnectedException - if the XMPP connection is not connected.

InterruptedException - if the calling thread was interrupted.

blockRoom

public void blockRoom(DomainBareJid mucLightService,
                      Jid roomJid)
               throws SmackException.NoResponseException,
                      XMPPException.XMPPErrorException,
                      SmackException.NotConnectedException,
                      InterruptedException

Block a room.

Parameters:

mucLightService - TODO javadoc me please

roomJid - TODO javadoc me please

Throws:

SmackException.NoResponseException - if there was no response from the remote entity.

XMPPException.XMPPErrorException - if there was an XMPP error returned.

SmackException.NotConnectedException - if the XMPP connection is not connected.

InterruptedException - if the calling thread was interrupted.

blockRooms

public void blockRooms(DomainBareJid mucLightService,
                       List<Jid> roomsJids)
                throws SmackException.NoResponseException,
                       XMPPException.XMPPErrorException,
                       SmackException.NotConnectedException,
                       InterruptedException

Block rooms.

Parameters:

mucLightService - TODO javadoc me please

roomsJids - TODO javadoc me please

Throws:

SmackException.NoResponseException - if there was no response from the remote entity.

XMPPException.XMPPErrorException - if there was an XMPP error returned.

SmackException.NotConnectedException - if the XMPP connection is not connected.

InterruptedException - if the calling thread was interrupted.

blockUser

public void blockUser(DomainBareJid mucLightService,
                      Jid userJid)
               throws SmackException.NoResponseException,
                      XMPPException.XMPPErrorException,
                      SmackException.NotConnectedException,
                      InterruptedException

Block a user.

Parameters:

mucLightService - TODO javadoc me please

userJid - TODO javadoc me please

Throws:

SmackException.NoResponseException - if there was no response from the remote entity.

XMPPException.XMPPErrorException - if there was an XMPP error returned.

SmackException.NotConnectedException - if the XMPP connection is not connected.

InterruptedException - if the calling thread was interrupted.

blockUsers

public void blockUsers(DomainBareJid mucLightService,
                       List<Jid> usersJids)
                throws SmackException.NoResponseException,
                       XMPPException.XMPPErrorException,
                       SmackException.NotConnectedException,
                       InterruptedException

Block users.

Parameters:

mucLightService - TODO javadoc me please

usersJids - TODO javadoc me please

Throws:

SmackException.NoResponseException - if there was no response from the remote entity.

XMPPException.XMPPErrorException - if there was an XMPP error returned.

SmackException.NotConnectedException - if the XMPP connection is not connected.

InterruptedException - if the calling thread was interrupted.

unblockRoom

public void unblockRoom(DomainBareJid mucLightService,
                        Jid roomJid)
                 throws SmackException.NoResponseException,
                        XMPPException.XMPPErrorException,
                        SmackException.NotConnectedException,
                        InterruptedException

Unblock a room.

Parameters:

mucLightService - TODO javadoc me please

roomJid - TODO javadoc me please

Throws:

SmackException.NoResponseException - if there was no response from the remote entity.

XMPPException.XMPPErrorException - if there was an XMPP error returned.

SmackException.NotConnectedException - if the XMPP connection is not connected.

InterruptedException - if the calling thread was interrupted.

unblockRooms

public void unblockRooms(DomainBareJid mucLightService,
                         List<Jid> roomsJids)
                  throws SmackException.NoResponseException,
                         XMPPException.XMPPErrorException,
                         SmackException.NotConnectedException,
                         InterruptedException

Unblock rooms.

Parameters:

mucLightService - TODO javadoc me please

roomsJids - TODO javadoc me please

Throws:

SmackException.NoResponseException - if there was no response from the remote entity.

XMPPException.XMPPErrorException - if there was an XMPP error returned.

SmackException.NotConnectedException - if the XMPP connection is not connected.

InterruptedException - if the calling thread was interrupted.

unblockUser

public void unblockUser(DomainBareJid mucLightService,
                        Jid userJid)
                 throws SmackException.NoResponseException,
                        XMPPException.XMPPErrorException,
                        SmackException.NotConnectedException,
                        InterruptedException

Unblock a user.

Parameters:

mucLightService - TODO javadoc me please

userJid - TODO javadoc me please

Throws:

SmackException.NoResponseException - if there was no response from the remote entity.

XMPPException.XMPPErrorException - if there was an XMPP error returned.

SmackException.NotConnectedException - if the XMPP connection is not connected.

InterruptedException - if the calling thread was interrupted.

unblockUsers

public void unblockUsers(DomainBareJid mucLightService,
                         List<Jid> usersJids)
                  throws SmackException.NoResponseException,
                         XMPPException.XMPPErrorException,
                         SmackException.NotConnectedException,
                         InterruptedException

Unblock users.

Parameters:

mucLightService - TODO javadoc me please

usersJids - TODO javadoc me please

Throws:

SmackException.NoResponseException - if there was no response from the remote entity.

XMPPException.XMPPErrorException - if there was an XMPP error returned.

SmackException.NotConnectedException - if the XMPP connection is not connected.

InterruptedException - if the calling thread was interrupted.