java.lang.Object
- org.springframework.aop.interceptor.AbstractTraceInterceptor
- - org.springframework.aop.interceptor.CustomizableTraceInterceptor

All Implemented Interfaces:
Serializable, Advice, Interceptor, MethodInterceptor
```
public class CustomizableTraceInterceptor
extends AbstractTraceInterceptor
```
MethodInterceptor implementation that allows for highly customizable method-level tracing, using placeholders.
Trace messages are written on method entry, and if the method invocation succeeds on method exit. If an invocation results in an exception, then an exception message is written. The contents of these trace messages is fully customizable and special placeholders are available to allow you to include runtime information in your log messages. The placeholders available are:
- $[methodName] - replaced with the name of the method being invoked
- $[targetClassName] - replaced with the name of the class that is the target of the invocation
- $[targetClassShortName] - replaced with the short name of the class that is the target of the invocation
- $[returnValue] - replaced with the value returned by the invocation
- $[argumentTypes] - replaced with a comma-separated list of the short class names of the method arguments
- $[arguments] - replaced with a comma-separated list of the String representation of the method arguments
- $[exception] - replaced with the String representation of any Throwable raised during the invocation
- $[invocationTime] - replaced with the time, in milliseconds, taken by the method invocation
There are restrictions on which placeholders can be used in which messages: see the individual message properties for details on the valid placeholders.
Since:
1.2
Author:
Rob Harrop, Juergen Hoeller
See Also:
setEnterMessage(java.lang.String), setExitMessage(java.lang.String), setExceptionMessage(java.lang.String), SimpleTraceInterceptor, Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`PLACEHOLDER_ARGUMENT_TYPES`	The `$[argumentTypes]` placeholder.
`static String`	`PLACEHOLDER_ARGUMENTS`	The `$[arguments]` placeholder.
`static String`	`PLACEHOLDER_EXCEPTION`	The `$[exception]` placeholder.
`static String`	`PLACEHOLDER_INVOCATION_TIME`	The `$[invocationTime]` placeholder.
`static String`	`PLACEHOLDER_METHOD_NAME`	The `$[methodName]` placeholder.
`static String`	`PLACEHOLDER_RETURN_VALUE`	The `$[returnValue]` placeholder.
`static String`	`PLACEHOLDER_TARGET_CLASS_NAME`	The `$[targetClassName]` placeholder.
`static String`	`PLACEHOLDER_TARGET_CLASS_SHORT_NAME`	The `$[targetClassShortName]` placeholder.

Fields inherited from class org.springframework.aop.interceptor.AbstractTraceInterceptor
defaultLogger

Constructor Summary
Constructors
Constructor Description
CustomizableTraceInterceptor()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected Object`	`invokeUnderTrace(MethodInvocation invocation, Log logger)`	Writes a log message before the invocation based on the value of `enterMessage`.
`protected String`	`replacePlaceholders(String message, MethodInvocation methodInvocation, Object returnValue, Throwable throwable, long invocationTime)`	Replace the placeholders in the given message with the supplied values, or values derived from those supplied.
`void`	`setEnterMessage(String enterMessage)`	Set the template used for method entry log messages.
`void`	`setExceptionMessage(String exceptionMessage)`	Set the template used for method exception log messages.
`void`	`setExitMessage(String exitMessage)`	Set the template used for method exit log messages.

Methods inherited from class org.springframework.aop.interceptor.AbstractTraceInterceptor
getClassForLogging, getLoggerForInvocation, invoke, isInterceptorEnabled, isLogEnabled, setHideProxyClassNames, setLogExceptionStackTrace, setLoggerName, setUseDynamicLogger, writeToLog, writeToLog

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PLACEHOLDER_METHOD_NAME
```
public static final String PLACEHOLDER_METHOD_NAME
```
    The $[methodName] placeholder. Replaced with the name of the method being invoked.
    See Also:
    Constant Field Values
  - PLACEHOLDER_TARGET_CLASS_NAME
```
public static final String PLACEHOLDER_TARGET_CLASS_NAME
```
    The $[targetClassName] placeholder. Replaced with the fully-qualifed name of the Class of the method invocation target.
    See Also:
    Constant Field Values
  - PLACEHOLDER_TARGET_CLASS_SHORT_NAME
```
public static final String PLACEHOLDER_TARGET_CLASS_SHORT_NAME
```
    The $[targetClassShortName] placeholder. Replaced with the short name of the Class of the method invocation target.
    See Also:
    Constant Field Values
  - PLACEHOLDER_RETURN_VALUE
```
public static final String PLACEHOLDER_RETURN_VALUE
```
    The $[returnValue] placeholder. Replaced with the String representation of the value returned by the method invocation.
    See Also:
    Constant Field Values
  - PLACEHOLDER_ARGUMENT_TYPES
```
public static final String PLACEHOLDER_ARGUMENT_TYPES
```
    The $[argumentTypes] placeholder. Replaced with a comma-separated list of the argument types for the method invocation. Argument types are written as short class names.
    See Also:
    Constant Field Values
  - PLACEHOLDER_ARGUMENTS
```
public static final String PLACEHOLDER_ARGUMENTS
```
    The $[arguments] placeholder. Replaced with a comma separated list of the argument values for the method invocation. Relies on the toString() method of each argument type.
    See Also:
    Constant Field Values
  - PLACEHOLDER_EXCEPTION
```
public static final String PLACEHOLDER_EXCEPTION
```
    The $[exception] placeholder. Replaced with the String representation of any Throwable raised during method invocation.
    See Also:
    Constant Field Values
  - PLACEHOLDER_INVOCATION_TIME
```
public static final String PLACEHOLDER_INVOCATION_TIME
```
    The $[invocationTime] placeholder. Replaced with the time taken by the invocation (in milliseconds).
    See Also:
    Constant Field Values
- Constructor Detail
  - CustomizableTraceInterceptor
```
public CustomizableTraceInterceptor()
```
- Method Detail
  - setEnterMessage
```
public void setEnterMessage(String enterMessage)
                     throws IllegalArgumentException
```
    Set the template used for method entry log messages. This template can contain any of the following placeholders:
    $[targetClassName]
    $[targetClassShortName]
    $[argumentTypes]
    $[arguments]
    Throws:
    IllegalArgumentException
  - setExitMessage
```
public void setExitMessage(String exitMessage)
```
    Set the template used for method exit log messages. This template can contain any of the following placeholders:
    $[targetClassName]
    $[targetClassShortName]
    $[argumentTypes]
    $[arguments]
    $[returnValue]
    $[invocationTime]
  - setExceptionMessage
```
public void setExceptionMessage(String exceptionMessage)
```
    Set the template used for method exception log messages. This template can contain any of the following placeholders:
    $[targetClassName]
    $[targetClassShortName]
    $[argumentTypes]
    $[arguments]
    $[exception]
  - invokeUnderTrace
```
protected Object invokeUnderTrace(MethodInvocation invocation,
                                  Log logger)
                           throws Throwable
```
    Writes a log message before the invocation based on the value of enterMessage. If the invocation succeeds, then a log message is written on exit based on the value exitMessage. If an exception occurs during invocation, then a message is written based on the value of exceptionMessage.
    Specified by:
    invokeUnderTrace in class AbstractTraceInterceptor
    logger - the Log to write trace messages to
    Returns:
    the result of the call to MethodInvocation.proceed()
    Throws:
    Throwable - if the call to MethodInvocation.proceed() encountered any errors
    See Also:
    setEnterMessage(java.lang.String), setExitMessage(java.lang.String), setExceptionMessage(java.lang.String)
  - replacePlaceholders
```
protected String replacePlaceholders(String message,
                                     MethodInvocation methodInvocation,
                                     Object returnValue,
                                     Throwable throwable,
                                     long invocationTime)
```
    Replace the placeholders in the given message with the supplied values, or values derived from those supplied.
    Parameters:
    message - the message template containing the placeholders to be replaced
    methodInvocation - the MethodInvocation being logged. Used to derive values for all placeholders except $[exception] and $[returnValue].
    returnValue - any value returned by the invocation. Used to replace the $[returnValue] placeholder. May be null.
    throwable - any Throwable raised during the invocation. The value of Throwable.toString() is replaced for the $[exception] placeholder. May be null.
    invocationTime - the value to write in place of the $[invocationTime] placeholder
    Returns:
    the formatted output to write to the log

Class CustomizableTraceInterceptor

Field Summary

Fields inherited from class org.springframework.aop.interceptor.AbstractTraceInterceptor

Constructor Summary

Method Summary

Methods inherited from class org.springframework.aop.interceptor.AbstractTraceInterceptor

Methods inherited from class java.lang.Object

Field Detail

PLACEHOLDER_METHOD_NAME

PLACEHOLDER_TARGET_CLASS_NAME

PLACEHOLDER_TARGET_CLASS_SHORT_NAME

PLACEHOLDER_RETURN_VALUE

PLACEHOLDER_ARGUMENT_TYPES

PLACEHOLDER_ARGUMENTS

PLACEHOLDER_EXCEPTION

PLACEHOLDER_INVOCATION_TIME

Constructor Detail

CustomizableTraceInterceptor

Method Detail

setEnterMessage

setExitMessage

setExceptionMessage

invokeUnderTrace

replacePlaceholders