org.jvoicexml.xml.ccxml
Class Join

java.lang.Object
  org.jvoicexml.xml.XmlNode
      org.jvoicexml.xml.ccxml.CcxmlNode
          org.jvoicexml.xml.ccxml.Join

All Implemented Interfaces:

XmlWritable, Node

public final class Join
extends CcxmlNode

A CCXML document can attempt to create a bridge between any two connections, conferences, or dialogs using <join>. This element instructs the implementation to bridge the connections, conferences, or dialogs specified using the id1 and id2 attributes in accordance with media options specified by the other attributes of <join>. The successful execution of<join> will result in the generation of a conference.joined event. If for any reason the implementation is unable to create the bridge using the specified options it MUST fail with a error.conference.join event. Joining two objects that are owned by separate CCXML sessions will result in the generation of a conference.joined to each of the sessions. However if the implementation is unable to join the objects an error.conference.join will only be sent to the session issued the <join>.

Version:

$Revision: 1.4 $

Copyright © 2005 JVoiceXML group - http://jvoicexml.sourceforge.net/

Author:

Steve Doyle

Field Summary

static String	ATTRIBUTE_AUTOINPUTGAIN An ECMAScript Boolean expression that tells the conference mixer if it should use AGC to determine the input gain for a leg.
static String	ATTRIBUTE_AUTOOUTPUTGAIN An ECMAScript boolean expression that tells the conference mixer if it should use AGC to determine the output gain for a leg.
static String	ATTRIBUTE_DTMFCLAMP An ECMAScript Boolean expression that tells the conference mixer if it should attempt to remove detected DTMF tones.
static String	ATTRIBUTE_DUPLEX An ECMAScript expression that returns a character string equal to "half" or "full", which defines the direction of the media flow between id1 resource and id2 resource.
static String	ATTRIBUTE_ENTERTONE An ECMAScript expression that returns a character string that is used to play a tone or a custom wav file to the conference participants when another caller joins.
static String	ATTRIBUTE_EXITTONE An ECMAScript expression that returns a character string that is used to play a tone or a custom wav file to the conference participants when another caller exits.
static String	ATTRIBUTE_HINTS The ECMAScript object returned contains information which may be used by the implementing platform or passed to the network when the two specified Connections, Dialogs or Conferences (id1 and id2) are joined.
static String	ATTRIBUTE_ID1 The ECMAScript object returned contains information which may be used by the implementing platform or passed to the network when the two specified Connections, Dialogs or Conferences (id1 and id2) are joined.
static String	ATTRIBUTE_ID2 The ECMAScript object returned contains information which may be used by the implementing platform or passed to the network when the two specified Connections, Dialogs or Conferences (id1 and id2) are joined.
protected static ArrayList<String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static String	ATTRIBUTE_TONECLAMP An ECMAScript Boolean expression that tells the conference mixer if it should attempt to remove loud single-frequency tones from the audio stream.
private static Set<String>	CHILD_TAGS Valid child tags for this node.
static String	TAG_NAME Name of the tag.

Fields inherited from class org.jvoicexml.xml.XmlNode

node

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

Join()
Construct a new join object without a node.

Join(Node node)
Construct a new join object.

Method Summary

protected boolean	canContainChild(String tagName) Can the specified sub-tag be contained within this node?
Collection<String>	getAttributeNames() Returns a collection of permitted attribute names for the node.
String	getAutoinputgain() Retrieve the autoinputgain attribute.
String	getAutooutputgain() Retrieve the autooutputgain attribute.
String	getDtmfclamp() Retrieve the dtmfclamp attribute.
String	getDuplex() Retrieve the duplex attribute.
String	getEntertone() Retrieve the entertone attribute.
String	getExittone() Retrieve the exittone attribute.
String	getHints() Retrieve the hints attribute.
String	getId1() Retrieve the id1 attribute.
String	getId2() Retrieve the id2 attribute.
String	getTagName() Get the name of the tag for the derived node.
String	getToneclamp() Retrieve the toneclamp attribute.
XmlNode	newInstance(Node n) Create a new instance for the given node.
void	setAutoinputgain(String autoinputgain) Set the autoinputgain attribute.
void	setAutooutputgain(String autooutputgain) Set the autooutputgain attribute.
void	setDtmfclamp(String dtmfclamp) Set the dtmfclamp attribute.
void	setDuplex(String duplex) Set the duplex attribute.
void	setEntertone(String entertone) Set the entertone attribute.
void	setExittone(String exittone) Set the exittone attribute.
void	setHints(String hints) Set the hints attribute.
void	setId1(String id1) Set the id1 attribute.
void	setId2(String id2) Set the id2 attribute.
void	setToneclamp(String toneclamp) Set the toneclamp attribute.

Methods inherited from class org.jvoicexml.xml.ccxml.CcxmlNode

getChildNodes, getFirstChild, getLastChild, getNextSibling, getParentNode, getPreviousSibling

Methods inherited from class org.jvoicexml.xml.XmlNode

addChild, appendChild, cloneNode, compareDocumentPosition, getAttribute, getAttributes, getBaseURI, getChildNodes, getFeature, getLocalName, getNamespaceURI, getNode, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getPrefix, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setAttribute, setNodeValue, setPrefix, setTextContent, setUserData, toString, writeChildrenXml, writeXml

Methods inherited from class java.lang.Object

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

Field Detail

TAG_NAME

public static final String TAG_NAME

Name of the tag.

See Also:

Constant Field Values

ATTRIBUTE_AUTOINPUTGAIN

public static final String ATTRIBUTE_AUTOINPUTGAIN

An ECMAScript Boolean expression that tells the conference mixer if it should use AGC to determine the input gain for a leg. If a platform does not support AGC, it should ignore this attribute.

See Also:

Constant Field Values

ATTRIBUTE_AUTOOUTPUTGAIN

public static final String ATTRIBUTE_AUTOOUTPUTGAIN

An ECMAScript boolean expression that tells the conference mixer if it should use AGC to determine the output gain for a leg. If a platform does not support AGC, it should ignore this attribute.

See Also:

Constant Field Values

ATTRIBUTE_DTMFCLAMP

public static final String ATTRIBUTE_DTMFCLAMP

An ECMAScript Boolean expression that tells the conference mixer if it should attempt to remove detected DTMF tones. If a platform does not support removal of DTMF tones, it should ignore this attribute.

See Also:

Constant Field Values

ATTRIBUTE_DUPLEX

public static final String ATTRIBUTE_DUPLEX

An ECMAScript expression that returns a character string equal to "half" or "full", which defines the direction of the media flow between id1 resource and id2 resource. Refer to the discussion of bridging in Section 10.4 . The duplex attribute determines whether the join will establish a half-duplex (unidirectional) or full-duplex (bi-directional) bridge.

See Also:

Constant Field Values

ATTRIBUTE_ENTERTONE

public static final String ATTRIBUTE_ENTERTONE

An ECMAScript expression that returns a character string that is used to play a tone or a custom wav file to the conference participants when another caller joins.

See Also:

Constant Field Values

ATTRIBUTE_EXITTONE

public static final String ATTRIBUTE_EXITTONE

An ECMAScript expression that returns a character string that is used to play a tone or a custom wav file to the conference participants when another caller exits.

See Also:

Constant Field Values

ATTRIBUTE_HINTS

public static final String ATTRIBUTE_HINTS

The ECMAScript object returned contains information which may be used by the implementing platform or passed to the network when the two specified Connections, Dialogs or Conferences (id1 and id2) are joined. This information may consist of protocol-specific parameters. Note: The meaning of these hints is specific to the implementing platform and the underlying protocol.

See Also:

Constant Field Values

ATTRIBUTE_ID1

public static final String ATTRIBUTE_ID1

The ECMAScript object returned contains information which may be used by the implementing platform or passed to the network when the two specified Connections, Dialogs or Conferences (id1 and id2) are joined. This information may consist of protocol-specific parameters. Note: The meaning of these hints is specific to the implementing platform and the underlying protocol.

See Also:

Constant Field Values

ATTRIBUTE_ID2

public static final String ATTRIBUTE_ID2

The ECMAScript object returned contains information which may be used by the implementing platform or passed to the network when the two specified Connections, Dialogs or Conferences (id1 and id2) are joined. This information may consist of protocol-specific parameters. Note: The meaning of these hints is specific to the implementing platform and the underlying protocol.

See Also:

Constant Field Values

ATTRIBUTE_TONECLAMP

public static final String ATTRIBUTE_TONECLAMP

An ECMAScript Boolean expression that tells the conference mixer if it should attempt to remove loud single-frequency tones from the audio stream. If a platform does not support removal of tones, it should ignore this attribute.

See Also:

Constant Field Values

ATTRIBUTE_NAMES

protected static final ArrayList<String> ATTRIBUTE_NAMES

Supported attribute names for this node.

CHILD_TAGS

private static final Set<String> CHILD_TAGS

Valid child tags for this node.

Constructor Detail

Join

public Join()

Construct a new join object without a node.

This is necessary for the node factory.

See Also:

VoiceXmlNodeFactory

Join

Join(Node node)

Construct a new join object.

Parameters:

node - The encapsulated node.

Method Detail

getTagName

public String getTagName()

Get the name of the tag for the derived node.

Specified by:

getTagName in class XmlNode

Returns:

name of the tag.

newInstance

public XmlNode newInstance(Node n)

Create a new instance for the given node.

Specified by:

newInstance in class XmlNode

Parameters:

n - The node to encapsulate.

Returns:

The new instance.

getAutoinputgain

public String getAutoinputgain()

Retrieve the autoinputgain attribute.

Returns:

Value of the autoinputgain attribute.

See Also:

ATTRIBUTE_AUTOINPUTGAIN

setAutoinputgain

public void setAutoinputgain(String autoinputgain)

Set the autoinputgain attribute.

Parameters:

autoinputgain - Value of the autoinputgain attribute.

See Also:

ATTRIBUTE_AUTOINPUTGAIN

getAutooutputgain

public String getAutooutputgain()

Retrieve the autooutputgain attribute.

Returns:

Value of the autooutputgain attribute.

See Also:

ATTRIBUTE_AUTOOUTPUTGAIN

setAutooutputgain

public void setAutooutputgain(String autooutputgain)

Set the autooutputgain attribute.

Parameters:

autooutputgain - Value of the autooutputgain attribute.

See Also:

ATTRIBUTE_AUTOOUTPUTGAIN

getDtmfclamp

public String getDtmfclamp()

Retrieve the dtmfclamp attribute.

Returns:

Value of the dtmfclamp attribute.

See Also:

ATTRIBUTE_DTMFCLAMP

setDtmfclamp

public void setDtmfclamp(String dtmfclamp)

Set the dtmfclamp attribute.

Parameters:

dtmfclamp - Value of the dtmfclamp attribute.

See Also:

ATTRIBUTE_DTMFCLAMP

getDuplex

public String getDuplex()

Retrieve the duplex attribute.

Returns:

Value of the duplex attribute.

See Also:

ATTRIBUTE_DUPLEX

setDuplex

public void setDuplex(String duplex)

Set the duplex attribute.

Parameters:

duplex - Value of the duplex attribute.

See Also:

ATTRIBUTE_DUPLEX

getEntertone

public String getEntertone()

Retrieve the entertone attribute.

Returns:

Value of the entertone attribute.

See Also:

ATTRIBUTE_ENTERTONE

setEntertone

public void setEntertone(String entertone)

Set the entertone attribute.

Parameters:

entertone - Value of the entertone attribute.

See Also:

ATTRIBUTE_ENTERTONE

getExittone

public String getExittone()

Retrieve the exittone attribute.

Returns:

Value of the exittone attribute.

See Also:

ATTRIBUTE_EXITTONE

setExittone

public void setExittone(String exittone)

Set the exittone attribute.

Parameters:

exittone - Value of the exittone attribute.

See Also:

ATTRIBUTE_EXITTONE

getHints

public String getHints()

Retrieve the hints attribute.

Returns:

Value of the hints attribute.

See Also:

ATTRIBUTE_HINTS

setHints

public void setHints(String hints)

Set the hints attribute.

Parameters:

hints - Value of the hints attribute.

See Also:

ATTRIBUTE_HINTS

getId1

public String getId1()

Retrieve the id1 attribute.

Returns:

Value of the id1 attribute.

See Also:

ATTRIBUTE_ID1

setId1

public void setId1(String id1)

Set the id1 attribute.

Parameters:

id1 - Value of the id1 attribute.

See Also:

ATTRIBUTE_ID1

getId2

public String getId2()

Retrieve the id2 attribute.

Returns:

Value of the id2 attribute.

See Also:

ATTRIBUTE_ID2

setId2

public void setId2(String id2)

Set the id2 attribute.

Parameters:

id2 - Value of the id2 attribute.

See Also:

ATTRIBUTE_ID2

getToneclamp

public String getToneclamp()

Retrieve the toneclamp attribute.

Returns:

Value of the toneclamp attribute.

See Also:

ATTRIBUTE_TONECLAMP

setToneclamp

public void setToneclamp(String toneclamp)

Set the toneclamp attribute.

Parameters:

toneclamp - Value of the toneclamp attribute.

See Also:

ATTRIBUTE_TONECLAMP

canContainChild

protected boolean canContainChild(String tagName)

Can the specified sub-tag be contained within this node?

Specified by:

canContainChild in class XmlNode

Parameters:

tagName - Name of child.

Returns:

True if the sub-tag is allowed on this node.

getAttributeNames

public Collection<String> getAttributeNames()

Returns a collection of permitted attribute names for the node.

Overrides:

getAttributeNames in class XmlNode

Returns:

A collection of attribute names that are allowed for the node