lumis.portal.monitor
Class MonitorUtil

java.lang.Object
  lumis.portal.monitor.MonitorUtil

public class MonitorUtil
extends Object

Utility methods for the monitoring framework.

Since:

4.1.0

Constructor Summary

MonitorUtil()

Method Summary

static void	removeChannelAggregationValues() Remove the aggregation values set by setChannelAggregationValues(String, ITransaction) in the monitor context.
static void	removePageAggregationValues() Remove the aggregation values set by setPageAggregationValues(PageConfig, ITransaction).
static void	removeServiceInstanceAggregationValues() Remove the aggregation values set by setServiceInstanceAggregationValues(ServiceInstanceConfig, ITransaction).
static void	setChannelAggregationValues(Map<String,String> aggregationValues, String channelId, ITransaction transaction) Set the specified channel's default aggregation values in the given map.
static void	setChannelAggregationValues(String channelId, ITransaction transaction) Set the specified channel as the current channel in the monitor context.
static void	setPageAggregationValues(Map<String,String> aggregationValues, PageConfig pageConfig, ITransaction transaction) Set the specified page's default aggregation values in the given map.
static void	setPageAggregationValues(PageConfig pageConfig, ITransaction transaction) Set the specified page as the current page in the monitor context.
static void	setServiceInstanceAggregationValues(Map<String,String> aggregationValues, ServiceInstanceConfig serviceInstanceConfig, ITransaction transaction) Set the specified service instance's default aggregation values in the given map.
static void	setServiceInstanceAggregationValues(ServiceInstanceConfig serviceInstanceConfig, ITransaction transaction) Set the specified service instance as the current service instance in the monitor context.

Methods inherited from class java.lang.Object

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

Constructor Detail

MonitorUtil

public MonitorUtil()

Method Detail

setChannelAggregationValues

public static void setChannelAggregationValues(String channelId,
                                               ITransaction transaction)
                                        throws PortalException

Set the specified channel as the current channel in the monitor context. This method sets the IAggregationType.AGGREGATION_TYPE_CHANNEL_PATH and IAggregationType.AGGREGATION_TYPE_CHANNEL_FRIENDLY_PATH aggregation values in the IMonitorContext.

Parameters:

channelId - the channel id.

transaction - the transaction for persistence access.

Throws:

PortalException

Since:

4.1.0

See Also:

removeChannelAggregationValues()

setChannelAggregationValues

public static void setChannelAggregationValues(Map<String,String> aggregationValues,
                                               String channelId,
                                               ITransaction transaction)
                                        throws PortalException

Set the specified channel's default aggregation values in the given map. This method sets the IAggregationType.AGGREGATION_TYPE_CHANNEL_PATH and IAggregationType.AGGREGATION_TYPE_CHANNEL_FRIENDLY_PATH aggregation values.

Parameters:

aggregationValues - the aggregation values map.

channelId - the channel id.

transaction - the transaction for persistence access.

Throws:

PortalException

Since:

4.1.0

removeChannelAggregationValues

public static void removeChannelAggregationValues()

Remove the aggregation values set by setChannelAggregationValues(String, ITransaction) in the monitor context.

Since:

4.1.0

setPageAggregationValues

public static void setPageAggregationValues(PageConfig pageConfig,
                                            ITransaction transaction)
                                     throws PortalException

Set the specified page as the current page in the monitor context. This method sets the IAggregationType.AGGREGATION_TYPE_CHANNEL_PATH, IAggregationType.AGGREGATION_TYPE_CHANNEL_FRIENDLY_PATH and IAggregationType.AGGREGATION_TYPE_PAGE_NAME aggregation values in the IMonitorContext.

Parameters:

pageConfig - the page.

transaction - the transaction for persistence access.

Throws:

PortalException

Since:

4.1.0

See Also:

removePageAggregationValues()

setPageAggregationValues

public static void setPageAggregationValues(Map<String,String> aggregationValues,
                                            PageConfig pageConfig,
                                            ITransaction transaction)
                                     throws PortalException

Set the specified page's default aggregation values in the given map. This method sets the IAggregationType.AGGREGATION_TYPE_CHANNEL_PATH, IAggregationType.AGGREGATION_TYPE_CHANNEL_FRIENDLY_PATH and IAggregationType.AGGREGATION_TYPE_PAGE_NAME aggregation values.

Parameters:

aggregationValues - the aggregation values map.

pageConfig - the page.

transaction - the transaction for persistence access.

Throws:

PortalException

Since:

4.1.0

removePageAggregationValues

public static void removePageAggregationValues()

Remove the aggregation values set by setPageAggregationValues(PageConfig, ITransaction).

Since:

4.1.0

setServiceInstanceAggregationValues

public static void setServiceInstanceAggregationValues(ServiceInstanceConfig serviceInstanceConfig,
                                                       ITransaction transaction)
                                                throws PortalException

Set the specified service instance as the current service instance in the monitor context. This method sets the IAggregationType.AGGREGATION_TYPE_CHANNEL_PATH, IAggregationType.AGGREGATION_TYPE_CHANNEL_FRIENDLY_PATH and IAggregationType.AGGREGATION_TYPE_SERVICE_INSTANCE_NAME aggregation values in the IMonitorContext.

Parameters:

serviceInstanceConfig - the service instance.

transaction - the transaction for persistence access.

Throws:

PortalException

Since:

4.1.0

setServiceInstanceAggregationValues

public static void setServiceInstanceAggregationValues(Map<String,String> aggregationValues,
                                                       ServiceInstanceConfig serviceInstanceConfig,
                                                       ITransaction transaction)
                                                throws PortalException

Set the specified service instance's default aggregation values in the given map. This method sets the IAggregationType.AGGREGATION_TYPE_CHANNEL_PATH, IAggregationType.AGGREGATION_TYPE_CHANNEL_FRIENDLY_PATH and IAggregationType.AGGREGATION_TYPE_SERVICE_INSTANCE_NAME aggregation values.

Parameters:

aggregationValues - the aggregation values map.

serviceInstanceConfig - the service instance.

transaction - the transaction for persistence access.

Throws:

PortalException

Since:

4.1.0

removeServiceInstanceAggregationValues

public static void removeServiceInstanceAggregationValues()

Remove the aggregation values set by setServiceInstanceAggregationValues(ServiceInstanceConfig, ITransaction).

Since:

4.1.0

See Also:

removeServiceInstanceAggregationValues()