org.asteriskjava.manager.action

Class ModuleLoadAction

java.lang.Object

org.asteriskjava.manager.action.AbstractManagerAction

org.asteriskjava.manager.action.ModuleLoadAction

All Implemented Interfaces:

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$

Author:

srt

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOAD_TYPE_LOAD
static String	LOAD_TYPE_RELOAD
static String	LOAD_TYPE_UNLOAD
static String	SUBSYSTEM_CDR
static String	SUBSYSTEM_DNSMGR
static String	SUBSYSTEM_ENUM
static String	SUBSYSTEM_EXTCONFIG
static String	SUBSYSTEM_HTTP
static String	SUBSYSTEM_MANAGER
static String	SUBSYSTEM_RTP

Constructor Summary

Constructors

Constructor and Description
ModuleLoadAction() Creates a new ModuleLoadAction.
ModuleLoadAction(String module, String loadType) Creates a new ModuleLoadAction with the given parameters.

Method Summary

Modifier and Type	Method and Description
String	getAction() Returns the name of this action, i.e.
String	getLoadType() Returns the operation to perform.
String	getModule() Returns the name of the module or subsystem to perform the operation on.
void	setLoadType(String loadType) Sets the operation to perform ("load", "unload" or "reload").
void	setModule(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 String SUBSYSTEM_CDR

See Also:

Constant Field Values

SUBSYSTEM_ENUM

public static final String SUBSYSTEM_ENUM

See Also:

Constant Field Values

SUBSYSTEM_DNSMGR

public static final String SUBSYSTEM_DNSMGR

See Also:

Constant Field Values

SUBSYSTEM_EXTCONFIG

public static final String SUBSYSTEM_EXTCONFIG

See Also:

Constant Field Values

SUBSYSTEM_MANAGER

public static final String SUBSYSTEM_MANAGER

See Also:

Constant Field Values

SUBSYSTEM_RTP

public static final String SUBSYSTEM_RTP

See Also:

Constant Field Values

SUBSYSTEM_HTTP

public static final String SUBSYSTEM_HTTP

See Also:

Constant Field Values

LOAD_TYPE_LOAD

public static final String LOAD_TYPE_LOAD

See Also:

Constant Field Values

LOAD_TYPE_UNLOAD

public static final String LOAD_TYPE_UNLOAD

See Also:

Constant Field Values

LOAD_TYPE_RELOAD

public static final String LOAD_TYPE_RELOAD

See Also:

Constant Field Values

Constructor Detail

ModuleLoadAction

public ModuleLoadAction()

Creates a new ModuleLoadAction.

ModuleLoadAction

public ModuleLoadAction(String module,
                        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 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 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(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 String getLoadType()

Returns the operation to perform.

Returns:

the operation to perform.

setLoadType

public void setLoadType(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