Package org.springframework.modulith.observability

Interface ObservedModule

All Known Implementing Classes:
DefaultObservedModule
interface ObservedModule
Author:
Oliver Drotbohm

  • Method Details

    • getName

      @Deprecated(forRemoval=true) String getName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 1.3, use getIdentifier() instead.
      Returns the name of the application module.
      Returns:
      will never be null.

    • getIdentifier

      ApplicationModuleIdentifier getIdentifier()
      Returns the ApplicationModuleIdentifier of the underlying module.
      Returns:
      will never be null.

    • getDisplayName

      String getDisplayName()
      Returns the human-readable name of the module.
      Returns:
      will never be null.

    • getInvokedMethod

      String getInvokedMethod(MethodInvocation invocation)
      Returns the name of the actually invoked Method.
      Parameters:
      invocation - must not be null.
      Returns:

    • exposes

      boolean exposes(com.tngtech.archunit.core.domain.JavaClass type)
      Returns whether the ObservedModule exposes the given JavaClass.
      Parameters:
      type -
      Returns:

    • isObservedModule

      boolean isObservedModule(ApplicationModule module)

    • getObservedModuleType

      @Nullable ObservedModuleType getObservedModuleType(Class<?> type, ApplicationModules modules)
      Returns the ObservedModuleType for the given type and ApplicationModules.
      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

      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.
      Parameters:
      invocation - must not be null.
      Since:
      1.3