io.micronaut.reactive.rxjava2

Class RunOnceInvocationInstrumenter

java.lang.Object

io.micronaut.reactive.rxjava2.RunOnceInvocationInstrumenter

All Implemented Interfaces:

InvocationInstrumenter

public final class RunOnceInvocationInstrumenter
extends Object
implements InvocationInstrumenter

Wraps any InvocationInstrumenter to protect against multiple chained invocations.

Since:

2.0

Author:

lgathy

Field Summary

Fields inherited from interface io.micronaut.scheduling.instrument.InvocationInstrumenter

NOOP

Method Summary

Modifier and Type	Method and Description
void	afterInvocation(boolean cleanup) After call.
void	beforeInvocation() Before call.
static InvocationInstrumenter	create(io.micronaut.reactive.rxjava2.RxInstrumenterFactory factory) Creates a new InvocationInstrumenter with the given factory and wraps it immediately.
Instrumentation	newInstrumentation()
static InvocationInstrumenter	wrap(InvocationInstrumenter instrumenter) Wraps the given instrumenter if necessary to guarantee that it will only instrument once if it gets called multiple times in a chain.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.scheduling.instrument.InvocationInstrumenter

afterInvocation, combine, instrument, instrument, instrument, instrument, instrument

Method Detail

newInstrumentation

@NonNull
public Instrumentation newInstrumentation()

Specified by:

newInstrumentation in interface InvocationInstrumenter

Returns:

a one-time Instrumentation instance which to be used in a try-with-resources to do the instrumentation. When using this approach InvocationInstrumenter.beforeInvocation() will already be invoked by the time this method invocation returns. Instrumentation.close() will by default invoke InvocationInstrumenter.afterInvocation() without cleanup. To force cleanup invoke Instrumentation.forceCleanup() on the retuned instance.

beforeInvocation

public void beforeInvocation()

Description copied from interface: InvocationInstrumenter

Before call.

Specified by:

beforeInvocation in interface InvocationInstrumenter

afterInvocation

public void afterInvocation(boolean cleanup)

Description copied from interface: InvocationInstrumenter

After call.

Specified by:

afterInvocation in interface InvocationInstrumenter

Parameters:

cleanup - Whether to enforce cleanup

create

@NonNull
public static InvocationInstrumenter create(@NonNull
                                                     io.micronaut.reactive.rxjava2.RxInstrumenterFactory factory)

Creates a new InvocationInstrumenter with the given factory and wraps it immediately.

Equivalent to: wrap(factory.create())

Parameters:

factory - The instrumenter factory to create instrumenter with.

Returns:

an instrumenter created by the factory protected against multiple chained invocations.

wrap

@NonNull
public static InvocationInstrumenter wrap(@Nullable
                                                   InvocationInstrumenter instrumenter)

Wraps the given instrumenter if necessary to guarantee that it will only instrument once if it gets called multiple times in a chain. Thus the following code:

 InvocationInstrumenter delegate = ...;
 InvocationInstrumenter onlyOnce = RunOnceInvocationInstrumenter.wrap(delegate);
 try (Instrumentation outer = onlyOnce.newInstrumentation()) {
     try (Instrumentation inner = onlyOnce.newInstrumentation()) {
         ...
     }
 }
 

will only invoke delegate.beforeInvocation() and delegate.afterInvocation() once.

Parameters:

instrumenter - The instrumenter to protect against multiple chained invocations.

Returns:

the protected instrumenter instance.