001/*
002 * Copyright 2009 Red Hat, Inc.
003 * Red Hat licenses this file to you under the Apache License, version
004 * 2.0 (the "License"); you may not use this file except in compliance
005 * with the License.  You may obtain a copy of the License at
006 *    http://www.apache.org/licenses/LICENSE-2.0
007 * Unless required by applicable law or agreed to in writing, software
008 * distributed under the License is distributed on an "AS IS" BASIS,
009 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
010 * implied.  See the License for the specific language governing
011 * permissions and limitations under the License.
012 */
013
014package org.hornetq.api.core.management;
015
016/**
017 * A BroadcastGroupControl is used to manage a broadcast group.
018 *
019 * @author <a href="jmesnil@redhat.com">Jeff Mesnil</a>
020 *
021 */
022public interface BroadcastGroupControl extends HornetQComponentControl
023{
024   /**
025    * Returns the configuration name of this broadcast group.
026    */
027   String getName();
028
029   /**
030    * Returns the local port this broadcast group is bound to.
031    */
032   int getLocalBindPort();
033
034   /**
035    * Returns the address this broadcast group is broadcasting to.
036    */
037   String getGroupAddress();
038
039   /**
040    * Returns the port this broadcast group is broadcasting to.
041    */
042   int getGroupPort();
043
044   /**
045    * Returns the period used by this broadcast group.
046    */
047   long getBroadcastPeriod();
048
049   /**
050    * Returns the pairs of live-backup connectors that are broadcasted by this broadcast group.
051    */
052   Object[] getConnectorPairs();
053
054   /**
055    * Returns the pairs of live-backup connectors that are broadcasted by this broadcast group
056    * using JSON serialization.
057    */
058   String getConnectorPairsAsJSON() throws Exception;
059}