net.java.sip.communicator.impl.protocol.jabber.extensions.whiteboard
Class WhiteboardSessionPacketExtension

java.lang.Object
  net.java.sip.communicator.impl.protocol.jabber.extensions.whiteboard.WhiteboardSessionPacketExtension

All Implemented Interfaces:

org.jivesoftware.smack.packet.PacketExtension

public class WhiteboardSessionPacketExtension
extends Object
implements org.jivesoftware.smack.packet.PacketExtension

Whiteboard session packet extension.

Field Summary

static String	ACTION_LEAVE A type string constant indicating that the user would like to leave the current white board session.
static String	ELEMENT_NAME The name of the XML element used for transport of white-board parameters.
static String	NAMESPACE The names XMPP space that the white-board elements belong to.

Constructor Summary

WhiteboardSessionPacketExtension(String xml)
WhiteboardSessionPacketExtension constructor with a XML-SVG String.

WhiteboardSessionPacketExtension(WhiteboardSessionJabberImpl session, String contactAddress, String action)
Constructs and initializes a WhiteboardObjectPacketExtension.

Method Summary

String	getAction() Returns the action associated with this session packet extension.
String	getContactAddress() Returns the address of the contact associated with this packet extension
String	getElementName() Returns the root element name.
String	getNamespace() Returns the root element XML namespace.
String	getWhiteboardSessionId() Returns the white board session identifier.
void	setAction(String action) Sets the action associated with this session packet extension.
void	setContactAddress(String contactAddress) Sets the address of the contact associated with this packet extension
void	setWhiteboardSessionId(String whiteboardSessionId) Sets the white board session identifier.
String	toXML()

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_LEAVE

public static final String ACTION_LEAVE

A type string constant indicating that the user would like to leave the current white board session.

See Also:

Constant Field Values

ELEMENT_NAME

public static final String ELEMENT_NAME

The name of the XML element used for transport of white-board parameters.

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

The names XMPP space that the white-board elements belong to.

See Also:

Constant Field Values

Constructor Detail

WhiteboardSessionPacketExtension

public WhiteboardSessionPacketExtension(WhiteboardSessionJabberImpl session,
                                        String contactAddress,
                                        String action)

Constructs and initializes a WhiteboardObjectPacketExtension.

Parameters:

session - The WhiteboardSession to be treated

contactAddress - The address of the contact associated with this packet extension

action - The current action associated with the WhiteboardSession.

WhiteboardSessionPacketExtension

public WhiteboardSessionPacketExtension(String xml)

WhiteboardSessionPacketExtension constructor with a XML-SVG String.

Parameters:

xml - XML-SVG String

Method Detail

getElementName

public String getElementName()

Returns the root element name.

Specified by:

getElementName in interface org.jivesoftware.smack.packet.PacketExtension

Returns:

the element name.

getNamespace

public String getNamespace()

Returns the root element XML namespace.

Specified by:

getNamespace in interface org.jivesoftware.smack.packet.PacketExtension

Returns:

the namespace.

toXML

public String toXML()

Specified by:

toXML in interface org.jivesoftware.smack.packet.PacketExtension

getWhiteboardSessionId

public String getWhiteboardSessionId()

Returns the white board session identifier.

Returns:

the white board session identifier

setWhiteboardSessionId

public void setWhiteboardSessionId(String whiteboardSessionId)

Sets the white board session identifier.

Parameters:

whiteboardSessionId - the identifier of the session

getAction

public String getAction()

Returns the action associated with this session packet extension.

Returns:

the action associated with this session packet extension.

setAction

public void setAction(String action)

Sets the action associated with this session packet extension.

Parameters:

action - the action associated with this session packet extension.

getContactAddress

public String getContactAddress()

Returns the address of the contact associated with this packet extension

Returns:

the address of the contact associated with this packet extension

setContactAddress

public void setContactAddress(String contactAddress)

Sets the address of the contact associated with this packet extension

Parameters:

contactAddress - the address of the contact associated with this packet extension