Package 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 Details

  • Method Details

    • getClusterName

      String getClusterName() throws MonitoringException
      Attribute getter method.
      Returns:
      Cluster name.
      Throws:
      MonitoringException

    • getDomainName

      String getDomainName() throws MonitoringException
      Attribute getter method.
      Returns:
      Domain name.
      Throws:
      MonitoringException

    • getServerNames

      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

      @Deprecated Ref[] getMonitoredBusinessServiceRefs() throws MonitoringException
      Deprecated.
      use getMonitoredRefs() instead
      This operation will get all business services that are enabled for monitoring.
      Returns:
      References of all qualified services.
      Throws:
      MonitoringException

    • getMonitoredProxyServiceRefs

      @Deprecated Ref[] getMonitoredProxyServiceRefs() throws MonitoringException
      Deprecated.
      use getMonitoredRefs() instead
      This operation will get all proxy services that are enabled for monitoring.
      Returns:
      References of all qualified services.
      Throws:
      MonitoringException

    • getMonitoredRefs

      Ref[] getMonitoredRefs(String... typeIDs) throws MonitoringException
      This operation will get all services of the given types that are enabled for monitoring.
      Returns:
      References of all qualified services.
      Throws:
      MonitoringException

    • getBusinessServiceStatistics

      @Deprecated HashMap<Ref,ServiceResourceStatistic> getBusinessServiceStatistics(Ref[] serviceRefs, int resourceTypes, String serverName) throws DomainMonitoringDisabledException, MonitoringException, IllegalArgumentException
      Deprecated.
      use getStatistics() instead
      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.
      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

      @Deprecated HashMap<Ref,ServiceResourceStatistic> getProxyServiceStatistics(Ref[] serviceRefs, int resourceTypes, String serverName) throws DomainMonitoringDisabledException, MonitoringException, IllegalArgumentException
      Deprecated.
      use getStatistics() instead
      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.
      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

    • getStatistics

      HashMap<Ref,ServiceResourceStatistic> getStatistics(Ref[] refs, ResourceType[] resourceTypes, String serverName) throws DomainMonitoringDisabledException, MonitoringException, IllegalArgumentException
      Gets runtime statistics collected since last reset (of statistics) for the specified resources.

      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:
      refs - Resource references.
      resourceTypes - Array of one or more resource types. Statistics will be returned for resource types specified for all specified resources.
      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:
      Resource statistics.
      Throws:
      DomainMonitoringDisabledException - If domain level monitoring is turned off.
      IllegalArgumentException - 1. If specified ref array is null or empty. 2. If server name is invalid.
      MonitoringException

    • resetStatistics

      long resetStatistics(Ref[] serviceRefs) throws MonitoringException, 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:
      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

      Set<String> markURIsOnline(Map<Ref,List<String>> serviceRefVsURIs) throws NotFoundException, 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
      Exception

    • markURIsOffline

      void markURIsOffline(Map<Ref,List<String>> serviceRefVsURIs) throws NotFoundException, Exception
      Forces the specified URIs for the business services to be marked as offline on all the managed servers. If the monitoring is on, this will update the status of specified URIs as offline with the monitoring framework. URIs which are already offline or don't exist in the service will be ignored.
      Parameters:
      serviceRefVsURIs - Map of business services vs the list of URIs to be marked as offline.
      Throws:
      NotFoundException - If a service is not found in the specified services
      Exception