org.jvoicexml.client
Class BasicConnectionInformation

java.lang.Object
  org.jvoicexml.client.BasicConnectionInformation

All Implemented Interfaces:

Serializable, ConnectionInformation

Direct Known Subclasses:

RtpConnectionInformation

public class BasicConnectionInformation
extends Object
implements ConnectionInformation

Basic connection configuration.

This implementation is designed to transfer the minimum of the needed information from the client to the JVoiceXml server. It may be extended by custom implementations to transfer other client settings that is needed by custom implementation platforms.

Since:

0.6

Version:

$Revision: 2553 $

Author:

Dirk Schnelle-Walka

See Also:

Serialized Form

Constructor Summary

BasicConnectionInformation(String call, String output, String input)
Constructs a new object.

Method Summary

protected void	addToString(StringBuilder str) Subclass specific additions to the toString() method.
String	getCallControl() Retrieves a unique identifier for the CallControl to use.
URI	getCalledDevice() Retrieves the URI of the caller device.
URI	getCallingDevice() Retrieves the URI of the calling device.
String	getProtocolName() Retrieves the name of the connection protocol.
String	getProtocolVersion() Retrieves the version of the connection protocol.
String	getSystemOutput() Retrieves a unique identifier for the SystemOutput to use.
String	getUserInput() Retrieves a unique identifier for the UserInput to use.
void	setCalledDevice(URI device) Sets the called device.
void	setCallingDevice(URI device) Sets the calling device.
void	setProtocolName(String name) Sets the protocol name.
void	setProtocolVersion(String version) Sets the protocol version.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicConnectionInformation

public BasicConnectionInformation(String call,
                                  String output,
                                  String input)

Constructs a new object.

Parameters:

call - unique identifier for the CallControl.

output - unique identifier for the SystemOutput.

input - unique identifier for the UserInput.

Method Detail

getCallControl

public final String getCallControl()

Retrieves a unique identifier for the CallControl to use.

Specified by:

getCallControl in interface ConnectionInformation

Returns:

Identifier for the CallControl, or null if the default resource should be used.

getSystemOutput

public final String getSystemOutput()

Retrieves a unique identifier for the SystemOutput to use.

Specified by:

getSystemOutput in interface ConnectionInformation

Returns:

Identifier for the SystemOutput, or null if the default resource should be used.

getUserInput

public final String getUserInput()

Retrieves a unique identifier for the UserInput to use.

Specified by:

getUserInput in interface ConnectionInformation

Returns:

Identifier for the UserInput, or null if the default resource should be used.

getCalledDevice

public final URI getCalledDevice()

Retrieves the URI of the caller device.

Specified by:

getCalledDevice in interface ConnectionInformation

Returns:

URI of the caller device.

setCalledDevice

public final void setCalledDevice(URI device)

Sets the called device.

Parameters:

device - the called device to set

getCallingDevice

public final URI getCallingDevice()

Retrieves the URI of the calling device.

Specified by:

getCallingDevice in interface ConnectionInformation

Returns:

URI of the calling device.

setCallingDevice

public final void setCallingDevice(URI device)

Sets the calling device.

Parameters:

device - the calling device to set

getProtocolName

public final String getProtocolName()

Retrieves the name of the connection protocol.

The returned URI should be a URL for telephone calls as specified in IETF RFC 2806.

Specified by:

getProtocolName in interface ConnectionInformation

Returns:

name of the connection protocol.

setProtocolName

public final void setProtocolName(String name)

Sets the protocol name.

Parameters:

name - the protocol name to set

getProtocolVersion

public final String getProtocolVersion()

Retrieves the version of the connection protocol.

Specified by:

getProtocolVersion in interface ConnectionInformation

Returns:

version of the connection protocol.

The returned URI should be a URL for telephone calls as specified in IETF RFC 2806.

setProtocolVersion

public final void setProtocolVersion(String version)

Sets the protocol version.

Parameters:

version - the protocol version to set

addToString

protected void addToString(StringBuilder str)

Subclass specific additions to the toString() method. Subclasses are requested to add their member variables in the following form ,<value>.

Parameters:

str - StringBuilder to add to

Since:

0.7.5

toString

public final String toString()

Overrides:

toString in class Object