Asterisk-Java

org.asteriskjava.manager.action
Class ModuleLoadAction

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

public class ModuleLoadAction
extends AbstractManagerAction

The ModuleLoadAction loads, unloads or reloads Asterisk modules.

Available since Asterisk 1.6

Since:
1.0.0
Version:
$Id: ModuleLoadAction.java 1123 2008-08-17 11:26:34Z srt $
Author:
srt
See Also:
Serialized Form

Field Summary
static java.lang.String LOAD_TYPE_LOAD
           
static java.lang.String LOAD_TYPE_RELOAD
           
static java.lang.String LOAD_TYPE_UNLOAD
           
static java.lang.String SUBSYSTEM_CDR
           
static java.lang.String SUBSYSTEM_DNSMGR
           
static java.lang.String SUBSYSTEM_ENUM
           
static java.lang.String SUBSYSTEM_EXTCONFIG
           
static java.lang.String SUBSYSTEM_HTTP
           
static java.lang.String SUBSYSTEM_MANAGER
           
static java.lang.String SUBSYSTEM_RTP
           
 
Constructor Summary
ModuleLoadAction()
          Creates a new ModuleLoadAction.
ModuleLoadAction(java.lang.String module, java.lang.String loadType)
          Creates a new ModuleLoadAction with the given parameters.
 
Method Summary
 java.lang.String getAction()
          Returns the name of this action, i.e.
 java.lang.String getLoadType()
          Returns the operation to perform.
 java.lang.String getModule()
          Returns the name of the module or subsystem to perform the operation on.
 void setLoadType(java.lang.String loadType)
          Sets the operation to perform ("load", "unload" or "reload").
 void setModule(java.lang.String module)
          Sets the name of the module including the ".so" extension or subsystem ("cdr", "enum", "dnsmgr", "extconfig", "manager", "rtp" or "http") to perform the operation on.
 
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
 

Field Detail

SUBSYSTEM_CDR

public static final java.lang.String SUBSYSTEM_CDR
See Also:
Constant Field Values

SUBSYSTEM_ENUM

public static final java.lang.String SUBSYSTEM_ENUM
See Also:
Constant Field Values

SUBSYSTEM_DNSMGR

public static final java.lang.String SUBSYSTEM_DNSMGR
See Also:
Constant Field Values

SUBSYSTEM_EXTCONFIG

public static final java.lang.String SUBSYSTEM_EXTCONFIG
See Also:
Constant Field Values

SUBSYSTEM_MANAGER

public static final java.lang.String SUBSYSTEM_MANAGER
See Also:
Constant Field Values

SUBSYSTEM_RTP

public static final java.lang.String SUBSYSTEM_RTP
See Also:
Constant Field Values

SUBSYSTEM_HTTP

public static final java.lang.String SUBSYSTEM_HTTP
See Also:
Constant Field Values

LOAD_TYPE_LOAD

public static final java.lang.String LOAD_TYPE_LOAD
See Also:
Constant Field Values

LOAD_TYPE_UNLOAD

public static final java.lang.String LOAD_TYPE_UNLOAD
See Also:
Constant Field Values

LOAD_TYPE_RELOAD

public static final java.lang.String LOAD_TYPE_RELOAD
See Also:
Constant Field Values
Constructor Detail

ModuleLoadAction

public ModuleLoadAction()
Creates a new ModuleLoadAction.


ModuleLoadAction

public ModuleLoadAction(java.lang.String module,
                        java.lang.String loadType)
Creates a new ModuleLoadAction with the given parameters.

Parameters:
module - the name of the module including the ".so" extension or subsystem to perform the operation on or null combined with loadType "reload" to reload all modules.
loadType - the operation to perform ("load", "unload" or "reload").
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 or subsystem to perform the operation on.

Returns:
the name of the module or subsystem to perform the operation on.

setModule

public void setModule(java.lang.String module)
Sets the name of the module including the ".so" extension or subsystem ("cdr", "enum", "dnsmgr", "extconfig", "manager", "rtp" or "http") to perform the operation on.

Parameters:
module - the name of the module including the ".so" extension or subsystem to perform the operation on or null combined with loadType "reload" to reload all modules.
See Also:
SUBSYSTEM_CDR, SUBSYSTEM_ENUM, SUBSYSTEM_DNSMGR, SUBSYSTEM_EXTCONFIG, SUBSYSTEM_MANAGER, SUBSYSTEM_RTP, SUBSYSTEM_HTTP

getLoadType

public java.lang.String getLoadType()
Returns the operation to perform.

Returns:
the operation to perform.

setLoadType

public void setLoadType(java.lang.String loadType)
Sets the operation to perform ("load", "unload" or "reload").

Parameters:
loadType - the operation to perform ("load", "unload" or "reload").
See Also:
LOAD_TYPE_LOAD, LOAD_TYPE_UNLOAD, LOAD_TYPE_RELOAD

Asterisk-Java

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