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.camel.util;
018    
019    /**
020     * Represents a thread safe map of values which timeout after a period of
021     * inactivity.
022     *
023     * @version $Revision: 37863 $
024     */
025    public interface TimeoutMap extends Runnable {
026    
027        /**
028         * Looks up the value in the map by the given key.
029         *
030         * @param key
031         *            the key of the value to search for
032         * @return the value for the given key or null if it is not present (or has
033         *         timed out)
034         */
035        Object get(Object key);
036    
037        /**
038         * Returns a copy of the keys in the map
039         */
040        Object[] getKeys();
041    
042        int size();
043        /**
044         * Adds the key value pair into the map such that some time after the given
045         * timeout the entry will be evicted
046         */
047        void put(Object key, Object value, long timeoutMillis);
048    
049        void remove(Object key);
050    
051        /**
052         * Purges any old entries from the map
053         */
054        void purge();
055    }