|
Asterisk-Java | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.asteriskjava.manager.action.AbstractManagerAction
org.asteriskjava.manager.action.UpdateConfigAction
public class UpdateConfigAction
The UpdateConfigAction sends an UpdateConfig command to the asterisk server. Please take note that unlike the manager documentation, this command does not dump back the config file upon success -- it only tells you it succeeded. You should use the handy addCommand method this class provides for specifying what actions you would like to take on the configuration file. It will generate appropriate sequence numbers for the command. You may use the static ACTION_* fields provided by this action to specify what action you would like to take, while avoiding handling the strings required. Plain fields: SrcFilename: Configuration filename to read(e.g. foo.conf) DstFilename: Configuration filename to write(e.g. foo.conf) Reload: Whether or not a reload should take place (or name of specific module) Repeatable fields: Action-XXXXXX: Action to Take (NewCat,RenameCat,DelCat,Update,Delete,Append) Cat-XXXXXX: Category to operate on Var-XXXXXX: Variable to work on Value-XXXXXX: Value to work on Match-XXXXXX: Extra match required to match line
GetConfigResponse
,
addCommand(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
ACTION_APPEND
|
static java.lang.String |
ACTION_DELCAT
|
static java.lang.String |
ACTION_DELETE
|
static java.lang.String |
ACTION_NEWCAT
|
static java.lang.String |
ACTION_RENAMECAT
|
static java.lang.String |
ACTION_UPDATE
|
protected int |
actionCounter
|
protected java.util.Map<java.lang.String,java.lang.String> |
actions
|
protected java.lang.String |
dstFilename
|
protected java.lang.String |
reload
|
protected java.lang.String |
srcFilename
|
Constructor Summary | |
---|---|
UpdateConfigAction()
Creates a new UpdateConfigAction. |
|
UpdateConfigAction(java.lang.String srcFilename,
java.lang.String dstFilename,
boolean reload)
Creates a new UpdateConfigAction with the given parameters. |
Method Summary | |
---|---|
void |
addCommand(java.lang.String action,
java.lang.String cat,
java.lang.String var,
java.lang.String value,
java.lang.String match)
Adds a command to update a config file while sparing you the details of the Manager's required syntax. |
java.lang.String |
getAction()
Returns the name of this action, i.e. |
java.util.Map<java.lang.String,java.lang.String> |
getAttributes()
Returns Map of the action's desired operations where Map keys contain: action,cat,var,value,match pairs followed by -XXXXXX, and the Map values contain the values for those keys. |
java.lang.String |
getDstFilename()
Returns the destination filename. |
java.lang.String |
getReload()
|
java.lang.String |
getSrcFilename()
Returns the source filename. |
void |
setAttributes(java.util.Map<java.lang.String,java.lang.String> actions)
You may use this field to directly, programmatically add your own Map of key,value pairs that you would like to send for this command. |
void |
setDstFilename(java.lang.String filename)
Sets the source filename. |
void |
setReload(boolean reload)
Sets the reload behavior of this action. |
void |
setReload(java.lang.String reload)
Sets the reload behavior of this action, or sets a specific module to be reloaded |
void |
setSrcFilename(java.lang.String filename)
Sets the source filename. |
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 |
---|
public static final java.lang.String ACTION_NEWCAT
public static final java.lang.String ACTION_RENAMECAT
public static final java.lang.String ACTION_DELCAT
public static final java.lang.String ACTION_UPDATE
public static final java.lang.String ACTION_DELETE
public static final java.lang.String ACTION_APPEND
protected java.lang.String srcFilename
protected java.lang.String dstFilename
protected java.lang.String reload
protected int actionCounter
protected java.util.Map<java.lang.String,java.lang.String> actions
Constructor Detail |
---|
public UpdateConfigAction()
public UpdateConfigAction(java.lang.String srcFilename, java.lang.String dstFilename, boolean reload)
srcFilename
- the name of the file to get.Method Detail |
---|
public void addCommand(java.lang.String action, java.lang.String cat, java.lang.String var, java.lang.String value, java.lang.String match)
action
- Action to Take
(NewCat,RenameCat,DelCat,Update,Delete,Append), see static
fieldscat
- Category to operate onvar
- Variable to work onvalue
- Value to work onmatch
- Extra match required to match linepublic java.lang.String getAction()
getAction
in interface ManagerAction
getAction
in class AbstractManagerAction
public java.lang.String getSrcFilename()
public void setSrcFilename(java.lang.String filename)
public java.lang.String getDstFilename()
public void setDstFilename(java.lang.String filename)
public java.lang.String getReload()
public void setReload(java.lang.String reload)
reload
- the reload parameter to setsetReload(boolean)
public void setReload(boolean reload)
reload
- the reload parameter to setsetReload(String)
public java.util.Map<java.lang.String,java.lang.String> getAttributes()
addCommand(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
public void setAttributes(java.util.Map<java.lang.String,java.lang.String> actions)
actions
- the actions to setaddCommand(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
|
Asterisk-Java | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |