Package org.springframework.modulith.observability

Class DefaultObservedModule

java.lang.Object

org.springframework.modulith.observability.DefaultObservedModule

All Implemented Interfaces:

ObservedModule

class DefaultObservedModule
extends Object
implements ObservedModule

Constructor Summary

Constructors

Constructor	Description
DefaultObservedModule(ApplicationModule module)	Creates a new DefaultObservedModule for the given ApplicationModule.

Method Summary

Modifier and Type	Method	Description
boolean	exposes(com.tngtech.archunit.core.domain.JavaClass type)	Returns whether the ObservedModule exposes the given JavaClass.
String	getDisplayName()	Returns the human-readable name of the module.
ApplicationModuleIdentifier	getIdentifier()	Returns the ApplicationModuleIdentifier of the underlying module.
String	getInvokedMethod(MethodInvocation invocation)	Returns the name of the actually invoked Method.
String	getName()	Returns the name of the application module.
ObservedModuleType	getObservedModuleType(Class<?> type, ApplicationModules modules)	Returns the ObservedModuleType for the given type and ApplicationModules.
boolean	isEventListenerInvocation(MethodInvocation invocation)	Returns whether the given MethodInvocation is the invocation of an event listener as opposed to a standard method invocation on a Spring bean.
boolean	isObservedModule(ApplicationModule module)

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultObservedModule

DefaultObservedModule(ApplicationModule module)

Creates a new DefaultObservedModule for the given ApplicationModule.

Parameters:

module - must not be null.

Method Details

getName

public String getName()

Description copied from interface: ObservedModule

Returns the name of the application module.

Specified by:

getName in interface ObservedModule

Returns:

will never be null.

getIdentifier

public ApplicationModuleIdentifier getIdentifier()

Description copied from interface: ObservedModule

Returns the ApplicationModuleIdentifier of the underlying module.

Specified by:

getIdentifier in interface ObservedModule

Returns:

will never be null.

getDisplayName

public String getDisplayName()

Description copied from interface: ObservedModule

Returns the human-readable name of the module.

Specified by:

getDisplayName in interface ObservedModule

Returns:

will never be null.

getInvokedMethod

public String getInvokedMethod(MethodInvocation invocation)

Description copied from interface: ObservedModule

Returns the name of the actually invoked Method.

Specified by:

getInvokedMethod in interface ObservedModule

Parameters:

invocation - must not be null.

Returns:

exposes

public boolean exposes(com.tngtech.archunit.core.domain.JavaClass type)

Description copied from interface: ObservedModule

Returns whether the ObservedModule exposes the given JavaClass.

Specified by:

exposes in interface ObservedModule

Returns:

isObservedModule

public boolean isObservedModule(ApplicationModule module)

Specified by:

isObservedModule in interface ObservedModule

getObservedModuleType

public ObservedModuleType getObservedModuleType(Class<?> type,
 ApplicationModules modules)

Description copied from interface: ObservedModule

Returns the ObservedModuleType for the given type and ApplicationModules.

Specified by:

getObservedModuleType in interface ObservedModule

Parameters:

type - must not be null.

modules - must not be null.

Returns:

the ObservedModuleType for the given type or null if the type is not to be observed.

isEventListenerInvocation

public boolean isEventListenerInvocation(MethodInvocation invocation)

Description copied from interface: ObservedModule

Returns whether the given MethodInvocation is the invocation of an event listener as opposed to a standard method invocation on a Spring bean.

Specified by:

isEventListenerInvocation in interface ObservedModule

Parameters:

invocation - must not be null.