org.asteriskjava.fastagi

Class AbstractMappingStrategy

java.lang.Object

org.asteriskjava.lock.Lockable

org.asteriskjava.fastagi.AbstractMappingStrategy

All Implemented Interfaces:

MappingStrategy

Direct Known Subclasses:

ClassNameMappingStrategy, ResourceBundleMappingStrategy

public abstract class AbstractMappingStrategy
extends Lockable
implements MappingStrategy

Abstract base class for common mapping strategies.
If you implement your own mapping strategy you can derive from this class.

Since:

0.3

Author:

srt

Field Summary

Fields

Modifier and Type	Field and Description
protected Log	logger Reference to Asterisk-Java's logging subsystem.

Constructor Summary

Constructors

Constructor and Description
AbstractMappingStrategy()

Method Summary

Modifier and Type	Method and Description
protected AgiScript	createAgiScriptInstance(String className) Creates a new instance of an AGI script.
abstract AgiScript	determineScript(AgiRequest request)
AgiScript	determineScript(AgiRequest request, AgiChannel channel) Returns the AgiScript instance that is responsible to handle the given request.
protected ClassLoader	getClassLoader() Returns the ClassLoader to use for loading AgiScript classes and load other resources like the mapping properties file.

Methods inherited from class org.asteriskjava.lock.Lockable

getDumpRateLimit, withLock

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected Log logger

Reference to Asterisk-Java's logging subsystem.

Constructor Detail

AbstractMappingStrategy

public AbstractMappingStrategy()

Method Detail

determineScript

public AgiScript determineScript(AgiRequest request,
                                 AgiChannel channel)

Description copied from interface: MappingStrategy

Returns the AgiScript instance that is responsible to handle the given request.

Specified by:

determineScript in interface MappingStrategy

Parameters:

request - the request to lookup.

channel - the channel.

Returns:

the AgiScript instance to handle this request or null if none could be determined by this strategy.

determineScript

public abstract AgiScript determineScript(AgiRequest request)

getClassLoader

protected ClassLoader getClassLoader()

Returns the ClassLoader to use for loading AgiScript classes and load other resources like the mapping properties file.

By default this method returns a class loader that searches for classes in the "agi" subdirectory (if it exists) and uses the context class loader of the current thread as the parent class loader.

You can override this method if you prefer using a different class loader.

Returns:

the ClassLoader to use for loading AgiScript classes and load other resources like the mapping properties file.

Since:

1.0.0

createAgiScriptInstance

protected AgiScript createAgiScriptInstance(String className)

Creates a new instance of an AGI script.

Parameters:

className - Class name of the AGI script. The class must implement AgiScript.

Returns:

the created instance of the AGI script class. If the instance can't be created an error is logged and null is returned.