Class BannerMonitorUtil


  • public class BannerMonitorUtil
    extends Object
    Contains banner monitoring constants and utility methods.
    Since:
    4.1.0
    Version:
    $Revision: 21053 $ $Date: 2018-03-20 18:46:07 -0300 (Tue, 20 Mar 2018) $
    • Field Detail

      • STRING_RESOURCE_PATH

        public static final String STRING_RESOURCE_PATH
        The string resource path using for localizing banner monitoring strings.
        Since:
        4.1.0
        See Also:
        Constant Field Values
      • EVENT_BANNER_VIEW

        public static final String EVENT_BANNER_VIEW
        Key for banner view event.
        Since:
        4.1.0
        See Also:
        Constant Field Values
      • EVENT_BANNER_CLICK

        public static final String EVENT_BANNER_CLICK
        Key for banner click event.
        Since:
        4.1.0
        See Also:
        Constant Field Values
    • Constructor Detail

      • BannerMonitorUtil

        public BannerMonitorUtil()
    • Method Detail

      • getBannerViewMonitor

        public static IMonitor getBannerViewMonitor​(ServiceInstanceConfig bannerServiceInstanceConfig,
                                                    String bannerName,
                                                    String bannerCategoryId,
                                                    ContentVersion bannerContentVersion,
                                                    PageConfig displayPageConfig,
                                                    WebResource webResource,
                                                    ITransaction transaction)
                                             throws PortalException
        Returns a monitor for the "lumis.portal.monitor.ev.banner.view" event.
        Parameters:
        bannerServiceInstanceConfig - the banner service instance.
        bannerName - the banner's name.
        bannerCategoryId - the banner's category id, or null if the banner has no category specified.
        bannerContentId - the banner's content identifier.
        displayPageConfig - the page where the banner is shown.
        transaction - the transaction for persistence access.
        Returns:
        the monitor.
        Throws:
        PortalException
        Since:
        4.1.0
      • getBannerClickMonitor

        public static IMonitor getBannerClickMonitor​(ServiceInstanceConfig bannerServiceInstanceConfig,
                                                     String bannerName,
                                                     String bannerCategoryId,
                                                     ContentVersion bannerContentVersion,
                                                     PageConfig displayPageConfig,
                                                     WebResource webResource,
                                                     ITransaction transaction)
                                              throws PortalException
        Returns a monitor for the "lumis.portal.monitor.ev.banner.click" event.
        Parameters:
        bannerServiceInstanceConfig - the banner service instance.
        bannerName - the banner's name.
        bannerCategoryId - the banner's category id, or null if the banner has no category specified.
        bannerContentId - the banner's content identifier.
        displayPageConfig - the page where the banner was shown.
        transaction - the transaction for persistence access.
        Returns:
        the monitor.
        Throws:
        PortalException
        Since:
        4.1.0