InvocationHandler used for proxying Jakarta MessageConsumer.

Each invocation to a setMessageListener method is intercepted and the given MessageListener is wrapped to create a dedicated observation. This instrumentation also creates an Observation.Scope to propagate the observation context in the listener callback.

Modifier and Type	Class and Description
pack-priv static class	MessageConsumerInvocationHandler.ObservedMessageListener

Modifier and Type	Field and Description
private static final JmsProcessObservationConvention	DEFAULT_CONVENTION
private final ObservationRegistry	registry
private final MessageConsumer	target

Access	Constructor and Description
pack-priv	MessageConsumerInvocationHandler(MessageConsumer target, ObservationRegistry registry)

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public Object	invoke(Object the proxy instance that the method was invoked on proxy, Method the `Method` instance corresponding to the interface method invoked on the proxy instance. The declaring class of the `Method` object will be the interface that the method was declared in, which may be a superinterface of the proxy interface that the proxy class inherits the method through. method, Object[] an array of objects containing the values of the arguments passed in the method invocation on the proxy instance, or `null` if interface method takes no arguments. Arguments of primitive types are wrapped in instances of the appropriate primitive wrapper class, such as `java.lang.Integer` or `java.lang.Boolean`. args) Implements java.lang.reflect.InvocationHandler.invoke. Processes a method invocation on a proxy instance and returns the result.

public Object

invoke(Object

the proxy instance that the method was invoked on

proxy, Method

the Method instance corresponding to the interface method invoked on the proxy instance. The declaring class of the Method object will be the interface that the method was declared in, which may be a superinterface of the proxy interface that the proxy class inherits the method through.

method, Object[]

an array of objects containing the values of the arguments passed in the method invocation on the proxy instance, or null if interface method takes no arguments. Arguments of primitive types are wrapped in instances of the appropriate primitive wrapper class, such as java.lang.Integer or java.lang.Boolean.

args)

Implements java.lang.reflect.InvocationHandler.invoke.

Processes a method invocation on a proxy instance and returns the result.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DEFAULT_CONVENTION	back to summary
private static final JmsProcessObservationConvention DEFAULT_CONVENTION

registry	back to summary
private final ObservationRegistry registry

target	back to summary
private final MessageConsumer target

Constructor Detail

MessageConsumerInvocationHandler	back to summary
pack-priv MessageConsumerInvocationHandler(MessageConsumer target, ObservationRegistry registry)

Method Detail

invoke back to summary

invoke	back to summary
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable Implements java.lang.reflect.InvocationHandler.invoke. Doc from java.lang.reflect.InvocationHandler.invoke. Processes a method invocation on a proxy instance and returns the result. This method will be invoked on an invocation handler when a method is invoked on a proxy instance that it is associated with. Parameters proxy:Object the proxy instance that the method was invoked on method:Method the `Method` instance corresponding to the interface method invoked on the proxy instance. The declaring class of the `Method` object will be the interface that the method was declared in, which may be a superinterface of the proxy interface that the proxy class inherits the method through. args:Object[] an array of objects containing the values of the arguments passed in the method invocation on the proxy instance, or `null` if interface method takes no arguments. Arguments of primitive types are wrapped in instances of the appropriate primitive wrapper class, such as `java.lang.Integer` or `java.lang.Boolean`. Returns:Object the value to return from the method invocation on the proxy instance. If the declared return type of the interface method is a primitive type, then the value returned by this method must be an instance of the corresponding primitive wrapper class; otherwise, it must be a type assignable to the declared return type. If the value returned by this method is `null` and the interface method's return type is primitive, then a `NullPointerException` will be thrown by the method invocation on the proxy instance. If the value returned by this method is otherwise not compatible with the interface method's declared return type as described above, a `ClassCastException` will be thrown by the method invocation on the proxy instance. Annotations @Override Exceptions Throwable: the exception to throw from the method invocation on the proxy instance. The exception's type must be assignable either to any of the exception types declared in the `throws` clause of the interface method or to the unchecked exception types `java.lang.RuntimeException` or `java.lang.Error`. If a checked exception is thrown by this method that is not assignable to any of the exception types declared in the `throws` clause of the interface method, then an `UndeclaredThrowableException` containing the exception that was thrown by this method will be thrown by the method invocation on the proxy instance.

public Object invoke(Object proxy, Method method, Object[] args) throws Throwable

Implements java.lang.reflect.InvocationHandler.invoke.

Doc from java.lang.reflect.InvocationHandler.invoke.

Processes a method invocation on a proxy instance and returns the result. This method will be invoked on an invocation handler when a method is invoked on a proxy instance that it is associated with.

Parameters

proxy:Object: the proxy instance that the method was invoked on
method:Method: the Method instance corresponding to the interface method invoked on the proxy instance. The declaring class of the Method object will be the interface that the method was declared in, which may be a superinterface of the proxy interface that the proxy class inherits the method through.
args:Object[]: an array of objects containing the values of the arguments passed in the method invocation on the proxy instance, or null if interface method takes no arguments. Arguments of primitive types are wrapped in instances of the appropriate primitive wrapper class, such as java.lang.Integer or java.lang.Boolean.

Returns:Object

the value to return from the method invocation on the proxy instance. If the declared return type of the interface method is a primitive type, then the value returned by this method must be an instance of the corresponding primitive wrapper class; otherwise, it must be a type assignable to the declared return type. If the value returned by this method is null and the interface method's return type is primitive, then a NullPointerException will be thrown by the method invocation on the proxy instance. If the value returned by this method is otherwise not compatible with the interface method's declared return type as described above, a ClassCastException will be thrown by the method invocation on the proxy instance.

Annotations

@Override

Exceptions

Throwable:: the exception to throw from the method invocation on the proxy instance. The exception's type must be assignable either to any of the exception types declared in the throws clause of the interface method or to the unchecked exception types java.lang.RuntimeException or java.lang.Error. If a checked exception is thrown by this method that is not assignable to any of the exception types declared in the throws clause of the interface method, then an UndeclaredThrowableException containing the exception that was thrown by this method will be thrown by the method invocation on the proxy instance.

io.micrometer.jakarta9.instrument.jms back to summary

pack-priv Class MessageConsumerInvocationHandler.ObservedMessageListener

Class Inheritance

extends Object
implements MessageListener

java.lang.Object
io.micrometer.jakarta9.instrument.jms.MessageConsumerInvocationHandler.ObservedMessageListener

All Implemented Interfaces

jakarta.jms.MessageListener

Field Summary

Modifier and Type	Field and Description
private final MessageListener	delegate
private final ObservationRegistry	registry

Constructor Summary

Access	Constructor and Description
pack-priv	ObservedMessageListener(MessageListener delegate, ObservationRegistry registry)

Method Summary

Modifier and Type	Method and Description
public void	onMessage(Message the message passed to the listener message) Implements jakarta.jms.MessageListener.onMessage. Passes a message to the listener.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

delegate	back to summary
private final MessageListener delegate

registry	back to summary
private final ObservationRegistry registry

Constructor Detail

ObservedMessageListener	back to summary
pack-priv ObservedMessageListener(MessageListener delegate, ObservationRegistry registry)

Method Detail

onMessage	back to summary
public void onMessage(Message message) Implements jakarta.jms.MessageListener.onMessage. Doc from jakarta.jms.MessageListener.onMessage. Passes a message to the listener. Parameters message:Message the message passed to the listener Annotations @Override

onMessage

back to summary

public void onMessage(Message message)

Implements jakarta.jms.MessageListener.onMessage.

Doc from jakarta.jms.MessageListener.onMessage.

Passes a message to the listener.

Parameters