camel-2.8.x/components/camel-jms/src/main/java/org/apache/camel/component/jms/reply/CorrelationListener.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.camel.component.jms.reply;

/**
 * Listener for events when correlation id's changes.
 */
public interface CorrelationListener {

    /**
     * Callback when a new correlation id is added
     *
     * @param key the correlation id
     */
    void onPut(String key);

    /**
     * Callback when a correlation id is removed
     *
     * @param key the correlation id
     */
    void onRemove(String key);

    /**
     * Callback when a correlation id is evicted due timeout
     *
     * @param key the correlation id
     */
    void onEviction(String key);
}