com.sun.esb.management.api.performance

Interface PerformanceMeasurementService

All Known Implementing Classes:

PerformanceMeasurementServiceImpl

public interface PerformanceMeasurementService

Defines operations to measure performance statistics. e.g., time taken to normalize/denormalize, encode/decode, wire-to-NMR on the endpoints, etc.

Author:

graj

Method Summary

Methods

Modifier and Type	Method and Description
void	clearPeformaceInstrumentationMeasurement(String componentName, String endpoint, String targetName, String targetInstanceName) Resets the performance measurements on the endpoint.
void	disableMessageExchangeMonitoring(String targetName) This method is used to disable monitoring of timing information about message exchanges
void	enableMessageExchangeMonitoring(String targetName) This method is used to enable monitoring of timing information about message exchanges
String	getComponentStatistics(String componentName, String targetName) This method is used to provide statistics for the given component in the given target
TabularData	getComponentStatisticsAsTabularData(String componentName, String targetName) This method is used to provide statistics for the given component in the given target
TabularData	getConsumingEndpointsForComponentAsTabularData(String componentName, String targetName) This method is used to provide a list of consuming endpoints for a component.
String	getEndpointStatistics(String endpointName, String targetName) This method is used to provide statistic information about the given endpoint in the given target
TabularData	getEndpointStatisticsAsTabularData(String endpointName, String targetName) This method is used to provide statistic information about the given endpoint in the given target
String	getFrameworkStatistics(String targetName) This method is used to provide JBIFramework statistics in the given target.
TabularData	getFrameworkStatisticsAsTabularData(String targetName) This method is used to provide JBIFramework statistics in the given target.
String	getNMRStatistics(String targetName) This method is used to provide statistics about the message service in the given target.
TabularData	getNMRStatisticsAsTabularData(String targetName) This method is used to provide statistics about the message service in the given target.
boolean	getPerformanceInstrumentationEnabled(String componentName, String targetName, String targetInstanceName) Retrieves the performance measurement enabling flag.
String	getPerformanceInstrumentationMeasurement(String componentName, String endpoint, String targetName, String targetInstanceName) Retrieves the performance measurement data for the specified endpoint.
String[]	getPerformanceMeasurementCategories(String componentName, String targetName, String targetInstanceName) Retrieves the performance statistics categories.
TabularData	getProvidingEndpointsForComponentAsTabularData(String componentName, String targetName) This method is used to provide a list of provisioning endpoints for a component.
String	getServiceAssemblyStatistics(String assemblyName, String targetName) This method is used to provide statistics about a Service Assembly in the given target.
TabularData	getServiceAssemblyStatisticsAsTabularData(String assemblyName, String targetName) This method is used to provide statistics about a Service Assembly in the given target.
void	setPerformanceInstrumentationEnabled(String componentName, boolean flag, String targetName, String targetInstanceName) Sets the performance measurement enabling flag.

Method Detail

clearPeformaceInstrumentationMeasurement

void clearPeformaceInstrumentationMeasurement(String componentName,
                                            String endpoint,
                                            String targetName,
                                            String targetInstanceName)
                                              throws ManagementRemoteException

Resets the performance measurements on the endpoint.

Parameters:

componentName -

endpoint -

targetName -

targetInstanceName -

Throws:

ManagementRemoteException

getPerformanceInstrumentationEnabled

boolean getPerformanceInstrumentationEnabled(String componentName,
                                           String targetName,
                                           String targetInstanceName)
                                             throws ManagementRemoteException

Retrieves the performance measurement enabling flag.

Parameters:

componentName -

targetName -

targetInstanceName -

Returns:

true if measurement enabled, false if not

Throws:

ManagementRemoteException

getPerformanceInstrumentationMeasurement

String getPerformanceInstrumentationMeasurement(String componentName,
                                              String endpoint,
                                              String targetName,
                                              String targetInstanceName)
                                                throws ManagementRemoteException

Retrieves the performance measurement data for the specified endpoint.

Parameters:

componentName -

endpoint -

targetName -

targetInstanceName -

Returns:

XML String representing PerformanceData Map

Throws:

ManagementRemoteException

getPerformanceMeasurementCategories

String[] getPerformanceMeasurementCategories(String componentName,
                                           String targetName,
                                           String targetInstanceName)
                                             throws ManagementRemoteException

Retrieves the performance statistics categories. Each item in the array is the key to the composite performance data, which also indicates the type (e.g. normalization) of measurement.

Parameters:

componentName -

targetName -

targetInstanceName -

Returns:

array of performance measurement categories

Throws:

ManagementRemoteException

setPerformanceInstrumentationEnabled

void setPerformanceInstrumentationEnabled(String componentName,
                                        boolean flag,
                                        String targetName,
                                        String targetInstanceName)
                                          throws ManagementRemoteException

Sets the performance measurement enabling flag.

Parameters:

componentName -

flag -

targetName -

targetInstanceName -

Throws:

ManagementRemoteException

getFrameworkStatisticsAsTabularData

TabularData getFrameworkStatisticsAsTabularData(String targetName)
                                                throws ManagementRemoteException

This method is used to provide JBIFramework statistics in the given target.

Parameters:

target - target name.

Returns:

TabularData table of framework statistics in the given target. If the target is a standalone instance the table will have one entry. If the target is a cluster the table will have an entry for each instance. For more information about the type of the entries in table please refer to JBIStatisticsMBean

Throws:

ManagementRemoteException

getFrameworkStatistics

String getFrameworkStatistics(String targetName)
                              throws ManagementRemoteException

This method is used to provide JBIFramework statistics in the given target.

Parameters:

target - target name.

Returns:

String table of framework statistics in the given target. If the target is a standalone instance the table will have one entry. If the target is a cluster the table will have an entry for each instance. For more information about the type of the entries in table please refer to JBIStatisticsMBean

Throws:

ManagementRemoteException

getComponentStatistics

String getComponentStatistics(String componentName,
                            String targetName)
                              throws ManagementRemoteException

This method is used to provide statistics for the given component in the given target

Parameters:

targetName - target name

componentName - component name

Returns:

String table of component statistics If the target is a standalone instance the table will have one entry. If the target is a cluster the table will have an entry for each instance. For more information about the type of the entries in table please refer to JBIStatisticsMBean

Throws:

ManagementRemoteException

getComponentStatisticsAsTabularData

TabularData getComponentStatisticsAsTabularData(String componentName,
                                              String targetName)
                                                throws ManagementRemoteException

This method is used to provide statistics for the given component in the given target

Parameters:

targetName - target name

componentName - component name

Returns:

TabularData table of component statistics If the target is a standalone instance the table will have one entry. If the target is a cluster the table will have an entry for each instance. For more information about the type of the entries in table please refer to JBIStatisticsMBean

Throws:

ManagementRemoteException

getEndpointStatisticsAsTabularData

TabularData getEndpointStatisticsAsTabularData(String endpointName,
                                             String targetName)
                                               throws ManagementRemoteException

This method is used to provide statistic information about the given endpoint in the given target

Parameters:

targetName - target name

endpointName - the endpoint Name

Returns:

TabularData table of endpoint statistics If the target is a standalone instance the table will have one entry. If the target is a cluster the table will have an entry for each instance. For more information about the type of the entries in table please refer to JBIStatisticsMBean

Throws:

ManagementRemoteException

getEndpointStatistics

String getEndpointStatistics(String endpointName,
                           String targetName)
                             throws ManagementRemoteException

This method is used to provide statistic information about the given endpoint in the given target

Parameters:

targetName - target name

endpointName - the endpoint Name

Returns:

String table of endpoint statistics If the target is a standalone instance the table will have one entry. If the target is a cluster the table will have an entry for each instance. For more information about the type of the entries in table please refer to JBIStatisticsMBean

Throws:

ManagementRemoteException

getNMRStatisticsAsTabularData

TabularData getNMRStatisticsAsTabularData(String targetName)
                                          throws ManagementRemoteException

This method is used to provide statistics about the message service in the given target.

Parameters:

target - target name.

Returns:

TabularData table of NMR statistics in the given target. If the target is a standalone instance the table will have one entry. If the target is a cluster the table will have an entry for each instance. For more information about the type of the entries in table please refer to JBIStatisticsMBean

Throws:

ManagementRemoteException

getNMRStatistics

String getNMRStatistics(String targetName)
                        throws ManagementRemoteException

This method is used to provide statistics about the message service in the given target.

Parameters:

target - target name.

Returns:

String table of NMR statistics in the given target. If the target is a standalone instance the table will have one entry. If the target is a cluster the table will have an entry for each instance. For more information about the type of the entries in table please refer to JBIStatisticsMBean

Throws:

ManagementRemoteException

getServiceAssemblyStatisticsAsTabularData

TabularData getServiceAssemblyStatisticsAsTabularData(String assemblyName,
                                                    String targetName)
                                                      throws ManagementRemoteException

This method is used to provide statistics about a Service Assembly in the given target.

Parameters:

target - target name.

assemblyName - the service assembly name.

Returns:

TabularData table of NMR statistics in the given target. If the target is a standalone instance the table will have one entry. If the target is a cluster the table will have an entry for each instance. For more information about the type of the entries in table please refer to JBIStatisticsMBean

Throws:

ManagementRemoteException

getServiceAssemblyStatistics

String getServiceAssemblyStatistics(String assemblyName,
                                  String targetName)
                                    throws ManagementRemoteException

This method is used to provide statistics about a Service Assembly in the given target.

Parameters:

target - target name.

assemblyName - the service assembly name.

Returns:

String table of NMR statistics in the given target. If the target is a standalone instance the table will have one entry. If the target is a cluster the table will have an entry for each instance. For more information about the type of the entries in table please refer to JBIStatisticsMBean

Throws:

ManagementRemoteException

getConsumingEndpointsForComponentAsTabularData

TabularData getConsumingEndpointsForComponentAsTabularData(String componentName,
                                                         String targetName)
                                                           throws ManagementRemoteException

This method is used to provide a list of consuming endpoints for a component.

Parameters:

componentName - component name

target - target name.

Returns:

TabularData list of consuming endpoints If the target is a standalone instance the table will have one entry. If the target is a cluster the table will have an entry for each instance. Each entry in this tabular data is of the following composite type String - "InstanceName", String[] - "Endpoints",

Throws:

ManagementRemoteException

getProvidingEndpointsForComponentAsTabularData

TabularData getProvidingEndpointsForComponentAsTabularData(String componentName,
                                                         String targetName)
                                                           throws ManagementRemoteException

This method is used to provide a list of provisioning endpoints for a component.

Parameters:

componentName - component name

target - target name.

Returns:

TabularData list of provisioning endpoints If the target is a standalone instance the table will have one entry. If the target is a cluster the table will have an entry for each instance. Each entry in this tabular data is of the following composite type String - "InstanceName", String[] - "Endpoints",

Throws:

ManagementRemoteException

enableMessageExchangeMonitoring

void enableMessageExchangeMonitoring(String targetName)
                                     throws ManagementRemoteException

This method is used to enable monitoring of timing information about message exchanges

Parameters:

targetName - the target name

Throws:

ManagementRemoteException

disableMessageExchangeMonitoring

void disableMessageExchangeMonitoring(String targetName)
                                      throws ManagementRemoteException

This method is used to disable monitoring of timing information about message exchanges

Parameters:

targetName - the target name

Throws:

ManagementRemoteException