org.asteriskjava.fastagi.command

Class GetDataCommand

java.lang.Object

org.asteriskjava.fastagi.command.AbstractAgiCommand

org.asteriskjava.fastagi.command.GetDataCommand

All Implemented Interfaces:

Serializable, AgiCommand

public class GetDataCommand
extends AbstractAgiCommand

Stream the given file, and recieve DTMF data. The user may interrupt the streaming by starting to enter digits.

Returns the digits recieved from the channel at the other end.

Input ends when the timeout is reached, the maximum number of digits is read or the user presses #.

Version:

$Id$

Author:

srt

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetDataCommand(String file) Creates a new GetDataCommand with default timeout and maxDigits set to 1024.
GetDataCommand(String file, long timeout) Creates a new GetDataCommand with the given timeout and maxDigits set to 1024.
GetDataCommand(String file, long timeout, int maxDigits) Creates a new GetDataCommand with the given timeout and maxDigits.

Method Summary

Modifier and Type	Method and Description
String	buildCommand() Returns a string suitable to be sent to asterisk.
String	getFile() Returns the name of the file to stream.
int	getMaxDigits() Returns the maximum number of digits to read.
long	getTimeout() Returns the timeout to wait for data.
void	setFile(String file) Sets the name of the file to stream.
void	setMaxDigits(int maxDigits) Sets the maximum number of digits to read.
void	setTimeout(long timeout) Sets the timeout to wait for data.

Methods inherited from class org.asteriskjava.fastagi.command.AbstractAgiCommand

escapeAndQuote, escapeAndQuote, setAsteriskVersion, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GetDataCommand

public GetDataCommand(String file)

Creates a new GetDataCommand with default timeout and maxDigits set to 1024.

Parameters:

file - the name of the file to stream, must not include extension.

GetDataCommand

public GetDataCommand(String file,
                      long timeout)

Creates a new GetDataCommand with the given timeout and maxDigits set to 1024.

Parameters:

file - the name of the file to stream, must not include extension.

timeout - the timeout in milliseconds to wait for data.

0 means standard timeout value, -1 means "ludicrous time" (essentially never times out).

GetDataCommand

public GetDataCommand(String file,
                      long timeout,
                      int maxDigits)
               throws IllegalArgumentException

Creates a new GetDataCommand with the given timeout and maxDigits.

Parameters:

file - the name of the file to stream, must not include extension.

timeout - the timeout in milliseconds to wait for data.

0 means standard timeout value, -1 means "ludicrous time" (essentially never times out).

maxDigits - the maximum number of digits to read.

Must be in [1..1024].

Throws:

IllegalArgumentException - if maxDigits is not in [1..1024]

Method Detail

getFile

public String getFile()

Returns the name of the file to stream.

Returns:

the name of the file to stream.

setFile

public void setFile(String file)

Sets the name of the file to stream.

This attribute is mandatory.

Parameters:

file - the name of the file to stream, must not include extension.

getTimeout

public long getTimeout()

Returns the timeout to wait for data.

Returns:

the timeout in milliseconds to wait for data.

setTimeout

public void setTimeout(long timeout)

Sets the timeout to wait for data.

Parameters:

timeout - the timeout in milliseconds to wait for data.

0 means standard timeout value, -1 means "ludicrous time" (essentially never times out).

getMaxDigits

public int getMaxDigits()

Returns the maximum number of digits to read.

Returns:

the maximum number of digits to read.

setMaxDigits

public void setMaxDigits(int maxDigits)
                  throws IllegalArgumentException

Sets the maximum number of digits to read.

Parameters:

maxDigits - the maximum number of digits to read.

Must be in [1..1024].

Throws:

IllegalArgumentException - if maxDigits is not in [1..1024]

buildCommand

public String buildCommand()

Description copied from interface: AgiCommand

Returns a string suitable to be sent to asterisk.

Specified by:

buildCommand in interface AgiCommand

Specified by:

buildCommand in class AbstractAgiCommand

Returns:

a string suitable to be sent to asterisk.