View Javadoc
1   package org.apache.fulcrum.yaafi.framework.interceptor;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  
23  /**
24   * Defining the common interface of all interceptors.
25   *
26   * @author <a href="mailto:siegfried.goeschl@it20one.at">Siegfried Goeschl</a>
27   */
28  
29  public interface AvalonInterceptorService
30  {
31      /** indicating entering a service method */
32      int ON_ENTRY = 0;
33  
34      /** indicating exiting a service method without throwing an exception */
35      int ON_EXIT = 1;
36  
37      /** indicating exiting a service method throwing an exception */
38      int ON_ERROR = 2;
39  
40      /**
41       * Called before a service method is invoked.
42       *
43       * @param avalonInterceptorContext shared interceptor context
44       */
45      void onEntry( AvalonInterceptorContext avalonInterceptorContext );
46  
47      /**
48       * Called after a service method was invoked.
49       *
50       * @param avalonInterceptorContext shared interceptor context
51       * @param result the result of the invocation
52       */
53      void onExit( AvalonInterceptorContext avalonInterceptorContext, Object result );
54  
55      /**
56       * Called when a service method throws an exeption
57       *
58       * @param avalonInterceptorContext shared interceptor context
59       * @param t the resulting exception
60       */
61      void onError( AvalonInterceptorContext avalonInterceptorContext, Throwable t);
62  }