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.store;
018
019import org.apache.activemq.broker.ConnectionContext;
020import org.apache.activemq.command.Message;
021
022/**
023 * callback when the index is updated, allows ordered work to be seen by destinations
024 */
025public interface IndexListener {
026
027    final class MessageContext {
028        public final Message message;
029        public final ConnectionContext context;
030        public final Runnable onCompletion;
031        public boolean duplicate;
032
033        public MessageContext(ConnectionContext context, Message message, Runnable onCompletion) {
034            this.context = context;
035            this.message = message;
036            this.onCompletion = onCompletion;
037        }
038    }
039
040    /**
041     *  called with some global index lock held so that a listener can do order
042     *  dependent work
043     *  non null MessageContext.onCompletion called when work is done
044     */
045    public void onAdd(MessageContext messageContext);
046
047}