public abstract static class ColibriConferenceIQ.ChannelCommon
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CHANNEL_BUNDLE_ID_ATTR_NAME
The name of the "channel-bundle-id" attribute.
|
static java.lang.String |
ENDPOINT_ATTR_NAME
The XML name of the endpoint attribute which specifies the
optional identifier of the endpoint of the conference participant
associated with a channel.
|
static java.lang.String |
EXPIRE_ATTR_NAME
The XML name of the expire attribute of a channel
of a content of a conference IQ which represents
the value of the expire property of
ColibriConferenceIQ.Channel.
|
static int |
EXPIRE_NOT_SPECIFIED
The value of the expire property of
ColibriConferenceIQ.Channel which indicates that no actual
value has been specified for the property in question.
|
static java.lang.String |
ID_ATTR_NAME
The XML name of the id attribute of a channel of a
content of a conference IQ which represents the
value of the id property of
ColibriConferenceIQ.Channel.
|
static java.lang.String |
INITIATOR_ATTR_NAME
The XML name of the initiator attribute of a
channel of a content of a conference IQ
which represents the value of the initiator property of
ColibriConferenceIQ.Channel.
|
Modifier | Constructor and Description |
---|---|
protected |
ChannelCommon(java.lang.String elementName)
Initializes this class with given XML elementName.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getChannelBundleId()
Get the channel-bundle-id attribute of this CommonChannel.
|
java.lang.String |
getEndpoint()
Gets the identifier of the endpoint of the conference participant
associated with this Channel.
|
int |
getExpire()
Gets the number of seconds of inactivity after which the
channel represented by this instance expires.
|
java.lang.String |
getID()
Gets the ID of the channel represented by this instance.
|
IceUdpTransportPacketExtension |
getTransport() |
protected abstract boolean |
hasContent()
Indicates whether there are some contents that should be printed as
child elements of this IQ.
|
java.lang.Boolean |
isInitiator()
Gets the indicator which determines whether the conference focus is
the initiator/offerer (as opposed to the responder/answerer) of the
media negotiation associated with this instance.
|
protected abstract void |
printAttributes(java.lang.StringBuilder xml)
Derived class implements this method in order to print additional
attributes to main XML element.
|
protected abstract void |
printContent(java.lang.StringBuilder xml)
Implement in order to print content child elements of this IQ using
given StringBuilder.
|
void |
setChannelBundleId(java.lang.String channelBundleId)
Sets the channel-bundle-id attribute of this CommonChannel.
|
void |
setEndpoint(java.lang.String endpoint)
Sets the identifier of the endpoint of the conference participant
associated with this Channel.
|
void |
setExpire(int expire)
Sets the number of seconds of inactivity after which the
channel represented by this instance expires.
|
void |
setID(java.lang.String id) |
void |
setInitiator(java.lang.Boolean initiator)
Sets the indicator which determines whether the conference focus is
the initiator/offerer (as opposed to the responder/answerer) of the
media negotiation associated with this instance.
|
void |
setTransport(IceUdpTransportPacketExtension transport) |
void |
toXML(java.lang.StringBuilder xml)
Appends the XML String representation of this
Channel to a specific StringBuilder.
|
public static final java.lang.String CHANNEL_BUNDLE_ID_ATTR_NAME
public static final java.lang.String ENDPOINT_ATTR_NAME
public static final java.lang.String EXPIRE_ATTR_NAME
public static final int EXPIRE_NOT_SPECIFIED
public static final java.lang.String ID_ATTR_NAME
public static final java.lang.String INITIATOR_ATTR_NAME
protected ChannelCommon(java.lang.String elementName)
elementName
- XML element name to be used for producing XML
representation of derived IQ class.public java.lang.String getChannelBundleId()
public java.lang.String getEndpoint()
public int getExpire()
public java.lang.String getID()
public IceUdpTransportPacketExtension getTransport()
protected abstract boolean hasContent()
printContent(StringBuilder)
method will be called when
XML representation of this IQ is being constructed.public java.lang.Boolean isInitiator()
Boolean.TRUE
if the conference focus is the
initiator/offerer of the media negotiation associated with this
instance, Boolean.FALSE
if the conference focus is the
responder/answerer or null if the initiator state
is unspecifiedprotected abstract void printAttributes(java.lang.StringBuilder xml)
xml
- protected abstract void printContent(java.lang.StringBuilder xml)
hasContent()
returns true.xml
- the StringBuilder to which the XML
String representation of this Channel
is to be appended.public void setChannelBundleId(java.lang.String channelBundleId)
channelBundleId
- the value to set.public void setEndpoint(java.lang.String endpoint)
endpoint
- the identifier of the endpoint of the conference
participant associated with this Channelpublic void setExpire(int expire)
expire
- the number of seconds of activity after which the
channel represented by this instance expiresjava.lang.IllegalArgumentException
- if the value of the specified
expire is other than EXPIRE_NOT_SPECIFIED
and
negativepublic void setID(java.lang.String id)
public void setInitiator(java.lang.Boolean initiator)
initiator
- Boolean.TRUE
if the conference focus is the
initiator/offerer of the media negotiation associated with this
instance, Boolean.FALSE
if the conference focus is the
responder/answerer or null if the initiator state
is to be unspecifiedpublic void setTransport(IceUdpTransportPacketExtension transport)
public void toXML(java.lang.StringBuilder xml)
xml
- the StringBuilder to which the XML
String representation of this Channel is to be
appended
Jitsi, the OpenSource Java VoIP and Instant Messaging client.
Distributable under Apache license.