Asterisk-Java

org.asteriskjava.manager.action
Class ModuleCheckAction

java.lang.Object
  extended by org.asteriskjava.manager.action.AbstractManagerAction
      extended by org.asteriskjava.manager.action.ModuleCheckAction
All Implemented Interfaces:
java.io.Serializable, ManagerAction

public class ModuleCheckAction
extends AbstractManagerAction

The ModuleLoadAction checks if an Asterisk module is loaded and reports its version.

The ModuleLoadAction returns a ModuleCheckResponse with the version of the module if the module is loaded and a ManagerError if the module is not loaded.

Available since Asterisk 1.6

Since:
1.0.0
Version:
$Id: ModuleCheckAction.java 1132 2008-08-18 13:00:35Z srt $
Author:
srt
See Also:
Serialized Form

Constructor Summary
ModuleCheckAction()
          Creates a new ModuleCheckAction.
ModuleCheckAction(java.lang.String module)
          Creates a new ModuleCheckAction with the given parameters.
 
Method Summary
 java.lang.String getAction()
          Returns the name of this action, i.e.
 java.lang.String getModule()
          Returns the name of the module to check.
 void setModule(java.lang.String module)
          Sets the name of the module (including or not including the ".so" extension) to check.
 
Methods inherited from class org.asteriskjava.manager.action.AbstractManagerAction
getActionId, setActionId, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ModuleCheckAction

public ModuleCheckAction()
Creates a new ModuleCheckAction.


ModuleCheckAction

public ModuleCheckAction(java.lang.String module)
Creates a new ModuleCheckAction with the given parameters.

Parameters:
module - the name of the module (including or not including the ".so" extension).
Method Detail

getAction

public java.lang.String getAction()
Returns the name of this action, i.e. "ModuleLoad".

Specified by:
getAction in interface ManagerAction
Specified by:
getAction in class AbstractManagerAction

getModule

public java.lang.String getModule()
Returns the name of the module to check.

Returns:
the name of the module to check.

setModule

public void setModule(java.lang.String module)
Sets the name of the module (including or not including the ".so" extension) to check.

Parameters:
module - the name of the module (including or not including the ".so" extension) to check.

Asterisk-Java

Copyright © 2004-2009 Stefan Reuter. All Rights Reserved.