001/**
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.activemq.broker.region.group;
018
019import java.util.Map;
020
021import org.apache.activemq.broker.region.Destination;
022import org.apache.activemq.command.ConsumerId;
023
024/**
025 * Represents a map of JMSXGroupID values to consumer IDs
026 * 
027 * 
028 */
029public interface MessageGroupMap {
030
031    void put(String groupId, ConsumerId consumerId);
032
033    ConsumerId get(String groupId);
034
035    ConsumerId removeGroup(String groupId);
036
037    MessageGroupSet removeConsumer(ConsumerId consumerId);
038
039    void removeAll();
040
041    /**
042     * @return  a map of group names and associated consumer Id
043     */
044    Map<String,String> getGroups();
045
046    String getType();
047
048    void setDestination(Destination destination);
049
050}