Using JMX operations

Option	Description
Refresh()	Loads any new descendant modules that have been added to the system after this module was initialized. This module and any descendants that are already loaded and initialized are not affected apart from new child modules being optionally wired to their parent module. Valid operation level: Server Parameters: NIL Returns:StatusCode:Messageformat
Shutdown()	Shuts down the module and all descendant modules. Valid operation level: Server Parameters : NIL Returns :StatusCode:Messageformat
Reset()	This operation removes the binding for the modules' request handler, so that new requests are not serviced during a reset. Then the webroot and moduleRequestUriPrefix are resolved to the modules' respective directory and all contents are recursively deleted. A new Stream request handler will be created using the same configuration settings. Note that the new settings require a shutdown or a refresh. Stats for the Stream module will not be reset until the module is shutdown or the server is restarted. Invoking reset on a Stream Container module resets all the child modules. Valid operation level: stream container and stream module Parameters: NA Returns: StatusCode:Messageformat
setConfig (String xmlConfig)	This should be invoked on an Origin Server stream. It updates the module's xml configuration on disk with the specified xml configuration. This operation does not reload the module. Configuration changes are only reflected when module is reset using the reset() operation. Before replacing the configuration file on the disk, the given xml is validated to ensure that it is a well-formed xml. Note: Attribute validation is not performed on the XML file. Valid operation level: Stream module, VOD module, and Stream Container module Parameters: XML configuration file Returns: StatusCode:Messageformat This should be invoked on an Origin Server stream or VOD module. It updates the module's xml configuration on disk with the specified xml configuration. This operation does not reload the module. Configuration changes are only reflected when module is reset using the `reset()` operation. Before replacing the configuration file on the disk, the given xml is validated to ensure that it is a well formed xml. Parameters: XML configuration file Returns: IModule.StatusCode as a string Message on successful operation: String "success.completed" Errors: String "`error.failed`" for an unsuccessful operation. String "`error.not_implemented`" if the operation is invoked on a module that does not support it.
getConfig(String xmlConfig)	It should be invoked on an Origin Server Stream or VOD module. This reads the existing xml configuration for the given module from the disk and returns the configuration as a string. It does not affect the current state or configuration of the module. Valid operation level: VOD module, stream container module, and stream module Parameters: None Returns: The existing XML configuration. Message on successful operation: None Errors: String "`error.failed`" for an unsuccessful operation. String "`error.not_implemented`" if the operation is invoked on a module that does not support it.
String createChildModule(String moduleName, String moduleType, String moduleConfig)	This should be invoked on a StreamContainerModule of Origin Server. It is used to create a new stream or VOD module under the given StreamContainerModule. This operation verifies the existing modules under the StreamContainerModule to check if there is already another module by the given name. This operation also checks if the configuration xml is well formed. If both these validations succeed, then it creates a new directory for the new module and then copies the configuration xml to the new module. This operation does not instantiate the new module or binds it to the parent module. It creates the required xml configuration on the disk. To instantiate and bind the module to the parent module, the `refresh()` operation must be invoked on the parent module. Parameters: Module name: name of the child module. Module type: Type of the module. It can be Stream or vod. Module configuration file. Returns: StatusCode:Messageformat Valid operation level: StreamContainerModule
public String removeChildModule(String moduleName, String moduleType)	This operation can be invoked on a Stream Container module in Origin Server to remove the `conf` folder of a Stream or VOD Module with given Module ID. This operation does not remove a running module. To remove `conf` for a child module, the child must first be stopped using the shutdown() operation. In case this operation is invoked to remove a running module, error message is returned. Also, if the configuration for the module to be removed does not exist on the disk, it returns an error string. This operation only removes the config folder for the specified folder and does not perform any other cleanup. The `Rest()` method provided by the Module's LivecyclyManager MBean must be used for clean-up purposes. Valid operation level: StreamContainerModule Parameters: Module name: name of the child module. Module type: Type of the module. It can be Stream or vod. Module configuration file. Returns: StatusCode:Messageformat

Refresh()

Loads any new descendant modules that have been added to the system after this module was initialized. This module and any descendants that are already loaded and initialized are not affected apart from new child modules being optionally wired to their parent module.

Valid operation level: Server

Parameters: NIL

Returns:StatusCode:Messageformat

Shutdown()

Shuts down the module and all descendant modules.

Valid operation level: Server

Parameters : NIL

Returns :StatusCode:Messageformat

Reset()

This operation removes the binding for the modules' request handler, so that new requests are not serviced during a reset. Then the webroot and moduleRequestUriPrefix are resolved to the modules' respective directory and all contents are recursively deleted. A new Stream request handler will be created using the same configuration settings. Note that the new settings require a shutdown or a refresh. Stats for the Stream module will not be reset until the module is shutdown or the server is restarted. Invoking reset on a Stream Container module resets all the child modules.

Valid operation level: stream container and stream module

Parameters: NA

Returns: StatusCode:Messageformat

setConfig (String xmlConfig)

This should be invoked on an Origin Server stream. It updates the module's xml configuration on disk with the specified xml configuration. This operation does not reload the module. Configuration changes are only reflected when module is reset using the reset() operation. Before replacing the configuration file on the disk, the given xml is validated to ensure that it is a well-formed xml.

Note:

Attribute validation is not performed on the XML file.

Valid operation level: Stream module, VOD module, and Stream Container module

Parameters: XML configuration file

Returns: StatusCode:Messageformat

This should be invoked on an Origin Server stream or VOD module. It updates the module's xml configuration on disk with the specified xml configuration. This operation does not reload the module. Configuration changes are only reflected when module is reset using the reset() operation. Before replacing the configuration file on the disk, the given xml is validated to ensure that it is a well formed xml.

Parameters: XML configuration file

Returns: IModule.StatusCode as a string

Message on successful operation: String "success.completed"

Errors:

String "error.failed" for an unsuccessful operation.
String "error.not_implemented" if the operation is invoked on a module that does not support it.

getConfig(String xmlConfig)

It should be invoked on an Origin Server Stream or VOD module. This reads the existing xml configuration for the given module from the disk and returns the configuration as a string. It does not affect the current state or configuration of the module.

Valid operation level: VOD module, stream container module, and stream module

Parameters: None

Returns: The existing XML configuration.

Message on successful operation: None

Errors:

String "error.failed" for an unsuccessful operation.
String "error.not_implemented" if the operation is invoked on a module that does not support it.

String createChildModule(String moduleName, String moduleType, String moduleConfig)

This should be invoked on a StreamContainerModule of Origin Server. It is used to create a new stream or VOD module under the given StreamContainerModule. This operation verifies the existing modules under the StreamContainerModule to check if there is already another module by the given name. This operation also checks if the configuration xml is well formed. If both these validations succeed, then it creates a new directory for the new module and then copies the configuration xml to the new module. This operation does not instantiate the new module or binds it to the parent module. It creates the required xml configuration on the disk. To instantiate and bind the module to the parent module, the refresh() operation must be invoked on the parent module.

Parameters:

Module name: name of the child module.
Module type: Type of the module. It can be Stream or vod.
Module configuration file.

Returns: StatusCode:Messageformat

Valid operation level: StreamContainerModule

public String removeChildModule(String moduleName, String moduleType)

This operation can be invoked on a Stream Container module in Origin Server to remove the conf folder of a Stream or VOD Module with given Module ID.

This operation does not remove a running module. To remove conf for a child module, the child must first be stopped using the shutdown() operation. In case this operation is invoked to remove a running module, error message is returned. Also, if the configuration for the module to be removed does not exist on the disk, it returns an error string. This operation only removes the config folder for the specified folder and does not perform any other cleanup. The Rest() method provided by the Module's LivecyclyManager MBean must be used for clean-up purposes.

Valid operation level: StreamContainerModule

Parameters:

Module name: name of the child module.
Module type: Type of the module. It can be Stream or vod.
Module configuration file.

Returns: StatusCode:Messageformat