org.jvoicexml

Interface ConnectionInformation

All Superinterfaces:

java.io.Serializable

public interface ConnectionInformation
extends java.io.Serializable

Data container that holds all the information that is needed to connect the server side resources SystemOutput, UserInput, and CallControl to the client.

The resources are identified using strings, e.g. jsapi10 for an implementation based on JSAPI 1.0.

The implementing object is created at the client side and transferred to the the JVoiceXml server via serialization. The implementation platform then calls the RemoteConnectable.connect(ConnectionInformation) method to start the communication of the client with the server side resources.

A ConnectionInformation may also specify the server side resource it wants to use. Each SystemOutput, UserInput, and CallControl can be identified using a unique string. If the ConnectionInformation does not specify a resource, the default resource is taken.

Since:

0.5.5

See Also:

RemoteConnectable

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCallControl() Retrieves a unique identifier for the CallControl to use.
java.net.URI	getCalledDevice() Retrieves the URI of the caller device.
java.net.URI	getCallingDevice() Retrieves the URI of the calling device.
java.lang.String	getProfile() Retrieves the profile to use.
java.lang.String	getProtocolName() Retrieves the name of the connection protocol.
java.lang.String	getProtocolVersion() Retrieves the version of the connection protocol.
java.lang.String	getSystemOutput() Retrieves a unique identifier for the SystemOutput to use.
java.lang.String	getUserInput() Retrieves a unique identifier for the UserInput to use.

Method Detail

getProfile

java.lang.String getProfile()

Retrieves the profile to use.

Returns:

the profile

Since:

0.7.7

getSystemOutput

java.lang.String getSystemOutput()

Retrieves a unique identifier for the SystemOutput to use.

Returns:

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

getUserInput

java.lang.String getUserInput()

Retrieves a unique identifier for the UserInput to use.

Returns:

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

getCallControl

java.lang.String getCallControl()

Retrieves a unique identifier for the CallControl to use.

Returns:

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

getCalledDevice

java.net.URI getCalledDevice()

Retrieves the URI of the caller device.

Returns:

URI of the caller device.

Since:

0.7

getCallingDevice

java.net.URI getCallingDevice()

Retrieves the URI of the calling device.

Returns:

URI of the calling device.

Since:

0.7

getProtocolName

java.lang.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.

Returns:

name of the connection protocol.

Since:

0.7

getProtocolVersion

java.lang.String getProtocolVersion()

Retrieves the version of the connection protocol.

Returns:

version of the connection protocol.

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

Since:

0.7