com.bea.wli.monitoring

Interface ServiceDomainMBean

public interface ServiceDomainMBean

This MBean represents service domain. It provides operations to: 1. Find services enabled for monitoring 2. Get statistics for services enabled for monitoring. 3. Reset statistics for a service or for all services. 4. Mark URIs of a business service online.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME Name of this mbean
static java.lang.String	OBJECT_NAME
static java.lang.String	TYPE Type of this mbean

Method Summary

Methods

Modifier and Type	Method and Description
java.util.HashMap<Ref,ServiceResourceStatistic>	getBusinessServiceStatistics(Ref[] serviceRefs, int resourceTypes, java.lang.String serverName) Gets runtime statistics collected since last reset (of statistics) for the specified business services.
java.lang.String	getClusterName() Attribute getter method.
java.lang.String	getDomainName() Attribute getter method.
Ref[]	getMonitoredBusinessServiceRefs() This operation will get all business services that are enabled for monitoring.
Ref[]	getMonitoredProxyServiceRefs() This operation will get all proxy services that are enabled for monitoring.
java.util.HashMap<Ref,ServiceResourceStatistic>	getProxyServiceStatistics(Ref[] serviceRefs, int resourceTypes, java.lang.String serverName) Gets runtime statistics collected since last reset (of statistics) for the specified proxy services.
java.lang.String[]	getServerNames() Gets name of all managed servers available in the cluster.
long	getVersion() Gets version of this class.
java.util.Set<java.lang.String>	markURIsOnline(java.util.Map<Ref,java.util.List<java.lang.String>> serviceRefVsURIs) Forces the specified URIs for the business services to be marked as online on all the managed servers.
long	resetAllStatistics() Resets statistics for all services.
long	resetStatistics(Ref[] serviceRefs) Resets statistics for specified services.

Field Detail

NAME

static final java.lang.String NAME

Name of this mbean

See Also:

Constant Field Values

TYPE

static final java.lang.String TYPE

Type of this mbean

OBJECT_NAME

static final java.lang.String OBJECT_NAME

Method Detail

getClusterName

java.lang.String getClusterName()
                                throws MonitoringException

Attribute getter method.

Returns:

Cluster name.

Throws:

MonitoringException

getDomainName

java.lang.String getDomainName()
                               throws MonitoringException

Attribute getter method.

Returns:

Domain name.

Throws:

MonitoringException

getServerNames

java.lang.String[] getServerNames()
                                  throws MonitoringException

Gets name of all managed servers available in the cluster.

Returns:

Names of all managed servers from this domain.

Throws:

MonitoringException

getMonitoredBusinessServiceRefs

Ref[] getMonitoredBusinessServiceRefs()
                                      throws MonitoringException

This operation will get all business services that are enabled for monitoring.

Returns:

References of all qualified services.

Throws:

MonitoringException

getMonitoredProxyServiceRefs

Ref[] getMonitoredProxyServiceRefs()
                                   throws MonitoringException

This operation will get all proxy services that are enabled for monitoring.

Returns:

References of all qualified services.

Throws:

MonitoringException

getBusinessServiceStatistics

java.util.HashMap<Ref,ServiceResourceStatistic> getBusinessServiceStatistics(Ref[] serviceRefs,
                                                                           int resourceTypes,
                                                                           java.lang.String serverName)
                                                                             throws DomainMonitoringDisabledException,
                                                                                    MonitoringException,
                                                                                    java.lang.IllegalArgumentException

Gets runtime statistics collected since last reset (of statistics) for the specified business services. If server name is specified as an argument, sever level statistics (statistics from a specific managed server) will be returned. Else cluster wide statistics (aggregated view of statistics from all managed servers) will be returned.

Parameters:

serviceRefs - Business service references.

resourceTypes - Bit map representing one or more resource types. Statistics will be returned for resource types specified in this map for all specified services. This map must be created using constants from class ResourceType only.

serverName - - Managed server name. If specified, statistics for this server will be returned. Otherwise (if null or empty string) cluster level statistics will be returned.

Returns:

Service statistics.

Throws:

DomainMonitoringDisabledException - If domain level monitoring is turned off.

java.lang.IllegalArgumentException - 1. If specified bitmap representing combination is invalid. 2. If it has bit set for ResourceType.FLOW_COMPONENT. 3. If specified services has one or more proxy services. 4. If specified service ref array is null or empty. 5. If server name is invalid.

MonitoringException

getProxyServiceStatistics

java.util.HashMap<Ref,ServiceResourceStatistic> getProxyServiceStatistics(Ref[] serviceRefs,
                                                                        int resourceTypes,
                                                                        java.lang.String serverName)
                                                                          throws DomainMonitoringDisabledException,
                                                                                 MonitoringException,
                                                                                 java.lang.IllegalArgumentException

Gets runtime statistics collected since last reset (of statistics) for the specified proxy services. If server name is specified as an argument, sever level statistics (statistics from a specific managed server) will be returned. Else cluster wide statistics (aggregated view of statistics from all managed servers) will be returned.

Parameters:

serviceRefs - Proxy service references.

resourceTypes - Bit map representing one or more resource types. Statistics will be returned for resource types specified in this map for all specified services. This map must be created using constants from class ResourceType only.

serverName - - Managed server name. If specified, statistics for this server will be returned. Otherwise (if null or empty string) cluster level statistics will be returned.

Returns:

Service statistics.

Throws:

DomainMonitoringDisabledException - If domain level monitoring is turned off.

java.lang.IllegalArgumentException - 1. If specified bitmap representing combination is invalid. 2. If specified services has one or more business services. 3. If specified service ref array is null or empty. 4. If server name is invalid.

MonitoringException

resetStatistics

long resetStatistics(Ref[] serviceRefs)
                     throws MonitoringException,
                            java.lang.IllegalArgumentException

Resets statistics for specified services. All specified services must be valid and enabled for monitoring. Note: This operation will reset only statistics collected since last reset (or server start time if no reset was performed) only. It will not affect interval statistics that are displayed on Dashboard as 'Current Aggregation Interval' statistics. Put it anotther way, it provides the same reset functionality as that is provided by Dashboard. This operation also provides client with the reset request timestamp from Admin server.

Parameters:

serviceRefs - Services of which statistics are to be reset.

Returns:

Reset request time. This time will be from Admin server.

Throws:

java.lang.IllegalArgumentException - 1. If specified service ref array is null or empty. 2. If invalid service found in the specified services. 3. If all specified services are not enabled for monitoring.

MonitoringException - If reset operation fails.

resetAllStatistics

long resetAllStatistics()
                        throws MonitoringException

Resets statistics for all services. Note: This operation will reset only statistics collected since last reset (or server start time if no reset was performed) only. It will not affect interval statistics that are displayed on Dashboard as 'Current Aggregation Interval' statistics. Put it anotther way, it provides the same reset functionality as that is provided by Dashboard. This operation also provides client with the reset request timestamp from Admin server.

Returns:

Reset request time. This time will be from Admin server.

Throws:

MonitoringException - If reset operation fails.

getVersion

long getVersion()

Gets version of this class.

Returns:

Version

markURIsOnline

java.util.Set<java.lang.String> markURIsOnline(java.util.Map<Ref,java.util.List<java.lang.String>> serviceRefVsURIs)
                                               throws NotFoundException,
                                                      java.lang.Exception

Forces the specified URIs for the business services to be marked as online on all the managed servers. If the monitoring is on, this will update the status of specified URIs as online with the monitoring framework. URIs which are already online or doesn�t exist in the service will be ignored.

Parameters:

serviceRefVsURIs - Map of business services vs the list of URIs to be marked as online.

Returns:

Set containing the names of the managed servers on which this operation failed.

Throws:

NotFoundException - If a service is not found in the specified services

java.lang.Exception