/hudson-core/src/main/java/hudson/util/InvocationInterceptor.java

http://github.com/hudson/hudson · Java · 57 lines · 6 code · 2 blank · 49 comment · 0 complexity · e018646136c52625fe3fdd4e5a8d2669 MD5 · raw file

  1. /*
  2. * The MIT License
  3. *
  4. * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
  5. *
  6. * Permission is hereby granted, free of charge, to any person obtaining a copy
  7. * of this software and associated documentation files (the "Software"), to deal
  8. * in the Software without restriction, including without limitation the rights
  9. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10. * copies of the Software, and to permit persons to whom the Software is
  11. * furnished to do so, subject to the following conditions:
  12. *
  13. * The above copyright notice and this permission notice shall be included in
  14. * all copies or substantial portions of the Software.
  15. *
  16. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22. * THE SOFTWARE.
  23. */
  24. package hudson.util;
  25. import java.lang.reflect.Method;
  26. import java.lang.reflect.InvocationHandler;
  27. /**
  28. * Interceptor around {@link InvocationHandler}.
  29. *
  30. * @author Kohsuke Kawaguchi
  31. * @since 1.232
  32. */
  33. public interface InvocationInterceptor {
  34. /**
  35. * This method can intercept the invocation of {@link InvocationHandler} either before or after
  36. * the invocation happens.
  37. *
  38. * <p>
  39. * The general coding pattern is:
  40. *
  41. * <pre>
  42. * Object invoke(Object proxy, Method method, Object[] args, InvocationHandler delegate) {
  43. * ... do pre-invocation work ...
  44. * ret = delegate.invoke(proxy,method,args);
  45. * ... do post-invocation work ...
  46. * return ret;
  47. * }
  48. * </pre>
  49. *
  50. * <p>
  51. * But the implementation may choose to skip calling the 'delegate' object, alter arguments,
  52. * and alter the return value.
  53. */
  54. public Object invoke(Object proxy, Method method, Object[] args, InvocationHandler delegate) throws Throwable;
  55. }