org.jivesoftware.smackx.carbons

Class CarbonManager

java.lang.Object

org.jivesoftware.smack.Manager

org.jivesoftware.smackx.carbons.CarbonManager

public class CarbonManager
extends Manager

Packet extension for XEP-0280: Message Carbons. This class implements the manager for registering CarbonExtension support, enabling and disabling message carbons. You should call enableCarbons() before sending your first undirected presence.

Method Summary

Methods

Modifier and Type	Method and Description
void	disableCarbons() Helper method to disable carbons.
static void	disableCarbons(Message msg) Mark a message as "private", so it will not be carbon-copied.
void	enableCarbons() Helper method to enable carbons.
static CarbonExtension	getCarbon(Message msg) Obtain a Carbon from a message, if available.
boolean	getCarbonsEnabled() Check if carbons are enabled on this connection.
static CarbonManager	getInstanceFor(XMPPConnection connection) Obtain the CarbonManager responsible for a connection.
boolean	isSupportedByServer() Returns true if XMPP Carbons are supported by the server.
void	sendCarbonsEnabled(boolean new_state) Notify server to change the carbons state.
void	setCarbonsEnabled(boolean new_state) Notify server to change the carbons state.

Methods inherited from class org.jivesoftware.smack.Manager

connection, schedule

Methods inherited from class java.lang.Object

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

Method Detail

getInstanceFor

public static CarbonManager getInstanceFor(XMPPConnection connection)

Obtain the CarbonManager responsible for a connection.

Parameters:

connection - the connection object.

Returns:

a CarbonManager instance

isSupportedByServer

public boolean isSupportedByServer()
                            throws XMPPException,
                                   SmackException

Returns true if XMPP Carbons are supported by the server.

Returns:

true if supported

Throws:

SmackException - if there was no response from the server.

XMPPException

sendCarbonsEnabled

public void sendCarbonsEnabled(boolean new_state)
                        throws SmackException.NotConnectedException

Notify server to change the carbons state. This method returns immediately and changes the variable when the reply arrives. You should first check for support using isSupportedByServer().

Parameters:

new_state - whether carbons should be enabled or disabled

Throws:

SmackException.NotConnectedException

setCarbonsEnabled

public void setCarbonsEnabled(boolean new_state)
                       throws SmackException.NoResponseException,
                              XMPPException.XMPPErrorException,
                              SmackException.NotConnectedException

Notify server to change the carbons state. This method blocks some time until the server replies to the IQ and returns true on success. You should first check for support using isSupportedByServer().

Parameters:

new_state - whether carbons should be enabled or disabled

Throws:

XMPPException.XMPPErrorException

SmackException.NoResponseException

SmackException.NotConnectedException

enableCarbons

public void enableCarbons()
                   throws XMPPException,
                          SmackException

Helper method to enable carbons.

Throws:

XMPPException

SmackException - if there was no response from the server.

disableCarbons

public void disableCarbons()
                    throws XMPPException,
                           SmackException

Helper method to disable carbons.

Throws:

XMPPException

SmackException - if there was no response from the server.

getCarbonsEnabled

public boolean getCarbonsEnabled()

Check if carbons are enabled on this connection.

getCarbon

public static CarbonExtension getCarbon(Message msg)

Obtain a Carbon from a message, if available.

Parameters:

msg - Message object to check for carbons

Returns:

a Carbon if available, null otherwise.

disableCarbons

public static void disableCarbons(Message msg)

Mark a message as "private", so it will not be carbon-copied.

Parameters:

msg - Message object to mark private