DefaultAsteriskServer (Asterisk-Java 3.40.1 API)

java.lang.Object
- org.asteriskjava.live.DefaultAsteriskServer

All Implemented Interfaces:

AsteriskServer

Direct Known Subclasses:

SecureAsteriskServer
```
public class DefaultAsteriskServer
extends Object
implements AsteriskServer
```
Default implementation of the AsteriskServer interface.

Version:

$Id$

Author:

srt

See Also:

AsteriskServer

Constructor Summary

Constructors
Constructor and Description
`DefaultAsteriskServer()` Creates a new instance without a `ManagerConnection`.
`DefaultAsteriskServer(ManagerConnection eventConnection)` Creates a new instance that uses the given `ManagerConnection`.
`DefaultAsteriskServer(String hostname, int port, String username, String password)` Creates a new instance and a new `ManagerConnection` with the given connection data.
`DefaultAsteriskServer(String hostname, String username, String password)` Creates a new instance and a new `ManagerConnection` with the given connection data.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAsteriskServerListener(AsteriskServerListener listener)` Adds a listener to this AsteriskServer.
`void`	`addChainListener(ManagerEventListener chainListener)` The chainListener allows a listener to receive manager events after they have been processed by the AsteriskServer.
`protected DefaultManagerConnection`	`createManagerConnection(String hostname, int port, String username, String password)`
`List<String>`	`executeCliCommand(String command)` Executes a command line interface (CLI) command.
`void`	`forceQueuesMonitor(boolean force)` every time we get an event of a queue we reload the information about it from the Asterisk Server
`Collection<AsteriskAgent>`	`getAgents()` Return the agents, registered at Asterisk server.
`AsteriskChannel`	`getChannelById(String id)` Returns a channel by its unique id.
`AsteriskChannel`	`getChannelByName(String name)` Returns a channel by its name.
`Collection<AsteriskChannel>`	`getChannels()` Returns the active channels of the Asterisk server.
`ConfigFile`	`getConfig(String filename)` Reads the given Asterisk configuration file.
`String`	`getGlobalVariable(String variable)` Returns the value of the given global variable.
`ManagerConnection`	`getManagerConnection()` Returns the underlying ManagerConnection.
`MeetMeRoom`	`getMeetMeRoom(String name)` Returns the MeetMe room with the given number, if the room does not yet exist a new `MeetMeRoom` object is created.
`Collection<MeetMeRoom>`	`getMeetMeRooms()` Returns the acitve MeetMe rooms on the Asterisk server.
`AsteriskQueue`	`getQueueByName(String queueName)` get Asterisk Queue by name
`Collection<AsteriskQueue>`	`getQueues()` Returns the queues served by the Asterisk server.
`List<AsteriskQueue>`	`getQueuesUpdatedAfter(Date date)` List of Queues Objects updated after certain date
`String`	`getVersion()` Returns the exact version string of this Asterisk server.
`int[]`	`getVersion(String file)` Returns the CVS revision of a given source file of this Asterisk server.
`Collection<Voicemailbox>`	`getVoicemailboxes()` Returns a collection of all voicemailboxes configured for this Asterisk server with the number of new and old messages they contain.
`void`	`initialize()` Opens the connection to this server.
`boolean`	`isAsteriskServerListening(AsteriskServerListener listener)` Checks whether the listener is already registered with this Asterisk server
`boolean`	`isModuleLoaded(String module)` Checks whether a module is currently loaded.
`boolean`	`isQueuesMonitorForced()` Check if the Queue Information is forced
`void`	`loadModule(String module)` Loads a module or subsystem Available since Asterisk 1.6
`AsteriskChannel`	`originate(OriginateAction originateAction)` Generates an outgoing channel.
`void`	`originateAsync(OriginateAction originateAction, OriginateCallback cb)` Asynchronously generates an outgoing channel.
`AsteriskChannel`	`originateToApplication(String channel, String application, String data, long timeout)` Generates an outgoing channel to an application.
`AsteriskChannel`	`originateToApplication(String channel, String application, String data, long timeout, CallerId callerId, Map<String,String> variables)` Generates an outgoing channel to an application and sets an optional map of channel variables.
`void`	`originateToApplicationAsync(String channel, String application, String data, long timeout, CallerId callerId, Map<String,String> variables, OriginateCallback cb)` Asynchronously generates an outgoing channel to an application and sets an optional map of channel variables.
`void`	`originateToApplicationAsync(String channel, String application, String data, long timeout, OriginateCallback cb)` Asynchronously generates an outgoing channel to an application.
`AsteriskChannel`	`originateToExtension(String channel, String context, String exten, int priority, long timeout)` Generates an outgoing channel to a dialplan entry (extension, context, priority).
`AsteriskChannel`	`originateToExtension(String channel, String context, String exten, int priority, long timeout, CallerId callerId, Map<String,String> variables)` Generates an outgoing channel to a dialplan entry (extension, context, priority) and sets an optional map of channel variables.
`void`	`originateToExtensionAsync(String channel, String context, String exten, int priority, long timeout, CallerId callerId, Map<String,String> variables, OriginateCallback cb)` Asynchronously generates an outgoing channel to a dialplan entry (extension, context, priority) and sets an optional map of channel variables.
`void`	`originateToExtensionAsync(String channel, String context, String exten, int priority, long timeout, OriginateCallback cb)` Asynchronously generates an outgoing channel to a dialplan entry (extension, context, priority).
`void`	`reloadAllModules()` Reloads all currently loaded modules.
`void`	`reloadModule(String module)` Reloads a module or subsystem.
`void`	`removeAsteriskServerListener(AsteriskServerListener listener)` Removes a listener from this Asterisk server.
`void`	`removeChainListener(ManagerEventListener chainListener)` remove the chain listener.
`void`	`setGlobalVariable(String variable, String value)` Sets the value of the given global variable.
`void`	`setManagerConnection(ManagerConnection eventConnection)`
`void`	`setSkipQueues(boolean skipQueues)` Determines if queue status is retrieved at startup.
`void`	`shutdown()` Closes the connection to this server.
`void`	`unloadModule(String module)` Unloads a module or subsystem.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultAsteriskServer
```
public DefaultAsteriskServer()
```
    Creates a new instance without a ManagerConnection. The ManagerConnection must be set using setManagerConnection(ManagerConnection) before you can use this AsteriskServer.
  - DefaultAsteriskServer
```
public DefaultAsteriskServer(String hostname,
                             String username,
                             String password)
```
    Creates a new instance and a new ManagerConnection with the given connection data.
    
    Parameters:
    
    hostname - the hostname of the Asterisk server to connect to.
    
    username - the username to use for login
    
    password - the password to use for login
  - DefaultAsteriskServer
```
public DefaultAsteriskServer(String hostname,
                             int port,
                             String username,
                             String password)
```
    Creates a new instance and a new ManagerConnection with the given connection data.
    
    Parameters:
    
    hostname - the hostname of the Asterisk server to connect to.
    
    port - the port where Asterisk listens for incoming Manager API connections, usually 5038.
    
    username - the username to use for login
    
    password - the password to use for login
  - DefaultAsteriskServer
```
public DefaultAsteriskServer(ManagerConnection eventConnection)
```
    Creates a new instance that uses the given ManagerConnection.
    
    Parameters:
    
    eventConnection - the ManagerConnection to use for receiving events from Asterisk.
- Method Detail
  - createManagerConnection
```
protected DefaultManagerConnection createManagerConnection(String hostname,
                                                           int port,
                                                           String username,
                                                           String password)
```
  - setSkipQueues
```
public void setSkipQueues(boolean skipQueues)
```
    Determines if queue status is retrieved at startup. If you don't need queue information and still run Asterisk 1.0.x you can set this to true to circumvent the startup delay caused by the missing QueueStatusComplete event.
    Default is false.
    
    Parameters:
    
    skipQueues - true to skip queue initialization, false to not skip.
    
    Since:
    
    0.2
  - setManagerConnection
```
public void setManagerConnection(ManagerConnection eventConnection)
```
  - initialize
```
public void initialize()
                throws ManagerCommunicationException
```
    Description copied from interface: AsteriskServer
    
    Opens the connection to this server.
    
    Specified by:
    
    initialize in interface AsteriskServer
    
    Throws:
    
    ManagerCommunicationException - if login fails
  - getManagerConnection
```
public ManagerConnection getManagerConnection()
```
    Description copied from interface: AsteriskServer
    
    Returns the underlying ManagerConnection.
    Unlike the methods operating on the manager connection this method does not implicitly initialize the connection. Thus you can use this method to add custom ManagerEventListeners before the connection to the Asterisk server is established. If you want to ensure that the connection is established call AsteriskServer.initialize().
    
    Specified by:
    
    getManagerConnection in interface AsteriskServer
    
    Returns:
    
    the underlying ManagerConnection.
  - originate
```
public AsteriskChannel originate(OriginateAction originateAction)
                          throws ManagerCommunicationException,
                                 NoSuchChannelException
```
    Description copied from interface: AsteriskServer
    
    Generates an outgoing channel.
    
    Specified by:
    
    originate in interface AsteriskServer
    
    Parameters:
    
    originateAction - the action that contains parameters for the originate
    
    Returns:
    
    the generated channel
    
    Throws:
    
    ManagerCommunicationException - if the originate action cannot be sent to Asterisk
    
    NoSuchChannelException - if the channel is not available on the Asterisk server, for example because you used "SIP/1310" and 1310 is not a valid SIP user, the SIP channel module hasn't been loaded or the SIP or IAX peer is not registered currently.
  - originateToExtension
```
public AsteriskChannel originateToExtension(String channel,
                                            String context,
                                            String exten,
                                            int priority,
                                            long timeout)
                                     throws ManagerCommunicationException,
                                            NoSuchChannelException
```
    Description copied from interface: AsteriskServer
    
    Generates an outgoing channel to a dialplan entry (extension, context, priority).
    
    Specified by:
    
    originateToExtension in interface AsteriskServer
    
    Parameters:
    
    channel - channel name to call, for example "SIP/1310".
    
    context - context to connect to
    
    exten - extension to connect to
    
    priority - priority to connect to
    
    timeout - how long to wait for the channel to be answered before its considered to have failed (in ms)
    
    Returns:
    
    the generated channel
    
    Throws:
    
    ManagerCommunicationException - if the originate action cannot be sent to Asterisk
    
    NoSuchChannelException - if the channel is not available on the Asterisk server, for example because you used "SIP/1310" and 1310 is not a valid SIP user, the SIP channel module hasn't been loaded or the SIP or IAX peer is not registered currently.
  - originateToExtension
```
public AsteriskChannel originateToExtension(String channel,
                                            String context,
                                            String exten,
                                            int priority,
                                            long timeout,
                                            CallerId callerId,
                                            Map<String,String> variables)
                                     throws ManagerCommunicationException,
                                            NoSuchChannelException
```
    Description copied from interface: AsteriskServer
    
    Generates an outgoing channel to a dialplan entry (extension, context, priority) and sets an optional map of channel variables.
    
    Specified by:
    
    originateToExtension in interface AsteriskServer
    
    Parameters:
    
    channel - channel name to call, for example "SIP/1310".
    
    context - context to connect to
    
    exten - extension to connect to
    
    priority - priority to connect to
    
    timeout - how long to wait for the channel to be answered before its considered to have failed (in ms)
    
    callerId - callerId to use for the outgoing channel, may be null.
    
    variables - channel variables to set, may be null.
    
    Returns:
    
    the generated channel
    
    Throws:
    
    ManagerCommunicationException - if the originate action cannot be sent to Asterisk
    
    NoSuchChannelException - if the channel is not available on the Asterisk server, for example because you used "SIP/1310" and 1310 is not a valid SIP user, the SIP channel module hasn't been loaded or the SIP or IAX peer is not registered currently.
  - originateToApplication
```
public AsteriskChannel originateToApplication(String channel,
                                              String application,
                                              String data,
                                              long timeout)
                                       throws ManagerCommunicationException,
                                              NoSuchChannelException
```
    Description copied from interface: AsteriskServer
    
    Generates an outgoing channel to an application.
    
    Specified by:
    
    originateToApplication in interface AsteriskServer
    
    Parameters:
    
    channel - channel name to call, for example "SIP/1310".
    
    application - application to connect to, for example "MeetMe"
    
    data - data to pass to the application, for example "1000|d", may be null.
    
    timeout - how long to wait for the channel to be answered before its considered to have failed (in ms)
    
    Returns:
    
    the generated channel
    
    Throws:
    
    ManagerCommunicationException - if the originate action cannot be sent to Asterisk
    
    NoSuchChannelException - if the channel is not available on the Asterisk server, for example because you used "SIP/1310" and 1310 is not a valid SIP user, the SIP channel module hasn't been loaded or the SIP or IAX peer is not registered currently.
  - originateToApplication
```
public AsteriskChannel originateToApplication(String channel,
                                              String application,
                                              String data,
                                              long timeout,
                                              CallerId callerId,
                                              Map<String,String> variables)
                                       throws ManagerCommunicationException,
                                              NoSuchChannelException
```
    Description copied from interface: AsteriskServer
    
    Generates an outgoing channel to an application and sets an optional map of channel variables.
    
    Specified by:
    
    originateToApplication in interface AsteriskServer
    
    Parameters:
    
    channel - channel name to call, for example "SIP/1310".
    
    application - application to connect to, for example "MeetMe"
    
    data - data to pass to the application, for example "1000|d", may be null.
    
    timeout - how long to wait for the channel to be answered before its considered to have failed (in ms)
    
    callerId - callerId to use for the outgoing channel, may be null.
    
    variables - channel variables to set, may be null.
    
    Returns:
    
    the generated channel
    
    Throws:
    
    ManagerCommunicationException - if the originate action cannot be sent to Asterisk
    
    NoSuchChannelException - if the channel is not available on the Asterisk server, for example because you used "SIP/1310" and 1310 is not a valid SIP user, the SIP channel module hasn't been loaded or the SIP or IAX peer is not registered currently.
  - originateAsync
```
public void originateAsync(OriginateAction originateAction,
                           OriginateCallback cb)
                    throws ManagerCommunicationException
```
    Description copied from interface: AsteriskServer
    
    Asynchronously generates an outgoing channel.
    
    Specified by:
    
    originateAsync in interface AsteriskServer
    
    Parameters:
    
    originateAction - the action that contains parameters for the originate
    
    cb - callback to inform about the result
    
    Throws:
    
    ManagerCommunicationException - if the originate action cannot be sent to Asterisk
  - originateToApplicationAsync
```
public void originateToApplicationAsync(String channel,
                                        String application,
                                        String data,
                                        long timeout,
                                        CallerId callerId,
                                        Map<String,String> variables,
                                        OriginateCallback cb)
                                 throws ManagerCommunicationException
```
    Description copied from interface: AsteriskServer
    
    Asynchronously generates an outgoing channel to an application and sets an optional map of channel variables.
    
    Specified by:
    
    originateToApplicationAsync in interface AsteriskServer
    
    Parameters:
    
    channel - channel name to call, for example "SIP/1310".
    
    application - application to connect to, for example "MeetMe"
    
    data - data to pass to the application, for example "1000|d", may be null.
    
    timeout - how long to wait for the channel to be answered before its considered to have failed (in ms)
    
    callerId - callerId to use for the outgoing channel, may be null.
    
    variables - channel variables to set, may be null.
    
    cb - callback to inform about the result
    
    Throws:
    
    ManagerCommunicationException - if the originate action cannot be sent to Asterisk
  - originateToApplicationAsync
```
public void originateToApplicationAsync(String channel,
                                        String application,
                                        String data,
                                        long timeout,
                                        OriginateCallback cb)
                                 throws ManagerCommunicationException
```
    Description copied from interface: AsteriskServer
    
    Asynchronously generates an outgoing channel to an application.
    
    Specified by:
    
    originateToApplicationAsync in interface AsteriskServer
    
    Parameters:
    
    channel - channel name to call, for example "SIP/1310".
    
    application - application to connect to, for example "MeetMe"
    
    data - data to pass to the application, for example "1000|d", may be null.
    
    timeout - how long to wait for the channel to be answered before its considered to have failed (in ms)
    
    cb - callback to inform about the result
    
    Throws:
    
    ManagerCommunicationException - if the originate action cannot be sent to Asterisk
  - originateToExtensionAsync
```
public void originateToExtensionAsync(String channel,
                                      String context,
                                      String exten,
                                      int priority,
                                      long timeout,
                                      CallerId callerId,
                                      Map<String,String> variables,
                                      OriginateCallback cb)
                               throws ManagerCommunicationException
```
    Description copied from interface: AsteriskServer
    
    Asynchronously generates an outgoing channel to a dialplan entry (extension, context, priority) and sets an optional map of channel variables.
    
    Specified by:
    
    originateToExtensionAsync in interface AsteriskServer
    
    Parameters:
    
    channel - channel name to call, for example "SIP/1310".
    
    context - context to connect to
    
    exten - extension to connect to
    
    priority - priority to connect to
    
    timeout - how long to wait for the channel to be answered before its considered to have failed (in ms)
    
    callerId - callerId to use for the outgoing channel, may be null.
    
    variables - channel variables to set, may be null.
    
    cb - callback to inform about the result
    
    Throws:
    
    ManagerCommunicationException - if the originate action cannot be sent to Asterisk
  - originateToExtensionAsync
```
public void originateToExtensionAsync(String channel,
                                      String context,
                                      String exten,
                                      int priority,
                                      long timeout,
                                      OriginateCallback cb)
                               throws ManagerCommunicationException
```
    Description copied from interface: AsteriskServer
    
    Asynchronously generates an outgoing channel to a dialplan entry (extension, context, priority).
    
    Specified by:
    
    originateToExtensionAsync in interface AsteriskServer
    
    Parameters:
    
    channel - channel name to call, for example "SIP/1310".
    
    context - context to connect to
    
    exten - extension to connect to
    
    priority - priority to connect to
    
    timeout - how long to wait for the channel to be answered before its considered to have failed (in ms)
    
    cb - callback to inform about the result
    
    Throws:
    
    ManagerCommunicationException - if the originate action cannot be sent to Asterisk
  - getChannels
```
public Collection<AsteriskChannel> getChannels()
                                        throws ManagerCommunicationException
```
    Description copied from interface: AsteriskServer
    
    Returns the active channels of the Asterisk server.
    
    Specified by:
    
    getChannels in interface AsteriskServer
    
    Returns:
    
    a Collection of active channels.
    
    Throws:
    
    ManagerCommunicationException - if there is a problem communication with Asterisk
  - getChannelByName
```
public AsteriskChannel getChannelByName(String name)
                                 throws ManagerCommunicationException
```
    Description copied from interface: AsteriskServer
    
    Returns a channel by its name.
    
    Specified by:
    
    getChannelByName in interface AsteriskServer
    
    Parameters:
    
    name - name of the channel to return
    
    Returns:
    
    the channel with the given name or null if there is no such channel.
    
    Throws:
    
    ManagerCommunicationException - if there is a problem communication with Asterisk
  - getChannelById
```
public AsteriskChannel getChannelById(String id)
                               throws ManagerCommunicationException
```
    Description copied from interface: AsteriskServer
    
    Returns a channel by its unique id.
    
    Specified by:
    
    getChannelById in interface AsteriskServer
    
    Parameters:
    
    id - the unique id of the channel to return
    
    Returns:
    
    the channel with the given unique id or null if there is no such channel.
    
    Throws:
    
    ManagerCommunicationException - if there is a problem communication with Asterisk
  - getMeetMeRooms
```
public Collection<MeetMeRoom> getMeetMeRooms()
                                      throws ManagerCommunicationException
```
    Description copied from interface: AsteriskServer
    
    Returns the acitve MeetMe rooms on the Asterisk server.
    
    Specified by:
    
    getMeetMeRooms in interface AsteriskServer
    
    Returns:
    
    a Collection of MeetMeRooms
    
    Throws:
    
    ManagerCommunicationException - if there is a problem communication with Asterisk
  - getMeetMeRoom
```
public MeetMeRoom getMeetMeRoom(String name)
                         throws ManagerCommunicationException
```
    Description copied from interface: AsteriskServer
    
    Returns the MeetMe room with the given number, if the room does not yet exist a new MeetMeRoom object is created.
    
    Specified by:
    
    getMeetMeRoom in interface AsteriskServer
    
    Parameters:
    
    name - the number of the room to return
    
    Returns:
    
    the MeetMe room with the given number.
    
    Throws:
    
    ManagerCommunicationException - if there is a problem communication with Asterisk
  - getQueues
```
public Collection<AsteriskQueue> getQueues()
                                    throws ManagerCommunicationException
```
    Description copied from interface: AsteriskServer
    
    Returns the queues served by the Asterisk server.
    
    Specified by:
    
    getQueues in interface AsteriskServer
    
    Returns:
    
    a Collection of queues.
    
    Throws:
    
    ManagerCommunicationException - if there is a problem communication with Asterisk
  - getVersion
```
public String getVersion()
                  throws ManagerCommunicationException
```
    Description copied from interface: AsteriskServer
    
    Returns the exact version string of this Asterisk server.
    This typically looks like "Asterisk 1.2.9.1-BRIstuffed-0.3.0-PRE-1q built by root @ pbx0 on a i686 running Linux on 2006-06-20 20:21:30 UTC".
    
    Specified by:
    
    getVersion in interface AsteriskServer
    
    Returns:
    
    the version of this Asterisk server
    
    Throws:
    
    ManagerCommunicationException - if the version cannot be retrieved from Asterisk
  - getVersion
```
public int[] getVersion(String file)
                 throws ManagerCommunicationException
```
    Description copied from interface: AsteriskServer
    
    Returns the CVS revision of a given source file of this Asterisk server.
    For example getVersion("app_meetme.c") may return {1, 102} for CVS revision "1.102".
    Note that this feature is not available with Asterisk 1.0.x.
    You can use this feature if you need to write applications that behave different depending on specific modules being available in a specific version or not.
    
    Specified by:
    
    getVersion in interface AsteriskServer
    
    Parameters:
    
    file - the file for which to get the version like "app_meetme.c"
    
    Returns:
    
    the CVS revision of the file, or null if that file is not part of the Asterisk instance you are connected to (maybe due to a module that provides it has not been loaded) or if you are connected to an Astersion 1.0.x
    
    Throws:
    
    ManagerCommunicationException - if the version cannot be retrieved from Asterisk
  - getGlobalVariable
```
public String getGlobalVariable(String variable)
                         throws ManagerCommunicationException
```
    Description copied from interface: AsteriskServer
    
    Returns the value of the given global variable.
    
    Specified by:
    
    getGlobalVariable in interface AsteriskServer
    
    Parameters:
    
    variable - the name of the global variable to return.
    
    Returns:
    
    the value of the global variable or null if it is not set.
    
    Throws:
    
    ManagerCommunicationException - if the get variable action cannot be sent to Asterisk.
  - setGlobalVariable
```
public void setGlobalVariable(String variable,
                              String value)
                       throws ManagerCommunicationException
```
    Description copied from interface: AsteriskServer
    
    Sets the value of the given global variable.
    
    Specified by:
    
    setGlobalVariable in interface AsteriskServer
    
    Parameters:
    
    variable - the name of the global variable to set.
    
    value - the value of the global variable to set.
    
    Throws:
    
    ManagerCommunicationException - if the set variable action cannot be sent to Asterisk.
  - getVoicemailboxes
```
public Collection<Voicemailbox> getVoicemailboxes()
                                           throws ManagerCommunicationException
```
    Description copied from interface: AsteriskServer
    
    Returns a collection of all voicemailboxes configured for this Asterisk server with the number of new and old messages they contain.
    
    Specified by:
    
    getVoicemailboxes in interface AsteriskServer
    
    Returns:
    
    a collection of all voicemailboxes configured for this Asterisk server
    
    Throws:
    
    ManagerCommunicationException - if the voicemailboxes can't be retrieved.
  - executeCliCommand
```
public List<String> executeCliCommand(String command)
                               throws ManagerCommunicationException
```
    Description copied from interface: AsteriskServer
    
    Executes a command line interface (CLI) command.
    
    Specified by:
    
    executeCliCommand in interface AsteriskServer
    
    Parameters:
    
    command - the command to execute, for example "sip show peers".
    
    Returns:
    
    a List containing strings representing the lines returned by the CLI command.
    
    Throws:
    
    ManagerCommunicationException - if the command can't be executed.
    
    See Also:
    
    CommandAction
  - isModuleLoaded
```
public boolean isModuleLoaded(String module)
                       throws ManagerCommunicationException
```
    Description copied from interface: AsteriskServer
    
    Checks whether a module is currently loaded.
    Available since Asterisk 1.6
    
    Specified by:
    
    isModuleLoaded in interface AsteriskServer
    
    Parameters:
    
    module - name of the module to load (with out without the ".so" extension).
    
    Returns:
    
    true if the module is currently loaded, false otherwise.
    
    Throws:
    
    ManagerCommunicationException - if the module can't be checked.
  - getConfig
```
public ConfigFile getConfig(String filename)
                     throws ManagerCommunicationException
```
    Description copied from interface: AsteriskServer
    
    Reads the given Asterisk configuration file.
    
    Specified by:
    
    getConfig in interface AsteriskServer
    
    Parameters:
    
    filename - the filename, for example "voicemail.conf".
    
    Returns:
    
    the configuration file.
    
    Throws:
    
    ManagerCommunicationException - if the command can't be executed.
  - reloadAllModules
```
public void reloadAllModules()
                      throws ManagerCommunicationException
```
    Description copied from interface: AsteriskServer
    
    Reloads all currently loaded modules.
    Available since Asterisk 1.6
    
    Specified by:
    
    reloadAllModules in interface AsteriskServer
    
    Throws:
    
    ManagerCommunicationException - if the modules cannot be reloaded.
  - reloadModule
```
public void reloadModule(String module)
                  throws ManagerCommunicationException
```
    Description copied from interface: AsteriskServer
    
    Reloads a module or subsystem.
    Available since Asterisk 1.6
    
    Specified by:
    
    reloadModule in interface AsteriskServer
    
    Parameters:
    
    module - name of the module to reload (including ".so" extension) or subsystem name.
    
    Throws:
    
    ManagerCommunicationException - if the module cannot be reloaded.
  - unloadModule
```
public void unloadModule(String module)
                  throws ManagerCommunicationException
```
    Description copied from interface: AsteriskServer
    
    Unloads a module or subsystem.
    Available since Asterisk 1.6
    
    Specified by:
    
    unloadModule in interface AsteriskServer
    
    Parameters:
    
    module - name of the module to unload (including ".so" extension) or subsystem name.
    
    Throws:
    
    ManagerCommunicationException - if the module cannot be unloaded.
  - loadModule
```
public void loadModule(String module)
                throws ManagerCommunicationException
```
    Description copied from interface: AsteriskServer
    
    Loads a module or subsystem
    Available since Asterisk 1.6
    
    Specified by:
    
    loadModule in interface AsteriskServer
    
    Parameters:
    
    module - name of the module to load (including ".so" extension) or subsystem name.
    
    Throws:
    
    ManagerCommunicationException - if the module cannot be loaded.
  - addAsteriskServerListener
```
public void addAsteriskServerListener(AsteriskServerListener listener)
                               throws ManagerCommunicationException
```
    Description copied from interface: AsteriskServer
    
    Adds a listener to this AsteriskServer.
    If this server is not yet connected it will be implicitly connected.
    
    Specified by:
    
    addAsteriskServerListener in interface AsteriskServer
    
    Parameters:
    
    listener - the listener to add.
    
    Throws:
    
    ManagerCommunicationException - if the server is not yet connected and the connection or initialization fails.
  - removeAsteriskServerListener
```
public void removeAsteriskServerListener(AsteriskServerListener listener)
```
    Description copied from interface: AsteriskServer
    
    Removes a listener from this Asterisk server.
    
    Specified by:
    
    removeAsteriskServerListener in interface AsteriskServer
    
    Parameters:
    
    listener - the listener to remove.
  - isAsteriskServerListening
```
public boolean isAsteriskServerListening(AsteriskServerListener listener)
```
    Description copied from interface: AsteriskServer
    
    Checks whether the listener is already registered with this Asterisk server
    
    Specified by:
    
    isAsteriskServerListening in interface AsteriskServer
    
    Parameters:
    
    listener - the listener to check
    
    Returns:
    
    true, if the listener is already registered.
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AsteriskServer
    
    Closes the connection to this server.
    
    Specified by:
    
    shutdown in interface AsteriskServer
  - getAgents
```
public Collection<AsteriskAgent> getAgents()
                                    throws ManagerCommunicationException
```
    Description copied from interface: AsteriskServer
    
    Return the agents, registered at Asterisk server. (Consider remarks for AsteriskAgent)
    
    Specified by:
    
    getAgents in interface AsteriskServer
    
    Returns:
    
    a Collection of agents
    
    Throws:
    
    ManagerCommunicationException - if there is a problem communication with Asterisk
  - getQueueByName
```
public AsteriskQueue getQueueByName(String queueName)
```
    Description copied from interface: AsteriskServer
    
    get Asterisk Queue by name
    
    Specified by:
    
    getQueueByName in interface AsteriskServer
    
    Parameters:
    
    queueName - Name of the queue to retrieve
    
    Returns:
  - getQueuesUpdatedAfter
```
public List<AsteriskQueue> getQueuesUpdatedAfter(Date date)
```
    Description copied from interface: AsteriskServer
    
    List of Queues Objects updated after certain date
    
    Specified by:
    
    getQueuesUpdatedAfter in interface AsteriskServer
    
    Returns:
  - forceQueuesMonitor
```
public void forceQueuesMonitor(boolean force)
```
    Description copied from interface: AsteriskServer
    
    every time we get an event of a queue we reload the information about it from the Asterisk Server
    
    Specified by:
    
    forceQueuesMonitor in interface AsteriskServer
  - isQueuesMonitorForced
```
public boolean isQueuesMonitorForced()
```
    Description copied from interface: AsteriskServer
    
    Check if the Queue Information is forced
    
    Specified by:
    
    isQueuesMonitorForced in interface AsteriskServer
    
    Returns:
  - addChainListener
```
public void addChainListener(ManagerEventListener chainListener)
```
    Description copied from interface: AsteriskServer
    
    The chainListener allows a listener to receive manager events after they have been processed by the AsteriskServer. If the AsteriskServer is handling messages using the asyncEventHandling then these messages will also be async. You would use the chainListener if you are processing raw events and using the AJ live ChannelManager. If you don't use the chain listener then you can't be certain that a channel name passed in a raw event will match the channel name held by the live Channel Manager. By chaining events you can be certain that events such as channel Rename events have been processed by the live ChannelManager before you receive an event and as such the names will always match. Whilst name matching is not always critical (as you should be matching by the channels unique id) the channel name does also contain state information (Zombie, Masq) in these cases it can be critical that you have the same name otherwise your state information will be out of date.
    
    Specified by:
    
    addChainListener in interface AsteriskServer
  - removeChainListener
```
public void removeChainListener(ManagerEventListener chainListener)
```
    Description copied from interface: AsteriskServer
    
    remove the chain listener.
    
    Specified by:
    
    removeChainListener in interface AsteriskServer

Class DefaultAsteriskServer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultAsteriskServer

DefaultAsteriskServer

DefaultAsteriskServer

DefaultAsteriskServer

Method Detail

createManagerConnection

setSkipQueues

setManagerConnection

initialize

getManagerConnection

originate

originateToExtension

originateToExtension

originateToApplication

originateToApplication

originateAsync

originateToApplicationAsync

originateToApplicationAsync

originateToExtensionAsync

originateToExtensionAsync

getChannels

getChannelByName

getChannelById

getMeetMeRooms

getMeetMeRoom

getQueues

getVersion

getVersion

getGlobalVariable

setGlobalVariable

getVoicemailboxes

executeCliCommand

isModuleLoaded

getConfig

reloadAllModules

reloadModule

unloadModule

loadModule

addAsteriskServerListener

removeAsteriskServerListener

isAsteriskServerListening

shutdown

getAgents

getQueueByName

getQueuesUpdatedAfter

forceQueuesMonitor

isQueuesMonitorForced

addChainListener

removeChainListener