001    package org.apache.fulcrum.yaafi.framework.interceptor;
002    
003    /*
004     * Licensed to the Apache Software Foundation (ASF) under one
005     * or more contributor license agreements.  See the NOTICE file
006     * distributed with this work for additional information
007     * regarding copyright ownership.  The ASF licenses this file
008     * to you under the Apache License, Version 2.0 (the
009     * "License"); you may not use this file except in compliance
010     * with the License.  You may obtain a copy of the License at
011     *
012     *   http://www.apache.org/licenses/LICENSE-2.0
013     *
014     * Unless required by applicable law or agreed to in writing,
015     * software distributed under the License is distributed on an
016     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017     * KIND, either express or implied.  See the License for the
018     * specific language governing permissions and limitations
019     * under the License.
020     */
021    
022    
023    /**
024     * Defining the common interface of all interceptors.
025     *
026     * @author <a href="mailto:siegfried.goeschl@it20one.at">Siegfried Goeschl</a>
027     */
028    
029    public interface AvalonInterceptorService
030    {
031        /** indicating entering a service method */
032        int ON_ENTRY = 0;
033    
034        /** indicating exiting a service method without throwing an exception */
035        int ON_EXIT = 1;
036    
037        /** indicating exiting a service method throwing an exception */
038        int ON_ERROR = 2;
039    
040        /**
041         * Called before a service method is invoked.
042         *
043         * @param avalonInterceptorContext shared interceptor context
044         */
045        void onEntry( AvalonInterceptorContext avalonInterceptorContext );
046    
047        /**
048         * Called after a service method was invoked.
049         *
050         * @param avalonInterceptorContext shared interceptor context
051         * @param result the result of the invocation
052         */
053        void onExit( AvalonInterceptorContext avalonInterceptorContext, Object result );
054    
055        /**
056         * Called when a service method throws an exeption
057         *
058         * @param avalonInterceptorContext shared interceptor context
059         * @param t the resulting exception
060         */
061        void onError( AvalonInterceptorContext avalonInterceptorContext, Throwable t);
062    }