Package org.apache.activemq.artemis.api.core.management

Interface BaseBroadcastGroupControl

All Superinterfaces:

ActiveMQComponentControl

All Known Subinterfaces:

BroadcastGroupControl, JGroupsChannelBroadcastGroupControl, JGroupsFileBroadcastGroupControl

public interface BaseBroadcastGroupControl
extends ActiveMQComponentControl

A BroadcastGroupControl is used to manage a broadcast group.

Method Summary

Modifier and Type	Method	Description
long	getBroadcastPeriod()	Returns the period used by this broadcast group.
Object[]	getConnectorPairs()	Returns the pairs of live-backup connectors that are broadcasted by this broadcast group.
String	getConnectorPairsAsJSON()	Returns the pairs of live-backup connectors that are broadcasted by this broadcast group.
String	getName()	Returns the configuration name of this broadcast group.

Methods inherited from interface org.apache.activemq.artemis.api.core.management.ActiveMQComponentControl

isStarted, start, stop

Method Details

getName

String getName()

Returns the configuration name of this broadcast group.

Returns:

the configuration name of this broadcast group

getBroadcastPeriod

long getBroadcastPeriod()

Returns the period used by this broadcast group.

Returns:

the period used by this broadcast group

getConnectorPairs

Object[] getConnectorPairs()

Returns the pairs of live-backup connectors that are broadcasted by this broadcast group.

Returns:

the pairs of live-backup connectors that are broadcasted by this broadcast group

getConnectorPairsAsJSON

String getConnectorPairsAsJSON()
                        throws Exception

Returns the pairs of live-backup connectors that are broadcasted by this broadcast group. using JSON serialization.

Returns:

the pairs of live-backup connectors that are broadcasted by this broadcast group

Throws:

Exception