org.jboss.ha.singleton
Interface HASingletonControllerMBean

All Superinterfaces:

HAServiceMBean, HASingletonMBean, javax.management.NotificationBroadcaster, org.jboss.system.Service, org.jboss.system.ServiceMBean

All Known Implementing Classes:

HASingletonController

public interface HASingletonControllerMBean
extends HASingletonMBean

The namangement interface for the singleton controller service.

Version:

$Revision: 1.3 $

Author:

Ivelin Ivanov, Scott.Stark@jboss.org, Marcus Redeker

See Also:

HASingletonMBean

Field Summary

Fields inherited from interface org.jboss.system.ServiceMBean

CREATE_EVENT, CREATED, DESTROY_EVENT, DESTROYED, FAILED, REGISTERED, START_EVENT, STARTED, STARTING, states, STOP_EVENT, STOPPED, STOPPING, UNREGISTERED

Method Summary

javax.management.ObjectName	getTargetName()
String	getTargetStartMethod()
String	getTargetStartMethodArgument()
String	getTargetStopMethod()
String	getTargetStopMethodArgument()
void	setTargetName(javax.management.ObjectName targetObjectName) Sets the fully qualified JMX MBean Object Name of the Schedulable MBean to be called.
void	setTargetStartMethod(String targetStartMethod) Sets the start method name to be called on the Singleton MBean.
void	setTargetStartMethodArgument(String targetStartMethodArgument) Sets the argument to be passed to the start method of the Singleton MBean.
void	setTargetStopMethod(String targetStopMethod) Sets the stop method name to be called on the Singleton MBean.
void	setTargetStopMethodArgument(String targetStopMethodArgument) Sets the argument to be passed to the stop method of the Singleton MBean.

Methods inherited from interface org.jboss.ha.singleton.HASingletonMBean

isMasterNode

Methods inherited from interface org.jboss.ha.jmx.HAServiceMBean

callMethodOnPartition, getDistributedState, getPartitionName, sendNotification, setDistributedState, setPartitionName

Methods inherited from interface org.jboss.system.ServiceMBean

getName, getState, getStateString, jbossInternalLifecycle

Methods inherited from interface org.jboss.system.Service

create, destroy, start, stop

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Method Detail

getTargetName

javax.management.ObjectName getTargetName()

Returns:

Object Name of the Target MBean for the timer notifications

setTargetName

void setTargetName(javax.management.ObjectName targetObjectName)

Sets the fully qualified JMX MBean Object Name of the Schedulable MBean to be called.

Parameters:

pTargetObjectName - JMX MBean Object Name which should be called.

Throws:

InvalidParameterException - If the given value is an valid Object Name.

getTargetStartMethod

String getTargetStartMethod()

Returns:

start method description of the target MBean to be called

setTargetStartMethod

void setTargetStartMethod(String targetStartMethod)

Sets the start method name to be called on the Singleton MBean.

Parameters:

pTargetStartMethod - Name of the start method to be called

Throws:

InvalidParameterException - If the given value is not of the right format

getTargetStartMethodArgument

String getTargetStartMethodArgument()

Returns:

start method argument of the target MBean to be called

setTargetStartMethodArgument

void setTargetStartMethodArgument(String targetStartMethodArgument)

Sets the argument to be passed to the start method of the Singleton MBean.

Parameters:

pTargetStartMethodArgument - Argument value to be passed to the start method

Throws:

InvalidParameterException - If the given value is not of the right format

getTargetStopMethod

String getTargetStopMethod()

Returns:

stop method description of the target MBean to be called

setTargetStopMethod

void setTargetStopMethod(String targetStopMethod)

Sets the stop method name to be called on the Singleton MBean.

Parameters:

pTargetStopMethod - Name of the stop method to be called

getTargetStopMethodArgument

String getTargetStopMethodArgument()

Returns:

stop method argument of the target MBean to be called

setTargetStopMethodArgument

void setTargetStopMethodArgument(String targetStopMethodArgument)

Sets the argument to be passed to the stop method of the Singleton MBean.

Parameters:

pTargetStartMethodArgument - Argument value to be passed to the stop method