A B C D E F G H I L M N O P Q R S T U V W Z

A

absoluteTimeout(String, int) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Hangup a channel after a certain time.

addBinding(AGISettings.BindSettings) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGISettings

Adds a new host:port binding to this server.

addHandler(Handler) - Method in class com.orderlysoftware.orderlycalls.base.ServiceLogger

addManagerEventListener(ManagerEventListener) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

If you're interested in Asterisk Manager Events, create a class that implements ManagerEventListener, and add it here.

addPair(Pair) - Method in class com.orderlysoftware.orderlycalls.base.Message

Convenience method to add a key-value Pair.

addPair(String, String) - Method in class com.orderlysoftware.orderlycalls.base.Message

Another convenience method for adding a key-value pair.

addService(Service) - Method in class com.orderlysoftware.orderlycalls.OrderlyCalls

Adds a service (with a named Settings object) to the framework.

addService(Service) - Method in class com.orderlysoftware.orderlycalls.OrderlyCallsImpl

Adds a service (with a named Settings object) to the framework.

AGENT_DEPENDENT - Static variable in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

AGIConnection - Class in com.orderlysoftware.orderlycalls.asterisk.agi

AGIConnection objects represent individual calls coming from the FastAGI source (Asterisk).

AGIConnection() - Constructor for class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Creates an uninitialised AGIConnection object.

AGIConnection(Socket, AGIServer, AGIProcessor) - Constructor for class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Initialises the object in preparation for read from Asterisk.

AGIProcessor - Interface in com.orderlysoftware.orderlycalls.asterisk.agi

You can develop proprietary applications by creating your own classes that implement this interface.

AGIReusableProcessor - Interface in com.orderlysoftware.orderlycalls.asterisk.agi

You can develop proprietary applications by creating your own classes that implement this interface.

AGIServer - Class in com.orderlysoftware.orderlycalls.asterisk.agi

AGIServer responds to calls coming from the FastAGI source by opening a socket, and attaching it to a new AGICall object with its own thread.

AGIServer(AGISettings) - Constructor for class com.orderlysoftware.orderlycalls.asterisk.agi.AGIServer

AGISettings - Class in com.orderlysoftware.orderlycalls.asterisk.agi

This class encapsulates settings necessary to run an AGIServer.

AGISettings() - Constructor for class com.orderlysoftware.orderlycalls.asterisk.agi.AGISettings

AGISettings.BindSettings - Class in com.orderlysoftware.orderlycalls.asterisk.agi

This class encapsulates settings necessary to bind a single AGIServer to a single interface and port.

AGISettings.BindSettings() - Constructor for class com.orderlysoftware.orderlycalls.asterisk.agi.AGISettings.BindSettings

ALL - Static variable in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

answer() - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Answers channel if not already in answer state.

asciiToChar(int) - Static method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Converts an ASCII value to a java char.

authenticate(String, String) - Method in class com.orderlysoftware.orderlycalls.examples.ExampleService

Compares an input username and password to those from the congiguration file.

B

BUSY - Static variable in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

C

changeMonitor(String, String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Change monitoring filename of a channel.

channelStatus() - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Gets the status of the current channel.

channelStatus(String) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Returns the status of the specified channel.

charToInt(char) - Static method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Convert a DTMF character to a number.

clean() - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Closes any connections without throwing an exception.

clean() - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIServer

Closes all listening sockets for this AGIServer.

clean() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

clean() - Method in class com.orderlysoftware.orderlycalls.examples.ExampleManagerEventListener

Reset all non-static member fields, unregister from the ManagerClient, and return to ObjectPool.

com.orderlysoftware.orderlycalls - package com.orderlysoftware.orderlycalls

com.orderlysoftware.orderlycalls.asterisk.agi - package com.orderlysoftware.orderlycalls.asterisk.agi

com.orderlysoftware.orderlycalls.asterisk.manager - package com.orderlysoftware.orderlycalls.asterisk.manager

com.orderlysoftware.orderlycalls.asterisk.manager.action - package com.orderlysoftware.orderlycalls.asterisk.manager.action

com.orderlysoftware.orderlycalls.asterisk.manager.event - package com.orderlysoftware.orderlycalls.asterisk.manager.event

com.orderlysoftware.orderlycalls.base - package com.orderlysoftware.orderlycalls.base

com.orderlysoftware.orderlycalls.examples - package com.orderlysoftware.orderlycalls.examples

command(String, String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Execute Command Run a CLI command.

connect(String, int) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Connects to the Aterisk system by TCP/IP, but does not log in.

connectAndLogin(ManagerSettings) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Connects to Asterisk over TCP/IP and logs in.

constToStr(int) - Static method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

contextDestroyed(ServletContextEvent) - Method in class com.orderlysoftware.orderlycalls.OrderlyCallsWebDeployer

Called by Tomcat when the current ServletContext is destroyed.

contextInitialized(ServletContextEvent) - Method in class com.orderlysoftware.orderlycalls.OrderlyCallsWebDeployer

Called by Tomcat when your context is started.

D

databaseDel(String, String) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Deletes an entry in the Asterisk database for a given family and key.

databaseDelTree(String) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Deletes a family in the Asterisk database.

databaseDelTree(String, String) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Deletes a keytree within a specific family in the Asterisk database.

databaseGet(String, String) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Retrieves an entry in the Asterisk database for a given family and key.

databasePut(String, String, String) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Adds or updates an entry in the Asterisk database.

Definition - Class in com.orderlysoftware.orderlycalls.base

Class relates the configuration file XML tags to the Service and Settingsobjects they represent.

Definition(String, String, String) - Constructor for class com.orderlysoftware.orderlycalls.base.Definition

Creates a new Service Definition.

DELAY - Static variable in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

dispatch(ManagerEvent) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.event.ManagerEventDispatcher

Sends an event to all registered ManagerEventListenerinstances.

DOWN - Static variable in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

E

enterNumber(String) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExample

Ask caller to enter a number.

ENTRY - Static variable in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

equals(Object) - Method in class com.orderlysoftware.orderlycalls.base.Settings

Compare two Settings objects.

events(String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Contol Event Flow

ExampleManagerEventListener - Class in com.orderlysoftware.orderlycalls.examples

Example implementation of the ManagerEventListener interface.

ExampleManagerEventListener() - Constructor for class com.orderlysoftware.orderlycalls.examples.ExampleManagerEventListener

ExampleProcessor - Class in com.orderlysoftware.orderlycalls.examples

Gives best-practice guidelines.

ExampleProcessor() - Constructor for class com.orderlysoftware.orderlycalls.examples.ExampleProcessor

ExampleService - Class in com.orderlysoftware.orderlycalls.examples

Very basic Service implementation to help you write your own services.

ExampleService(Settings) - Constructor for class com.orderlysoftware.orderlycalls.examples.ExampleService

Must define this method in order to work with superclass.

exec(String, String) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Executes application with given options.

extensionState(String, String, String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Check Extension Status

F

find(Class) - Static method in class com.orderlysoftware.orderlycalls.base.ObjectPool

Alternative method for pooling objects that do not have a zero-argument constructor.

FIXED - Static variable in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

free(Object) - Static method in class com.orderlysoftware.orderlycalls.base.ObjectPool

Returns an object to the pool.

freeAGIProcessor(AGIReusableProcessor) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIServer

Returns an AGIProcessor to the ObjectPool.

freeDispatcher(ManagerEventDispatcher) - Static method in class com.orderlysoftware.orderlycalls.asterisk.manager.event.ManagerEventDispatcher

Returns this dispatcher to the ObjectPool.

G

getAcceptableHosts() - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGISettings.BindSettings

Gets the list of acceptable orgination hosts.

getActionTimeout() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

How long this manager will wait for a response before proceding to the next action.

getActionTimeout() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerSettings

getActivate() - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

OrderlyQ activation strategy.

getActivateSize() - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

The queue size at which to start offering OrderlyQ.

getActivateWait() - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

The wait time at which to start offering OrderlyQ.

getAddress() - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGISettings.BindSettings

getAGIConnection(Socket, AGIServer, AGIProcessor) - Static method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Gets an AGIConnection object from the pool, and initialises it.

getAGIProcessor(Class) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIServer

Gets an AGIProcessor instance.

getAGIProperties() - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Retrieves the properties for this call as received from Asterisk.

getAGIProperty(String) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Gets a particular property for this call.

getAnonymousLogger() - Static method in class com.orderlysoftware.orderlycalls.base.ServiceLogger

getAnonymousLogger(String) - Static method in class com.orderlysoftware.orderlycalls.base.ServiceLogger

getBindings() - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGISettings

getByInetAddress(InetAddress) - Static method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Gets a ManagerClient connected to a particular remote IP address.

getCallerCount() - Static method in class com.orderlysoftware.orderlycalls.examples.ExampleProcessor

This method gets the number of callers received.

getClassName() - Method in class com.orderlysoftware.orderlycalls.base.Definition

Gets the full name of the Service class.

getClient() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.event.ManagerEvent

Gets the client that received this event.

getClient() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.event.ManagerEventDispatcher

Gets the ManagerClient client associated with this ManagerEventDispatcher.

getData(String) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

getData(String, long) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

getData(String, long, int) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Stream the given file, and recieve DTMF data.

getDispatcher(ManagerClient) - Static method in class com.orderlysoftware.orderlycalls.asterisk.manager.event.ManagerEventDispatcher

Gets the dispatcher associated with a particular ManagerClient.

getEventListeners() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Gets all attached ManagerEventListeners.

getExecutorService() - Static method in class com.orderlysoftware.orderlycalls.base.Service

Returns a general-purpose thread execution service.

getExtraOffer() - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

When to describe the facility to call back from an extra number.

getExtraPrompt() - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

Which calls to offer the ability to call back on a different number.

getExtraSize() - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

The queue size at which to start offering the ability to call back on a different number.

getExtraWait() - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

The estimated wait time at which to start offering the ability to call back on a different number.

getFilter() - Method in class com.orderlysoftware.orderlycalls.base.ServiceLogger

getFreeform() - Method in class com.orderlysoftware.orderlycalls.base.Message

Gets freeform (unpaired) data associated with this message.

getHandlers() - Method in class com.orderlysoftware.orderlycalls.base.ServiceLogger

getHangUp() - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

When to hang up on callers.

getHangUpSize() - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

Number of people ahead of caller at which to force hang up.

getHangUpWait() - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

Estimated wait time at which to force hang up.

getHost() - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGISettings.BindSettings

getHost() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerSettings

getInstance(AGISettings) - Static method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIServer

Calls getInstance(settings, true).

getInstance(AGISettings, boolean) - Static method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIServer

Calls the Service superclass.

getInstance(String) - Static method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIServer

Gets a named AGIServer

getInstance(ManagerSettings) - Static method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Gets a ManagerClient instance, or creates one if none can be found.

getInstance(ManagerSettings, boolean) - Static method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Gets a connected ManagerClient instance.

getInstance(String) - Static method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Gets a connected ManagerClient instance, or null if none can be found.

getInstance(Class) - Static method in class com.orderlysoftware.orderlycalls.base.ObjectPool

Pooled objects MUST have a no-argument constructor to work with this method.

getInstance(Class, Settings, boolean) - Static method in class com.orderlysoftware.orderlycalls.base.Service

Gets an initialised Service instance.

getInstance(Settings) - Static method in class com.orderlysoftware.orderlycalls.base.Service

Gets an initialised Service instance.

getInstance(Settings, boolean) - Static method in class com.orderlysoftware.orderlycalls.base.Service

Gets an initialised Service instance.

getInstance(Settings) - Static method in class com.orderlysoftware.orderlycalls.examples.ExampleService

Must define this method in order to work with superclass.

getInstance(Settings, boolean) - Static method in class com.orderlysoftware.orderlycalls.examples.ExampleService

Must define this as follows in order to work with superclass.

getInstance(String) - Static method in class com.orderlysoftware.orderlycalls.examples.ExampleService

Most services should also define this method as follows.

getInstance() - Static method in class com.orderlysoftware.orderlycalls.OrderlyCalls

Gets the internal OrderlyCallsImpl object used to manage services.

getInstanceByName(String) - Static method in class com.orderlysoftware.orderlycalls.base.Service

Gets an initialised Service instance by the name of the Settings object.

getLevel() - Method in class com.orderlysoftware.orderlycalls.base.ServiceLogger

getListenerClass() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerSettings.ManagerEventListenerSettings

getLogger(String) - Static method in class com.orderlysoftware.orderlycalls.base.ServiceLogger

getLogger(String, String) - Static method in class com.orderlysoftware.orderlycalls.base.ServiceLogger

getLogName() - Method in class com.orderlysoftware.orderlycalls.base.Service

Gets a string to identify this service for logging.

getLogo() - Static method in class com.orderlysoftware.orderlycalls.OrderlyCalls

getManagerEventListenerSettings() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerSettings

getMobilePattern() - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

A regular expression used to detect calls from mobiles.

getMusic() - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

The music to play to callers.

getName() - Method in class com.orderlysoftware.orderlycalls.base.Service

Gets the name of the Settings object used to create this instance.

getName() - Method in class com.orderlysoftware.orderlycalls.base.ServiceLogger

getName() - Method in class com.orderlysoftware.orderlycalls.base.Settings

Gets the name of this Settings instance.

getParent() - Method in class com.orderlysoftware.orderlycalls.base.ServiceLogger

getPassword() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerSettings

getPersistAfterCall() - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

How long a caller remains at the front of the queue after speaking to an agent.

getPersistNoCall() - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

How long a caller remains at the front of the queue after reaching it without calling back.

getPort() - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGISettings.BindSettings

getPort() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerSettings

getProcessorClass() - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGISettings

Returns the class of AGIProcessor to be used

getRate() - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

The rate at which to pass callers through to agents.

getRateStrategy() - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

Specifies whether rate is constant or not.

getResourceBundle() - Method in class com.orderlysoftware.orderlycalls.base.ServiceLogger

getResourceBundleName() - Method in class com.orderlysoftware.orderlycalls.base.ServiceLogger

getResponse() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.action.ManagerAction

Gets the response received, if any.

getRounding() - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

Are we rounding wait times up or down?

getServer() - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Gets the AGIServer that received this connection.

getService(String) - Static method in class com.orderlysoftware.orderlycalls.OrderlyCalls

Gets a named Service.

getService(Class) - Static method in class com.orderlysoftware.orderlycalls.OrderlyCalls

Gets services by service class.

getService(String) - Method in class com.orderlysoftware.orderlycalls.OrderlyCallsImpl

Gets a Service by name.

getService(Class) - Method in class com.orderlysoftware.orderlycalls.OrderlyCallsImpl

Gets services by service class.

getServicesMap() - Static method in class com.orderlysoftware.orderlycalls.OrderlyCalls

Gets the mapping between names and services.

getServicesMap() - Method in class com.orderlysoftware.orderlycalls.OrderlyCallsImpl

Gets the mapping between names and services.

getSettings() - Method in class com.orderlysoftware.orderlycalls.base.Service

Gets the Settingsobject.

getSettings(AGIServer) - Static method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExample

Gets settings associated with a particular AGIServer.

getSettings(String) - Static method in class com.orderlysoftware.orderlycalls.OrderlyCalls

Gets a named Settings object.

getSettings(String) - Method in class com.orderlysoftware.orderlycalls.OrderlyCallsImpl

Gets a Settings object.

getSettingsMap() - Static method in class com.orderlysoftware.orderlycalls.OrderlyCalls

Gets the mapping between names and service Settings objects.

getSettingsMap() - Method in class com.orderlysoftware.orderlycalls.OrderlyCallsImpl

Gets the mapping between names and service Settings objects.

getSettingsName() - Method in class com.orderlysoftware.orderlycalls.base.Definition

Gets the full name of the Settings class that will hold initialisation paramaters for this Service.

getShortChannelName(String) - Static method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Utility method for converting a full channel name (e.g.

getSocket() - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

getTag() - Method in class com.orderlysoftware.orderlycalls.base.Definition

Gets the name of the tag that will represent this kind of Service.

getTextAvailable() - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

Who to offer texts to.

getTextDelay() - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

How long to delay sending texts.

getTextMessage() - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

Gets the text message to send mobiles.

getTextOffer() - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

When to offer the facility to sign up for texts.

getTextPrompt() - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

Whether to offer texts on only queue entry, or on subsequent calls.

getTextSend() - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

getTextSize() - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

People ahead of caller at which the facility to sign up for texts is offered.

getTextWait() - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

Estimated wait time at which to offer the facility to sign up for texts.

getType() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.event.ManagerEvent

Gets the type of the manager event.

getUseParentHandlers() - Method in class com.orderlysoftware.orderlycalls.base.ServiceLogger

getUsername() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerSettings

getValue(String) - Method in class com.orderlysoftware.orderlycalls.base.Message

Gets a particular value.

getVar(String, String, String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Gets a Channel Variable

getVariable(String) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Gets an Asterisk variable.

getXMLSettings() - Method in class com.orderlysoftware.orderlycalls.base.Settings

Gets the XML Element that created this instance.

H

handleManagerEvent(ManagerEvent) - Method in interface com.orderlysoftware.orderlycalls.asterisk.manager.event.ManagerEventListener

Implement this method to handle incoming events.

handleManagerEvent(ManagerEvent) - Method in class com.orderlysoftware.orderlycalls.examples.ExampleManagerEventListener

The example prints out the event, and the source client.

hangUp() - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Hangs up the call.

hangUp(String) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Hangs up a particular channel.

hangUp(String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Hangup Channel

I

iaxPeers() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Lists all IAX Peers.

IMMEDIATE - Static variable in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

init(Socket, AGIServer, AGIProcessor) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Initialises a pre-existing AGIConnection object.

init() - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIServer

Start serving requests.

init() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Initialises this ManagerClient based on the settings object stored.

init() - Method in class com.orderlysoftware.orderlycalls.base.Service

Initialise the service based on the given Settingsobject.

init(ManagerClient, String, String, String, String) - Method in class com.orderlysoftware.orderlycalls.examples.ExampleManagerEventListener

Initialise member fields.

init() - Method in class com.orderlysoftware.orderlycalls.examples.ExampleService

Gets the username and password attributes from the XML configuration file.

init(String) - Static method in class com.orderlysoftware.orderlycalls.OrderlyCalls

Initialise from config file.

init(File) - Static method in class com.orderlysoftware.orderlycalls.OrderlyCalls

Initialise from config file.

init(InputStream) - Static method in class com.orderlysoftware.orderlycalls.OrderlyCalls

Initialise from stream.

init(HashMap) - Static method in class com.orderlysoftware.orderlycalls.OrderlyCalls

Initialises OrderlyCalls programmatically.

init(String) - Method in class com.orderlysoftware.orderlycalls.OrderlyCallsImpl

Initialise from config file.

init(File) - Method in class com.orderlysoftware.orderlycalls.OrderlyCallsImpl

Initialise from config file.

init(InputStream) - Method in class com.orderlysoftware.orderlycalls.OrderlyCallsImpl

Initialise from stream.

init(HashMap) - Method in class com.orderlysoftware.orderlycalls.OrderlyCallsImpl

Initialises OrderlyCalls programmatically.

INVALID - Static variable in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

isComplete() - Method in class com.orderlysoftware.orderlycalls.base.Message

Tests whether this message is complete.

isLoggable(Level) - Method in class com.orderlysoftware.orderlycalls.base.ServiceLogger

isReuse() - Static method in class com.orderlysoftware.orderlycalls.OrderlyCalls

isRunning() - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIServer

isRunning() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

isRunning() - Method in class com.orderlysoftware.orderlycalls.base.Service

Determines whether this service is active.

isRunning() - Method in class com.orderlysoftware.orderlycalls.examples.ExampleService

Is the service runnig or not?

isTimedOut() - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Determines whether the last FastAGI call timed out.

L

listCommands() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

List available manager commands

log - Static variable in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

log - Variable in class com.orderlysoftware.orderlycalls.base.Service

log(LogRecord) - Method in class com.orderlysoftware.orderlycalls.base.ServiceLogger

login(String, String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Logs in to Asterisk Manager.

logOff() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Logoff Manager

logout() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Synonym for logOff()

M

mailboxCount(String, String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Check Mailbox Message Count.

mailboxStatus(String, String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Check Mailbox

main(String[]) - Static method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIServer

Main method for running stand-alone AGIServers.

main(String[]) - Static method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

For running ManagerClient as a stand-alone appliction.

main(String[]) - Static method in class com.orderlysoftware.orderlycalls.OrderlyCalls

Starts OrderlyCalls from the command line

ManagerAction - Class in com.orderlysoftware.orderlycalls.asterisk.manager.action

This class represents an Action for the Asterisk Manager API.

ManagerAction(String) - Constructor for class com.orderlysoftware.orderlycalls.asterisk.manager.action.ManagerAction

Constructor.

ManagerClient - Class in com.orderlysoftware.orderlycalls.asterisk.manager

This class represents the TCP/IP connection to the Asterisk Manager system.

ManagerClient(ManagerSettings) - Constructor for class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Creates a ManagerClient but does not start it.

ManagerEvent - Class in com.orderlysoftware.orderlycalls.asterisk.manager.event

Represents an event received from Asterisk over the Manager API

ManagerEvent(Message) - Constructor for class com.orderlysoftware.orderlycalls.asterisk.manager.event.ManagerEvent

Constructor for converting a Message to an Event

ManagerEventDispatcher - Class in com.orderlysoftware.orderlycalls.asterisk.manager.event

Used by ManagerClientto dispatch ManagerEventobjects to registered listeners.

ManagerEventDispatcher(ManagerClient) - Constructor for class com.orderlysoftware.orderlycalls.asterisk.manager.event.ManagerEventDispatcher

Creates a new ManagerEventDispatcher

ManagerEventListener - Interface in com.orderlysoftware.orderlycalls.asterisk.manager.event

NOTE TO APPLICATION DEVELOPERS:

ManagerResponse - Class in com.orderlysoftware.orderlycalls.asterisk.manager.action

Represents an action response from Asterisk.

ManagerResponse(Message) - Constructor for class com.orderlysoftware.orderlycalls.asterisk.manager.action.ManagerResponse

Creates a response from a message.

ManagerSettings - Class in com.orderlysoftware.orderlycalls.asterisk.manager

Encapsulates login and connection info for the Asterisk Manager system.

ManagerSettings() - Constructor for class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerSettings

ManagerSettings(String, int, String, String) - Constructor for class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerSettings

ManagerSettings.ManagerEventListenerSettings - Class in com.orderlysoftware.orderlycalls.asterisk.manager

ManagerSettings.ManagerEventListenerSettings() - Constructor for class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerSettings.ManagerEventListenerSettings

Message - Class in com.orderlysoftware.orderlycalls.base

This class represents an ordered set of key-value Pairs, with an option amount of free-text data, suitable for use with Asterisk's Manager API.

Message() - Constructor for class com.orderlysoftware.orderlycalls.base.Message

MOBILES - Static variable in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

monitor(String, String, String, boolean) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Monitor a channel

N

nextCaller() - Static method in class com.orderlysoftware.orderlycalls.examples.ExampleProcessor

This method increases the number of callers received.

NONE - Static variable in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

noop() - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Does nothing.

O

ObjectPool - Class in com.orderlysoftware.orderlycalls.base

This class is used by the framework to pool objects for increased performance.

ObjectPool() - Constructor for class com.orderlysoftware.orderlycalls.base.ObjectPool

OrderlyCalls - Class in com.orderlysoftware.orderlycalls

This is the primary class for the OrderlyCalls application server.

OrderlyCalls() - Constructor for class com.orderlysoftware.orderlycalls.OrderlyCalls

OrderlyCallsImpl - Class in com.orderlysoftware.orderlycalls

The OrderlyCalls class instantiates one of these and calls its methods from within its static methods.

OrderlyCallsImpl() - Constructor for class com.orderlysoftware.orderlycalls.OrderlyCallsImpl

Not recommended.

OrderlyCallsWebDeployer - Class in com.orderlysoftware.orderlycalls

Use this class to ensure services are available inside servlet containers, such as Tomcat.

OrderlyCallsWebDeployer() - Constructor for class com.orderlysoftware.orderlycalls.OrderlyCallsWebDeployer

OrderlyQExample - Class in com.orderlysoftware.orderlycalls.examples

OrderlyQ - Advanced, Caller Friendly Queue Control

OrderlyQExample() - Constructor for class com.orderlysoftware.orderlycalls.examples.OrderlyQExample

OrderlyQExampleSettings - Class in com.orderlysoftware.orderlycalls.examples

OrderlyQ - Advanced, Caller Friendly Queue Control

OrderlyQExampleSettings() - Constructor for class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

originate(String, String, String, String, String, String, long, String, String, String, boolean) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Originate Call

P

Pair - Class in com.orderlysoftware.orderlycalls.base

This class represents a single key-value pair.

Pair(String, String) - Constructor for class com.orderlysoftware.orderlycalls.base.Pair

Constructor.

Pair(String) - Constructor for class com.orderlysoftware.orderlycalls.base.Pair

Parses the input String and creates a new Pair.

parkedCalls() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Lists parked calls.

parse(String) - Static method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

peopleAheadOf(OrderlyQExample.Caller) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExample

ping() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Pings Asterisk.

processCall(AGIConnection) - Method in interface com.orderlysoftware.orderlycalls.asterisk.agi.AGIProcessor

Implement this method to handle incoming calls.

processCall(AGIConnection) - Method in class com.orderlysoftware.orderlycalls.examples.ExampleProcessor

Interacts with the caller, and calls them back after 10 seconds with a message.

processCall(AGIConnection) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExample

processPress(int) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExample

Handles interrupt from caller to enter data.

Q

queueAdd(String, String, String, boolean, String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Add interface to queue.

queueRemove(String, String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Remove interface from queue.

queues() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Shows queue status information for all queues.

queueStatus(String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Causes a series of queue status events to be fired.

R

receiveChar(long) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Receives a character of text on a channel.

recordFile(String, String, String, long, boolean, int) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

recordFile(String, String, String, long, long, boolean) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

recordFile(String, String, String, long, boolean) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

recordFile(String, String, String, long, long, boolean, int) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Record to a file until a given dtmf digit in the sequence is received.

redirect(String, String, String, String, String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Redirects channel(s) to a different extension.

removeHandler(Handler) - Method in class com.orderlysoftware.orderlycalls.base.ServiceLogger

removeManagerEventListener(ManagerEventListener) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Call this method to remove event listeners.

removeService(Service) - Method in class com.orderlysoftware.orderlycalls.OrderlyCalls

Removes a service (with a named Settings object) from the framework.

removeService(Service) - Method in class com.orderlysoftware.orderlycalls.OrderlyCallsImpl

Removes a service (with a named Settings object) from the framework.

run() - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Reads the properties and runs the processor.

run() - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIServer

Listens for incoming connections, creates a new AGICall object and runs it with the given AGIProcessor in a new thread.

run() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.event.ManagerEventDispatcher

Launches threads to handle the event.

run() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

The message queue thread.

run() - Method in class com.orderlysoftware.orderlycalls.examples.ExampleManagerEventListener

Waits for 10 seconds, then initiates a callback.

S

safeClean() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Closes any connections without throwing an exception.

sayDigits(String, String) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Say a given digit string, returning early if any of the given DTMF digits are received on the channel.

sayNumber(String, String) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Say a given number, returning early if any of the given DTMF digits are received on the channel.

sayPhonetic(String, String) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Say a given character string with phonetics, returning early if any of the given DTMF digits are received on the channel.

sayTime(long, String) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Say a given time, returning early if any of the given DTMF digits are received on the channel.

send(ManagerAction) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Once you've got a connected ManagerClient object, call this method to send Actions to the Asterisk system.

sendImage(String) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Sends the given image on a channel.

sendText(String) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Sends the given text on a channel.

Service - Class in com.orderlysoftware.orderlycalls.base

Service is the base class for all OrderlyCalls Named Services.

Service() - Constructor for class com.orderlysoftware.orderlycalls.base.Service

Default constructor.

Service(Settings) - Constructor for class com.orderlysoftware.orderlycalls.base.Service

Creates a Service with the specified Settings.

ServiceLogger - Class in com.orderlysoftware.orderlycalls.base

A thin wrapper around the Loggerobject to give named entries in the log file for services.

ServiceLogger(Logger) - Constructor for class com.orderlysoftware.orderlycalls.base.ServiceLogger

setActionTimeout(long) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Sets how long this manager will wait for a response before

setActionTimeout(long) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerSettings

setActivate(int) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

OrderlyQ activation strategy.

setActivateSize(int) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

The queue size at which to start offering OrderlyQ.

setActivateWait(double) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

The wait time at which to start offering OrderlyQ.

setAddress(InetSocketAddress) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGISettings.BindSettings

Sets the address to listen on.

setAutoHangup(int) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Cause the channel to automatically hangup in the future.

setBindings(ArrayList) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGISettings

setCallerID(String) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Changes the callerId of the current channel.

setCDRUserField(String, String, String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Sets the CDR user field.

setClassName(String) - Method in class com.orderlysoftware.orderlycalls.base.Definition

Sets the full name of the Service class.

setClient(ManagerClient) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.event.ManagerEvent

setClient(ManagerClient) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.event.ManagerEventDispatcher

Gets the ManagerClient associated with this ManagerEventDispatcher.

setComplete(boolean) - Method in class com.orderlysoftware.orderlycalls.base.Message

Indicates that this message is finished.

setContext(String) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Sets the context for continuation upon exiting the application.

setExecutorService(ExecutorService) - Static method in class com.orderlysoftware.orderlycalls.base.Service

setExtension(String) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Changes the extension for continuation upon exiting the application

setExtraOffer(int) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

When to describe the facility to call back from an extra number.

setExtraPrompt(int) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

Which calls to offer the ability to call back on a different number.

setExtraSize(int) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

The queue size at which to start offering the ability to call back on a different number.

setExtraWait(double) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

The estimated wait time at which to start offering the ability to call back on a different number.

setFilter(Filter) - Method in class com.orderlysoftware.orderlycalls.base.ServiceLogger

setFreeform(StringBuffer) - Method in class com.orderlysoftware.orderlycalls.base.Message

Messages may be accompanied by data that does not conform to the "key: value" format.

setHangUp(int) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

When to hang up on callers.

setHangUpSize(int) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

Number of people ahead of caller at which to force hang up.

setHangUpWait(double) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

Estimated wait time at which to force hang up.

setHost(String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerSettings

setInstance(OrderlyCallsImpl) - Static method in class com.orderlysoftware.orderlycalls.OrderlyCalls

Sets the underlying instance.

setLevel(Level) - Method in class com.orderlysoftware.orderlycalls.base.ServiceLogger

setListenerClass(Class) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerSettings.ManagerEventListenerSettings

setLogLevel(Level) - Static method in class com.orderlysoftware.orderlycalls.OrderlyCalls

Sets the logging level.

setLogLevel(String) - Static method in class com.orderlysoftware.orderlycalls.OrderlyCalls

Sets the logging level.

setLogLevel(Level) - Method in class com.orderlysoftware.orderlycalls.OrderlyCallsImpl

Sets the logging level.

setLogLevel(String) - Method in class com.orderlysoftware.orderlycalls.OrderlyCallsImpl

Sets the logging level.

setManagerEventListenerSettings(ArrayList) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerSettings

Sets the list of classes to be added as listeners on start-up of this client.

setMobilePattern(String) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

A regular expression used to detect calls from mobiles.

setMusic(boolean) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Enables/Disables the music on hold generator with the default music class.

setMusic(boolean, String) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Enables/Disables the music on hold generator.

setMusic(String) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

The music to play to callers.

setName(String) - Method in class com.orderlysoftware.orderlycalls.base.Settings

Sets the name of this Settings instance.

setParent(Logger) - Method in class com.orderlysoftware.orderlycalls.base.ServiceLogger

setPassword(String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerSettings

setPersistAfterCall(double) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

How long a caller remains at the front of the queue after speaking to an agent.

setPersistNoCall(double) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

How long a caller remains at the front of the queue after reaching it without calling back.

setPort(int) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerSettings

setPrefix(String) - Method in class com.orderlysoftware.orderlycalls.base.ServiceLogger

setPriority(String) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Changes the priority (the number attached to the extension in extensions.conf) for continuation upon exiting the application.

setProcessorClass(Class) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGISettings

Sets the class of AGIProcessor to be used.

setRate(double) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

The rate at which to pass callers through to agents.

setRateStrategy(int) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

Whether the rate is fixed, or dependent on the number of logged in agents.

setResponse(ManagerResponse) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.action.ManagerAction

Associates a response with this action.

setReuse(boolean) - Static method in class com.orderlysoftware.orderlycalls.OrderlyCalls

setRounding(int) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

Round seconds to minutes.

setSecondsLeft(OrderlyQExample.Caller) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExample

setServer(AGIServer) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

setSettings(AGIServer, OrderlyQExampleSettings) - Static method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExample

Store a settings object for a particular AGIServer.

setSettingsName(String) - Method in class com.orderlysoftware.orderlycalls.base.Definition

Sets the full name of the Settings class.

setSocket(Socket) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

setTag(String) - Method in class com.orderlysoftware.orderlycalls.base.Definition

Sets the name of the tag that will represent this kind of Service.

setTextAvailable(int) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

Who to offer texts to.

setTextDelay(double) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

How long to delay sending texts.

setTextMessage(String) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

Sets the text message to send to mobiles.

setTextOffer(int) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

When to offer the facility to sign up for texts.

setTextPrompt(int) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

Whether to offer texts on queue entry only, or on subsequent calls.

setTextSend(int) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

Whether to send texts immediately or with a delay.

setTextSize(int) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

People ahead of caller at which the facility to sign up for texts is offered.

setTextWait(double) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

Estimated wait time at which to offer the facility to sign up for texts.

settings - Variable in class com.orderlysoftware.orderlycalls.base.Service

Settings - Class in com.orderlysoftware.orderlycalls.base

This class holds initialisation data for the Serviceobjects created by OrderlyCalls.

Settings() - Constructor for class com.orderlysoftware.orderlycalls.base.Settings

setType(String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.event.ManagerEvent

setUseParentHandlers(boolean) - Method in class com.orderlysoftware.orderlycalls.base.ServiceLogger

setUsername(String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerSettings

setVar(String, String, String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Set a local channel variable.

setVariable(String, String) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Sets an Asterisk variable

setXMLSettings(Element) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGISettings.BindSettings

Sets properties based on the XML tag passed.

setXMLSettings(Element) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGISettings

Parses input XML to set all properties.

setXMLSettings(Element) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerSettings.ManagerEventListenerSettings

setXMLSettings(Element) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerSettings

setXMLSettings(Element) - Method in class com.orderlysoftware.orderlycalls.base.Settings

Override this method to do your own processing of settings.

setXMLSettings(Element) - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

Parses incoming XML settings.

shutdown() - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIServer

Graceful exit.

shutdown() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Gracefully stops the Client.

shutdown() - Method in class com.orderlysoftware.orderlycalls.base.Service

Shutdown this Service

shutdown() - Method in class com.orderlysoftware.orderlycalls.examples.ExampleService

Clears the stored username and password, so the service cannot be used to log in.

shutdown() - Static method in class com.orderlysoftware.orderlycalls.OrderlyCalls

Shuts down all services.

shutdown() - Method in class com.orderlysoftware.orderlycalls.OrderlyCallsImpl

Shuts down all services.

shutdownAll() - Static method in class com.orderlysoftware.orderlycalls.base.Service

Subclasses SHOULD override this method to shutdown only services of a particular subclass.

SIZE - Static variable in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

status(String, String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Fires channel status events.

status(String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

stopMonitor(String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Stop monitoring (recording) a channel.

streamFile(String) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Send the given file, without interrupt.

streamFile(String, String) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Send the given file, allowing playback to be interrupted by the given digits, if any.

streamFile(String, String, long) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Send the given file, allowing playback to be interrupted by the given digits, if any.

T

tddMode(boolean) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Enable/Disable TDD transmission/reception on a channel.

toString() - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGISettings.BindSettings

Convenience method.

toString() - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGISettings

Convenience method.

toString() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerSettings.ManagerEventListenerSettings

toString() - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerSettings

toString() - Method in class com.orderlysoftware.orderlycalls.base.Definition

Convenience method for logging.

toString() - Method in class com.orderlysoftware.orderlycalls.base.Message

Returns a string that is a list of "key: value" pairs, terminated by a blank line.

toString() - Method in class com.orderlysoftware.orderlycalls.base.Pair

toString() - Method in class com.orderlysoftware.orderlycalls.base.Settings

Gets a representation of this object suitable for logging.

toString() - Method in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

Convenience method.

U

UP - Static variable in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

V

verbose(String, String) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Sends text to the console via verbose message system.

W

WAIT - Static variable in class com.orderlysoftware.orderlycalls.examples.OrderlyQExampleSettings

waitForDigit(long) - Method in class com.orderlysoftware.orderlycalls.asterisk.agi.AGIConnection

Waits up to 'timeout' milliseconds for channel to receive a DTMF digit.

Z

zapDialOffHook(String, String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Dial over Zap channel while offhook

zapDNDOff(String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Toggle Zap channel Do Not Disturb status OFF

zapDNDOn(String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Toggle Zap channel Do Not Disturb status ON

zapHangUp(String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Hangup Zap Channel

zapShowChannels(String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Show Zap Channels

zapTransfer(String) - Method in class com.orderlysoftware.orderlycalls.asterisk.manager.ManagerClient

Transfer Zap Channel

A B C D E F G H I L M N O P Q R S T U V W Z