org.asteriskjava.fastagi

Class DefaultAgiServer

java.lang.Object

org.asteriskjava.fastagi.AbstractAgiServer

org.asteriskjava.fastagi.DefaultAgiServer

All Implemented Interfaces:

AgiServer

Direct Known Subclasses:

ConfiguableAGIServer

public class DefaultAgiServer
extends AbstractAgiServer
implements AgiServer

Default implementation of the AgiServer interface for FastAGI.

Version:

$Id$

Author:

srt

Constructor Summary

Constructors

Constructor and Description
DefaultAgiServer() Creates a new DefaultAgiServer.
DefaultAgiServer(AgiChannelFactory agiChannelFactory) Creates a new DefaultAgiServer and set a custom factory for creating AgiChannels
DefaultAgiServer(AgiScript agiScript) Creates a new DefaultAgiServer that runs the given AgiScript for all requests.
DefaultAgiServer(MappingStrategy mappingStrategy) Creates a new DefaultAgiServer that uses the given MappingStrategy.
DefaultAgiServer(String configResourceBundleName) Creates a new DefaultAgiServer and loads its configuration from an alternative resource bundle.
DefaultAgiServer(String configResourceBundleName, MappingStrategy mappingStrategy) Creates a new DefaultAgiServer and loads its configuration from an alternative resource bundle and uses the given MappingStrategy.
DefaultAgiServer(String configResourceBundleName, MappingStrategy mappingStrategy, AgiChannelFactory agiChannelFactory) Creates a new DefaultAgiServer and loads its configuration from an alternative resource bundle and uses the given MappingStrategy.

Method Summary

Modifier and Type	Method and Description
protected ServerSocketFacade	createServerSocket()
protected void	finalize()
InetAddress	getAddress() Returns the address this server is configured to bind to.
int	getPort() Returns the TCP port this server is configured to bind to.
static void	main(String[] args) Deprecated. since 1.0.0 use Cli instead.
void	run() Deprecated. use startup() instead.
void	setAddress(InetAddress address) Sets the address to bind server.
void	setBindPort(int bindPort) Deprecated. use setPort(int) instead
void	setPort(int port) Sets the TCP port to listen on for new connections.
void	setSocketReadTimeout(int socketReadTimeout) Connection is dropped if it stales on read longer than the timeout.
void	shutdown() Stops this AgiServer.
void	startup() Starts this AgiServer.

Methods inherited from class org.asteriskjava.fastagi.AbstractAgiServer

createPool, execute, getAgiChannelFactory, getMappingStrategy, getMaximumPoolSize, getPoolActiveTaskCount, getPoolActiveThreadCount, getPoolSize, handleException, isDie, setMappingStrategy, setMaximumPoolSize, setPoolSize

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultAgiServer

public DefaultAgiServer()

Creates a new DefaultAgiServer.

DefaultAgiServer

public DefaultAgiServer(AgiChannelFactory agiChannelFactory)

Creates a new DefaultAgiServer and set a custom factory for creating AgiChannels

Parameters:

agiChannelFactory - The factory to use for creating new AgiChannel instances.

DefaultAgiServer

public DefaultAgiServer(String configResourceBundleName)

Creates a new DefaultAgiServer and loads its configuration from an alternative resource bundle.

Parameters:

configResourceBundleName - the name of the conifiguration resource bundle (default is "fastagi").

DefaultAgiServer

public DefaultAgiServer(MappingStrategy mappingStrategy)

Creates a new DefaultAgiServer that uses the given MappingStrategy.

Parameters:

mappingStrategy - the MappingStrategy to use to determine the AgiScript to run.

Since:

1.0.0

DefaultAgiServer

public DefaultAgiServer(AgiScript agiScript)

Creates a new DefaultAgiServer that runs the given AgiScript for all requests.

Parameters:

agiScript - the AgiScript to run.

Since:

1.0.0

DefaultAgiServer

public DefaultAgiServer(String configResourceBundleName,
                        MappingStrategy mappingStrategy)

Creates a new DefaultAgiServer and loads its configuration from an alternative resource bundle and uses the given MappingStrategy.

Parameters:

configResourceBundleName - the name of the conifiguration resource bundle (default is "fastagi").

mappingStrategy - the MappingStrategy to use to determine the AgiScript to run.

Since:

1.0.0

DefaultAgiServer

public DefaultAgiServer(String configResourceBundleName,
                        MappingStrategy mappingStrategy,
                        AgiChannelFactory agiChannelFactory)

Creates a new DefaultAgiServer and loads its configuration from an alternative resource bundle and uses the given MappingStrategy.

Parameters:

configResourceBundleName - the name of the conifiguration resource bundle (default is "fastagi").

mappingStrategy - the MappingStrategy to use to determine the AgiScript to run.

agiChannelFactory - The factory to use for creating new AgiChannel instances.

Since:

1.0.0

Method Detail

setBindPort

@Deprecated
public void setBindPort(int bindPort)

Deprecated. use setPort(int) instead

Sets the TCP port to listen on for new connections.
The default port is 4573.

Parameters:

bindPort - the port to bind to.

setPort

public void setPort(int port)

Sets the TCP port to listen on for new connections.
The default port is 4573.

Parameters:

port - the port to bind to.

Since:

0.2

getPort

public int getPort()

Returns the TCP port this server is configured to bind to.

Returns:

the TCP port this server is configured to bind to.

Since:

1.0.0

getAddress

public InetAddress getAddress()

Returns the address this server is configured to bind to.

Returns:

the address this server is configured to bind to.

setAddress

public void setAddress(InetAddress address)

Sets the address to bind server.

Parameters:

address - the address to bind to.

setSocketReadTimeout

public void setSocketReadTimeout(int socketReadTimeout)

Description copied from interface: AgiServer

Connection is dropped if it stales on read longer than the timeout.

Specified by:

setSocketReadTimeout in interface AgiServer

Parameters:

socketReadTimeout - the read timeout value to be used in milliseconds.

See Also:

Socket.setSoTimeout(int)

createServerSocket

protected ServerSocketFacade createServerSocket()
                                         throws IOException

Throws:

IOException

startup

public void startup()
             throws IOException,
                    IllegalStateException

Description copied from interface: AgiServer

Starts this AgiServer.

After calling startup() this AgiServer is ready to receive requests from Asterisk servers and process them.

Note that this method will not return until the AgiServer has been shut down. If you want to run the AgiServer in the background use wrap it with an AgiServerThread.

Specified by:

startup in interface AgiServer

Throws:

IOException - if the server socket cannot be bound.

IllegalStateException - if this AgiServer is already running.

run

@Deprecated
public void run()

Deprecated. use startup() instead.

shutdown

public void shutdown()
              throws IllegalStateException

Description copied from interface: AgiServer

Stops this AgiServer.

The server socket is closed, new connections are refused and resources are freed. Any running AgiScripts are finish before shutdown completes.

Specified by:

shutdown in interface AgiServer

Overrides:

shutdown in class AbstractAgiServer

Throws:

IllegalStateException - if this AgiServer is already shut down or has not yet been started.

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class AbstractAgiServer

Throws:

Throwable

main

@Deprecated
public static void main(String[] args)
                             throws Exception

Deprecated. since 1.0.0 use Cli instead.

Creates a new DefaultAgiServer and starts it.

Parameters:

args - not used

Throws:

Exception - if the server can't be started