com.liferay.portal.kernel.aop

Class ChainableMethodAdvice

Object

com.liferay.portal.kernel.aop.ChainableMethodAdvice

public abstract class ChainableMethodAdvice
extends Object

Provides method advice to implement an aspect for services.

Author:

Shuyang Zhou, Brian Wing Shun Chan

Field Summary

Fields

Modifier and Type	Field and Description
protected static Object	nullResult

Constructor Summary

Constructors

Constructor and Description
ChainableMethodAdvice()

Method Summary

Modifier and Type	Method and Description
protected void	afterReturning(AopMethodInvocation aopMethodInvocation, Object[] arguments, Object result)
protected void	afterThrowing(AopMethodInvocation aopMethodInvocation, Object[] arguments, Throwable throwable)
protected Object	before(AopMethodInvocation aopMethodInvocation, Object[] arguments)
abstract Object	createMethodContext(Class<?> targetClass, Method method, Map<Class<? extends Annotation>,Annotation> annotations) Creates the context to be used when invoking this advice.
protected void	duringFinally(AopMethodInvocation aopMethodInvocation, Object[] arguments)
Object	invoke(AopMethodInvocation aopMethodInvocation, Object[] arguments)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

nullResult

protected static Object nullResult

Constructor Detail

ChainableMethodAdvice

public ChainableMethodAdvice()

Method Detail

createMethodContext

public abstract Object createMethodContext(Class<?> targetClass,
                                           Method method,
                                           Map<Class<? extends Annotation>,Annotation> annotations)

Creates the context to be used when invoking this advice. The context can be useful for caching information derived from reflective calls on the method. Returning null disables this advice for all invocations on the target class and method. The context object can be obtained by calling AopMethodInvocation.getAdviceMethodContext(). The context should be immutable as it is reused by concurrent calls to invoke(AopMethodInvocation, Object[]).

Parameters:

targetClass - the target class for the context

method - the method for the context

annotations - a map of the method's annotations

Returns:

the context object for use during method invocations or null to disable this advice for the method

invoke

public Object invoke(AopMethodInvocation aopMethodInvocation,
                     Object[] arguments)
              throws Throwable

Throws:

Throwable

afterReturning

protected void afterReturning(AopMethodInvocation aopMethodInvocation,
                              Object[] arguments,
                              Object result)
                       throws Throwable

Throws:

Throwable

afterThrowing

protected void afterThrowing(AopMethodInvocation aopMethodInvocation,
                             Object[] arguments,
                             Throwable throwable)
                      throws Throwable

Throws:

Throwable

before

protected Object before(AopMethodInvocation aopMethodInvocation,
                        Object[] arguments)
                 throws Throwable

Throws:

Throwable

duringFinally

protected void duringFinally(AopMethodInvocation aopMethodInvocation,
                             Object[] arguments)