com.jamonapi.aop.spring

Class JamonAopKeyHelper

java.lang.Object

com.jamonapi.aop.spring.JamonAopKeyHelper

All Implemented Interfaces:

JamonAopKeyHelperInt<org.aspectj.lang.ProceedingJoinPoint>

@Component
public class JamonAopKeyHelper
extends Object
implements JamonAopKeyHelperInt<org.aspectj.lang.ProceedingJoinPoint>

Class that monitors helps create keys, details, arguments and exceptions for jamon aop. With agument tracking If a method was invoked as 'myObject.myMethod("jeff", "beck"); the arguments jeff, beck would be accessible in the jamonListener via jamon details for the method (setUseArgsWithMethodDetails) or the exception (setUseArgsWithExceptionDetails).

Constructor Summary

Constructors

Constructor and Description
JamonAopKeyHelper()
JamonAopKeyHelper(boolean useArgsWithMethodDetails, boolean useArgsWithExceptionDetails)

Method Summary

Modifier and Type	Method and Description
String	getDetails(org.aspectj.lang.ProceedingJoinPoint proceedingJoinPoint) Create details for the invoked method.
String	getDetails(org.aspectj.lang.ProceedingJoinPoint proceedingJoinPoint, Throwable exception) Create details for when an exception is thrown.
String	getExceptionLabel(Throwable exception) Create a label out of the passed in exception.
String	getLabel(org.aspectj.lang.ProceedingJoinPoint proceedingJoinPoint) Uses a jamon label as a method name.
void	setUseArgsWithExceptionDetails(boolean useArgsWithExceptionDetails) Track arguments for all exceptions thrown.
void	setUseArgsWithMethodDetails(boolean useArgsWithMethodDetails) Track arguments for all methods monitored.

Methods inherited from class java.lang.Object

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

Constructor Detail

JamonAopKeyHelper

public JamonAopKeyHelper()

JamonAopKeyHelper

public JamonAopKeyHelper(boolean useArgsWithMethodDetails,
                         boolean useArgsWithExceptionDetails)

Method Detail

setUseArgsWithMethodDetails

public void setUseArgsWithMethodDetails(boolean useArgsWithMethodDetails)

Track arguments for all methods monitored. By default this is disabled.

Specified by:

setUseArgsWithMethodDetails in interface JamonAopKeyHelperInt<org.aspectj.lang.ProceedingJoinPoint>

Parameters:

useArgsWithMethodDetails -

setUseArgsWithExceptionDetails

public void setUseArgsWithExceptionDetails(boolean useArgsWithExceptionDetails)

Track arguments for all exceptions thrown. By default this is disabled.

Specified by:

setUseArgsWithExceptionDetails in interface JamonAopKeyHelperInt<org.aspectj.lang.ProceedingJoinPoint>

Parameters:

useArgsWithExceptionDetails -

getLabel

public String getLabel(org.aspectj.lang.ProceedingJoinPoint proceedingJoinPoint)

Uses a jamon label as a method name. Example: void com.stevesouza.spring.MonitorMe3.myMethod2(String)

Specified by:

getLabel in interface JamonAopKeyHelperInt<org.aspectj.lang.ProceedingJoinPoint>

Parameters:

proceedingJoinPoint -

Returns:

getExceptionLabel

public String getExceptionLabel(Throwable exception)

Create a label out of the passed in exception. It will be the exception class name. Example: java.io.IOException

Specified by:

getExceptionLabel in interface JamonAopKeyHelperInt<org.aspectj.lang.ProceedingJoinPoint>

Parameters:

exception -

Returns:

getDetails

public String getDetails(org.aspectj.lang.ProceedingJoinPoint proceedingJoinPoint)

Create details for the invoked method. This is used in jamon listeners (for example viewable in the jamon web app). If the useArgsWithMethodDetails boolean has been set then the param values will also be viewable for the invoked method.

Specified by:

getDetails in interface JamonAopKeyHelperInt<org.aspectj.lang.ProceedingJoinPoint>

Parameters:

proceedingJoinPoint -

Returns:

getDetails

public String getDetails(org.aspectj.lang.ProceedingJoinPoint proceedingJoinPoint,
                         Throwable exception)

Create details for when an exception is thrown. This would be the stack trace and possibly the methods arguments if useArgsWithExceptionDetails has been set.

Specified by:

getDetails in interface JamonAopKeyHelperInt<org.aspectj.lang.ProceedingJoinPoint>

Parameters:

proceedingJoinPoint -

exception -

Returns: