com.continuent.tungsten.replicator.management
Interface ReplicationServiceManagerMBean

All Known Implementing Classes:

ReplicationServiceManager

public interface ReplicationServiceManagerMBean

Management interface for main replicator control class.

Version:

1.0

Author:

Robert Hodges

Method Summary

DynamicMBeanHelper	createHelper() Returns a helper that supplies MBean metadata.
java.util.Map<java.lang.String,java.lang.String>	getStatus() Returns a map of status properties for all current replicators
boolean	isAlive() Returns true if the MBean is alive.
void	kill() Terminates the replicator process immediately without clean-up.
boolean	loadService(java.lang.String name) Starts a replication service.
java.util.Map<java.lang.String,java.lang.String>	replicatorStatus(java.lang.String name) Returns a list of properties that have the status for each of the current services.
java.util.Map<java.lang.String,java.lang.String>	resetService(java.lang.String name) Resets a replication service.
java.util.Map<java.lang.String,java.lang.String>	resetService(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> controlParams) Resets a replication service or some of its components (thl, relay, database).
java.util.List<java.util.Map<java.lang.String,java.lang.String>>	services() Lists currently defined replicators and whether they are running or not.
java.util.Map<java.lang.String,java.lang.String>	status() Returns status information.
void	stop() Stops all replication services and exits the process cleanly.
boolean	unloadService(java.lang.String name) Stops a replication service.

Method Detail

services

java.util.List<java.util.Map<java.lang.String,java.lang.String>> services()
                                                                          throws java.lang.Exception

Lists currently defined replicators and whether they are running or not.

Throws:

java.lang.Exception

isAlive

boolean isAlive()

Returns true if the MBean is alive. Used to test liveness of connections.

status

java.util.Map<java.lang.String,java.lang.String> status()
                                                        throws java.lang.Exception

Returns status information.

Throws:

java.lang.Exception

loadService

boolean loadService(java.lang.String name)
                    throws java.lang.Exception

Starts a replication service.

Parameters:

name - Name of the replicator service

Returns:

True if replicator service exists and was started

Throws:

java.lang.Exception - Thrown if service start-up fails

unloadService

boolean unloadService(java.lang.String name)
                      throws java.lang.Exception

Stops a replication service.

Parameters:

name - Name of the replicator service

Returns:

True if replicator service exists and was stopped

Throws:

java.lang.Exception - Thrown if service stop fails

resetService

java.util.Map<java.lang.String,java.lang.String> resetService(java.lang.String name)
                                                              throws java.lang.Exception

Resets a replication service.

Parameters:

name - Name of the replicator service

Returns:

Map of strings that indicate actions taken.

Throws:

java.lang.Exception - Thrown if service stop fails

resetService

java.util.Map<java.lang.String,java.lang.String> resetService(java.lang.String name,
                                                              java.util.Map<java.lang.String,java.lang.String> controlParams)
                                                              throws java.lang.Exception

Resets a replication service or some of its components (thl, relay, database).

Parameters:

name - Name of the replicator service

controlParams - 0 or more control parameters expressed as name-value pairs (option={-all|-thl|-relay|-db})

Returns:

Map of strings that indicate actions taken.

Throws:

java.lang.Exception - Thrown if service stop fails

replicatorStatus

java.util.Map<java.lang.String,java.lang.String> replicatorStatus(java.lang.String name)
                                                                  throws java.lang.Exception

Returns a list of properties that have the status for each of the current services.

Throws:

java.lang.Exception

getStatus

java.util.Map<java.lang.String,java.lang.String> getStatus()
                                                           throws java.lang.Exception

Returns a map of status properties for all current replicators

Throws:

java.lang.Exception

stop

void stop()
          throws java.lang.Exception

Stops all replication services and exits the process cleanly.

Throws:

java.lang.Exception - Thrown if service stop fails

kill

void kill()
          throws java.lang.Exception

Terminates the replicator process immediately without clean-up. This command should be used only if stop does not work or for testing.

Throws:

java.lang.Exception

createHelper

DynamicMBeanHelper createHelper()
                                throws java.lang.Exception

Returns a helper that supplies MBean metadata.

Throws:

java.lang.Exception