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     */
017    package org.apache.activemq.broker.region.group;
018    
019    import java.util.Map;
020    
021    import org.apache.activemq.command.ConsumerId;
022    
023    /**
024     * Represents a map of JMSXGroupID values to consumer IDs
025     * 
026     * 
027     */
028    public interface MessageGroupMap {
029    
030        void put(String groupId, ConsumerId consumerId);
031    
032        ConsumerId get(String groupId);
033    
034        ConsumerId removeGroup(String groupId);
035    
036        MessageGroupSet removeConsumer(ConsumerId consumerId);
037    
038        void removeAll();
039    
040        /**
041         * @return  a map of group names and associated consumer Id
042         */
043        Map<String,String> getGroups();
044    
045        String getType();
046    
047    }