Package org.matomo.java.tracking.spring

Class MatomoTrackerAutoConfiguration

java.lang.Object
org.matomo.java.tracking.spring.MatomoTrackerAutoConfiguration
@AutoConfiguration @ConditionalOnProperty(prefix="matomo.tracker", name="api-endpoint") @EnableConfigurationProperties(MatomoTrackerProperties.class) public class MatomoTrackerAutoConfiguration extends Object
Auto configuration for Matomo Tracker.
See Also:

  • Constructor Details

    • MatomoTrackerAutoConfiguration

      public MatomoTrackerAutoConfiguration()

  • Method Details

    • trackerConfigurationBuilder

      @Bean @ConditionalOnMissingBean public @NonNull org.matomo.java.tracking.TrackerConfiguration.TrackerConfigurationBuilder trackerConfigurationBuilder(@NonNull List<TrackerConfigurationBuilderCustomizer> customizers)
      Creates a TrackerConfiguration.TrackerConfigurationBuilder and applies all TrackerConfigurationBuilderCustomizers. Can be overridden by custom beans.
      Parameters:
      customizers - the customizers to apply to the builder instance (never null)
      Returns:
      the TrackerConfiguration.TrackerConfigurationBuilder instance (never null)
      See Also:
      • TrackerConfiguration.builder()

    • trackerConfiguration

      @Bean @ConditionalOnMissingBean public @NonNull org.matomo.java.tracking.TrackerConfiguration trackerConfiguration(org.matomo.java.tracking.TrackerConfiguration.TrackerConfigurationBuilder builder)
      Creates a TrackerConfiguration instance based on the current configuration. Can be overridden by custom beans.

      If you define your own TrackerConfiguration bean, please don't forget to set the API endpoint.

      Parameters:
      builder - the TrackerConfiguration.TrackerConfigurationBuilder instance (never null)
      Returns:
      the TrackerConfiguration instance (never null)
      See Also:
      • TrackerConfiguration.builder()
      • TrackerConfiguration.TrackerConfigurationBuilder.apiEndpoint(URI)

    • standardTrackerConfigurationBuilderCustomizer

      @Bean public @NonNull org.matomo.java.tracking.spring.StandardTrackerConfigurationBuilderCustomizer standardTrackerConfigurationBuilderCustomizer(@NonNull MatomoTrackerProperties properties)
      Configures the TrackerConfiguration.TrackerConfigurationBuilder with the properties from MatomoTrackerProperties.
      Parameters:
      properties - the MatomoTrackerProperties instance (never null)
      Returns:
      the StandardTrackerConfigurationBuilderCustomizer instance (never null)
      See Also:

    • matomoTracker

      @Bean @ConditionalOnMissingBean public @NonNull org.matomo.java.tracking.MatomoTracker matomoTracker(@NonNull org.matomo.java.tracking.TrackerConfiguration trackerConfiguration)
      A MatomoTracker instance based on the current configuration. Only created if a bean of the same type is not already configured.
      Parameters:
      trackerConfiguration - the TrackerConfiguration instance (never null)
      Returns:
      the MatomoTracker instance (never null)
      See Also:
      • MatomoTracker
      • TrackerConfiguration

    • matomoTrackerSpringFilter

      @Bean @ConditionalOnProperty(value="matomo.tracker.filter.enabled", havingValue="true") public @NonNull org.springframework.boot.web.servlet.FilterRegistrationBean<org.matomo.java.tracking.servlet.MatomoTrackerFilter> matomoTrackerSpringFilter(@NonNull org.matomo.java.tracking.MatomoTracker matomoTracker)
      A FilterRegistrationBean for the MatomoTrackerFilter.

      Only created if a bean of the same type is not already configured. The filter is only registered if matomo.tracker.filter.enabled is set to true.

      Parameters:
      matomoTracker - the MatomoTracker instance (never null)
      Returns:
      the FilterRegistrationBean instance (never null)