001    // Copyright 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.tapestry.listener;
016    
017    import org.apache.tapestry.IActionListener;
018    import org.apache.tapestry.IComponent;
019    import org.apache.tapestry.IRequestCycle;
020    
021    /**
022     * Filter interface used with
023     * {@link org.apache.tapestry.listener.ListenerInvoker}. Implementations of
024     * this filter interface may be plugged into the listener method invocation
025     * pipeline. Typical applications involve handling transactions.
026     * 
027     * @author Howard M. Lewis Ship
028     * @since 4.0
029     */
030    public interface ListenerInvokerFilter
031    {
032    
033        /**
034         * Invoked when a particular listener is being called.
035         *
036         * @param listener The listener reference being invoked.
037         * @param source The component the listener is being invoked on.
038         * @param cycle The associated request.
039         * @param delegate The delegate responsible for actually invoking the method.
040         */
041        void invokeListener(IActionListener listener, IComponent source, IRequestCycle cycle, ListenerInvoker delegate);
042    }