com.tibco.tibrv.rvdm.jmx
Interface DaemonManagerMBean

public interface DaemonManagerMBean

This JMX MBean interfaces with an RVDM instance.

Control Channel Each RVDM instance communicates with its managed daemons over a control channel (which is a Rendezvous transport). The control channel must be distinct from any transport affected by the subject maps and port map. You must not use the control channel to carry application data messages. Furthermore, you must explicitly configure each managed daemon to use the control channel for RVDM control messages.

Method Summary

java.lang.String	exportConfiguration() Exports the configuration data of this RVDM instance as an XML configuration document.
java.lang.String	getControlChannelDaemon() Gets the control channel daemon of this RVDM instance.
java.lang.String	getControlChannelNetwork() Gets the control channel network of this RVDM instance.
int	getControlChannelService() Gets the control channel service of this RVDM instance.
java.lang.String	getDataDirectory() Gets the data directory of this RVDM instance.
int	getFaultToleranceWeight() Gets the fault tolerance weight of this RVDM instance.
java.lang.String	getName() Gets the name of this RVDM instance.
void	importConfiguration(java.lang.String configurationDocument) Imports an XML configuration document and resets this RVDM instance.
void	setControlChannelDaemon(java.lang.String daemon) Sets the control channel daemon of this RVDM instance.
void	setControlChannelNetwork(java.lang.String network) Sets the control channel network of this RVDM instance.
void	setControlChannelService(int service) Sets the control channel service of this RVDM instance.
void	setDataDirectory(java.lang.String pathname) Sets the data directory of this RVDM instance.
void	setFaultToleranceWeight(int weight) Sets the fault tolerance weight of this RVDM instance.
void	setName(java.lang.String name) Sets the name of this RVDM instance.
void	setPrimaryUserCredentials(java.lang.String currentPassword, java.lang.String newUsername, java.lang.String newPassword) Sets the credentials of the primary user for this RVDM instance.
void	setSecondaryUserCredentials(java.lang.String currentPassword, java.lang.String newUsername, java.lang.String newPassword) Sets the credentials of the secondary user for this RVDM instance.

Method Detail

exportConfiguration

java.lang.String exportConfiguration()
                                     throws java.io.IOException

Exports the configuration data of this RVDM instance as an XML configuration document.

Returns:

The configuration data of this RVDM instance as an XML configuration document

Throws:

java.io.IOException

getControlChannelDaemon

java.lang.String getControlChannelDaemon()
                                         throws java.io.IOException

Gets the control channel daemon of this RVDM instance.

Returns:

The control channel daemon of this RVDM instance

Throws:

java.io.IOException

getControlChannelNetwork

java.lang.String getControlChannelNetwork()
                                          throws java.io.IOException

Gets the control channel network of this RVDM instance.

Returns:

The control channel network of this RVDM instance

Throws:

java.io.IOException

getControlChannelService

int getControlChannelService()
                             throws java.io.IOException

Gets the control channel service of this RVDM instance.

Returns:

The control channel service of this RVDM instance

Throws:

java.io.IOException

getDataDirectory

java.lang.String getDataDirectory()
                                  throws java.io.IOException

Gets the data directory of this RVDM instance. RVDM server stores its configuration data file (RVDM.data.xml) in this file-system directory.

Returns:

The data directory of this RVDM instance

Throws:

java.io.IOException

getFaultToleranceWeight

int getFaultToleranceWeight()
                            throws java.io.IOException

Gets the fault tolerance weight of this RVDM instance.

Returns:

The fault tolerance weight of this RVDM instance

Throws:

java.io.IOException

getName

java.lang.String getName()
                         throws java.io.IOException

Gets the name of this RVDM instance. Names help users distinguish among RVDM instances, but do not affect RVDM operation.

Returns:

The name of this RVDM instance

Throws:

java.io.IOException

importConfiguration

void importConfiguration(java.lang.String configurationDocument)
                         throws java.io.IOException

Imports an XML configuration document and resets this RVDM instance.

Use this method to initialize a new RVDM instance from a previously exported configuration document. We do not recommend overwriting an existing configuration.

Parameters:

configurationDocument - A string representation of a valid XML configuration document

Throws:

java.io.IOException

setControlChannelDaemon

void setControlChannelDaemon(java.lang.String daemon)
                             throws java.io.IOException

Sets the control channel daemon of this RVDM instance.

Parameters:

daemon - The new daemon specification

Throws:

java.io.IOException

setControlChannelNetwork

void setControlChannelNetwork(java.lang.String network)
                              throws java.io.IOException

Sets the control channel network of this RVDM instance.

Parameters:

network - The new network specification

Throws:

java.io.IOException

setControlChannelService

void setControlChannelService(int service)
                              throws java.io.IOException

Sets the control channel service of this RVDM instance.

Parameters:

service - The new service specification

Throws:

java.io.IOException

setDataDirectory

void setDataDirectory(java.lang.String pathname)
                      throws java.io.IOException

Sets the data directory of this RVDM instance. RVDM server stores its configuration data file (RVDM.data.xml) in this file-system directory.

For fault-tolerant operation, ensure that this directory is a shared location, accessible by all members of the fault tolerance group.

Parameters:

pathname - The new data directory

Throws:

java.io.IOException

setFaultToleranceWeight

void setFaultToleranceWeight(int weight)
                             throws java.io.IOException

Sets the fault tolerance weight of this RVDM instance. Weight specifies relative precedence among fault-tolerant instances (with the same control channel). An instance with greater weight takes precedence over an instance with lesser weight.

Parameters:

weight - The new fault tolerance weight

Throws:

java.io.IOException

setName

void setName(java.lang.String name)
             throws java.io.IOException

Sets the name of this RVDM instance. Names help users distinguish among multiple instances, but do not affect RVDM operation.

Parameters:

name - The new name

Throws:

java.io.IOException

setPrimaryUserCredentials

void setPrimaryUserCredentials(java.lang.String currentPassword,
                               java.lang.String newUsername,
                               java.lang.String newPassword)
                               throws java.io.IOException

Sets the credentials of the primary user for this RVDM instance.

Parameters:

currentPassword - The current password associated with the primary user

newUsername - A new username for the primary user. NULL leaves this item unchanged.

newPassword - A new password for the primary user. NULL leaves this item unchanged.

Throws:

java.io.IOException

setSecondaryUserCredentials

void setSecondaryUserCredentials(java.lang.String currentPassword,
                                 java.lang.String newUsername,
                                 java.lang.String newPassword)
                                 throws java.io.IOException

Sets the credentials of the secondary user for this RVDM instance.

Parameters:

currentPassword - The current password associated with the secondary user

newUsername - A new username for the secondary user. NULL leaves this item unchanged.

newPassword - A new password for the secondary user. NULL leaves this item unchanged.

Throws:

java.io.IOException