org.jvoicexml.implementation

Interface ExternalResource

All Superinterfaces:

RemoteConnectable

All Known Subinterfaces:

SpokenInput, SynthesizedOutput, Telephony

All Known Implementing Classes:

BufferedDtmfInput, DesktopTelephonySupport

public interface ExternalResource
extends RemoteConnectable

An external resource that is required by the used implementation platform.

An external resource features a lifecycle as shown in the following image:

See Also:

ImplementationPlatform

Method Summary

Modifier and Type	Method and Description
void	activate() Activates this resource, when it is retrieved from the pool.
void	close() Closes and releases the acquired resources.
java.lang.String	getType() Retrieves a unique identifier for this external resource.
boolean	isBusy() Checks if this device is busy.
void	open() Initializes and and acquires the needed resources.
void	passivate() Passivates this resource, when it is returned to the pool.

Methods inherited from interface org.jvoicexml.RemoteConnectable

connect, disconnect

Method Detail

getType

java.lang.String getType()

Retrieves a unique identifier for this external resource.

Returns:

unique identifier.

open

void open()
   throws NoresourceError

Initializes and and acquires the needed resources.

Throws:

NoresourceError - The resource could not be opened.

activate

void activate()
       throws NoresourceError

Activates this resource, when it is retrieved from the pool.

Throws:

NoresourceError - The resource could not be activated.

Since:

0.5.5

passivate

void passivate()
        throws NoresourceError

Passivates this resource, when it is returned to the pool.

The external resource is requested to return all resources that were assigned while it was active.

Throws:

NoresourceError - The resource could not be opened.

Since:

0.5.5

close

void close()

Closes and releases the acquired resources.

isBusy

boolean isBusy()

Checks if this device is busy.

A device can be busy only if it is activated. Closed or passivated devices must return false.

Returns:

true if the device is busy.

Since:

0.6