Class UsageEventManager

java.lang.Object
com.jalios.jcms.analytics.usage.UsageEventManager
All Implemented Interfaces:
JPropertiesListener

public class UsageEventManager extends Object implements JPropertiesListener
Since:
jcms-11.0.0
  • Field Details

    • CORE_DOMAIN

      public static final String CORE_DOMAIN
      See Also:
    • FORCE_ACCEPT_AJAX_REQUEST_PARAMETER

      public static final String FORCE_ACCEPT_AJAX_REQUEST_PARAMETER
      See Also:
    • USAGE_TARGET_REQUEST_PARAMETER

      public static final String USAGE_TARGET_REQUEST_PARAMETER
      See Also:
    • PLUGIN_NAME_ATTRIBUTE

      @Deprecated public static String PLUGIN_NAME_ATTRIBUTE
      Deprecated.
    • DOMAIN_ATTRIBUTE

      public static String DOMAIN_ATTRIBUTE
    • VIEW_TYPE_ATTRIBUTE

      public static String VIEW_TYPE_ATTRIBUTE
    • USAGE_EVENT_REQUEST_ATTRIBUTE

      public static String USAGE_EVENT_REQUEST_ATTRIBUTE
    • REQUEST_USAGE_EVENT_ALREADY_SENT_STACKTRACE_ATTRIBUTE

      public static String REQUEST_USAGE_EVENT_ALREADY_SENT_STACKTRACE_ATTRIBUTE
    • REQUEST_USAGE_EVENT_ALREADY_SENT_ATTRIBUTE

      public static String REQUEST_USAGE_EVENT_ALREADY_SENT_ATTRIBUTE
    • IGNORE_REQUEST_USAGE_EVENT_ATTRIBUTE

      public static String IGNORE_REQUEST_USAGE_EVENT_ATTRIBUTE
    • DISABLE_DEFAULT_APP_USAGE_EVENT

      public static String DISABLE_DEFAULT_APP_USAGE_EVENT
    • USAGE_TYPE

      public static String USAGE_TYPE
  • Method Details

    • getInstance

      public static UsageEventManager getInstance()
    • propertiesChange

      public void propertiesChange(JProperties properties)
      Description copied from interface: JPropertiesListener
      Invoked after properties have been modified in JCMS and save on disk.

      You cannot alter the value received in parameters.

      Note that properties parameter may be null, a limited set of site properties, or all site properties.

      To check that a property has been modified, reload the "current" property instead using channel.getProperties or channel.getProperty.

      Specified by:
      propertiesChange in interface JPropertiesListener
      Parameters:
      properties - the properties which have been submitted to change
    • getUsageFeatureActivationDate

      public LocalDate getUsageFeatureActivationDate()
    • appendUsageEvent

      public static void appendUsageEvent(javax.servlet.http.HttpServletRequest request, String appName, String pluginName, UsageEventManager.ViewType pageType, String pageName, String pageTitle)
    • appendUsageEvent

      public static void appendUsageEvent(javax.servlet.http.HttpServletRequest request, UsageEventData usageEventData)
    • appendRequestUsageEvent

      public static void appendRequestUsageEvent(javax.servlet.http.HttpServletRequest request)
    • hasUsageEvent

      public static boolean hasUsageEvent(javax.servlet.http.HttpServletRequest request)
    • isCurrentRequestIgnored

      public static boolean isCurrentRequestIgnored(javax.servlet.http.HttpServletRequest request)
    • ignoreCurrentRequest

      public static void ignoreCurrentRequest(javax.servlet.http.HttpServletRequest request)
    • disableDefaultAppUsageEvent

      public static void disableDefaultAppUsageEvent(javax.servlet.http.HttpServletRequest request)
    • isDefaultAppUsageEventDisabled

      public static boolean isDefaultAppUsageEventDisabled(javax.servlet.http.HttpServletRequest request)
    • acceptUsageEvent

      public static boolean acceptUsageEvent(javax.servlet.http.HttpServletRequest request)
    • getRequestUsageEvent

      public static UsageEventData getRequestUsageEvent(javax.servlet.http.HttpServletRequest request)
    • buildNewUsageEventData

      public static UsageEventData buildNewUsageEventData(javax.servlet.http.HttpServletRequest request)
    • buildNewUsageEventData

      public static UsageEventData buildNewUsageEventData(javax.servlet.http.HttpServletRequest request, String contextApp, String domain, UsageEventManager.ViewType viewType, String pageName, String pageTitle)
    • getDateAsLong

      public static Long getDateAsLong(String dateStr, String lang)
    • notEmpty

      public static boolean notEmpty(String[] values)
    • notEmpty

      public static boolean notEmpty(String value)
    • clearUsageIndicator

      public static void clearUsageIndicator(TimeChartSeries serie, LocalDate activationDate, boolean keepBefore)