001    // Copyright 2004, 2005 The Apache Software Foundation
002    //
003    // Licensed under the Apache License, Version 2.0 (the "License");
004    // you may not use this file except in compliance with the License.
005    // You may obtain a copy of the License at
006    //
007    //     http://www.apache.org/licenses/LICENSE-2.0
008    //
009    // Unless required by applicable law or agreed to in writing, software
010    // distributed under the License is distributed on an "AS IS" BASIS,
011    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012    // See the License for the specific language governing permissions and
013    // limitations under the License.
014    
015    package org.apache.hivemind.service;
016    
017    /**
018     * Service which acts as a dispatch hub for events about the lifecycle of
019     * the current thread.
020     *
021     * @author Howard Lewis Ship
022     */
023    public interface ThreadEventNotifier
024    {
025        /**
026         * Adds the listener.
027         */
028        public void addThreadCleanupListener(ThreadCleanupListener listener);
029    
030        /**
031         * Removes the listener, if it has been previously added.  If the listener
032         * has been added multiple times, only one instance is removed.
033         */
034        public void removeThreadCleanupListener(ThreadCleanupListener listener);
035    
036        /**
037         * Invokes {@link ThreadCleanupListener#threadDidCleanup()} on all
038         * listeners.
039         */
040        public void fireThreadCleanup();
041    }