Module com.zeroc.ice
Package com.zeroc.IceMX

Interface AsyncMetricsAdmin

All Superinterfaces:
Object
public interface AsyncMetricsAdmin extends Object
The metrics administrative facet interface. This interface allows remote administrative clients to access the metrics of an application that enabled the Ice administrative facility and configured one or more metrics views.

Remarks: The Slice compiler generated this skeleton interface from Slice interface ::IceMX::MetricsAdmin.

  • Method Details

    • getMetricsViewNamesAsync

      CompletionStage<MetricsAdmin.GetMetricsViewNamesResult> getMetricsViewNamesAsync(Current current)
      Gets the names of enabled and disabled metrics.
      Parameters:
      current - the Current object of the incoming request
      Returns:
      a completion stage that the servant will complete with an instance of MetricsAdmin.GetMetricsViewNamesResult

    • enableMetricsViewAsync

      CompletionStage<Void> enableMetricsViewAsync(String name, Current current) throws UnknownMetricsView
      Enables a metrics view.
      Parameters:
      name - The metrics view name.
      current - the Current object of the incoming request
      Returns:
      a completion stage that the servant will complete when the invocation completes
      Throws:
      UnknownMetricsView - Thrown when the metrics view cannot be found.

    • disableMetricsViewAsync

      CompletionStage<Void> disableMetricsViewAsync(String name, Current current) throws UnknownMetricsView
      Disables a metrics view.
      Parameters:
      name - The metrics view name.
      current - the Current object of the incoming request
      Returns:
      a completion stage that the servant will complete when the invocation completes
      Throws:
      UnknownMetricsView - Thrown when the metrics view cannot be found.

    • getMetricsViewAsync

      CompletionStage<MetricsAdmin.GetMetricsViewResult> getMetricsViewAsync(String view, Current current) throws UnknownMetricsView
      Gets the metrics objects for the given metrics view.
      Parameters:
      view - The name of the metrics view.
      current - the Current object of the incoming request
      Returns:
      a completion stage that the servant will complete with an instance of MetricsAdmin.GetMetricsViewResult
      Throws:
      UnknownMetricsView - Thrown when the metrics view cannot be found.

    • getMapMetricsFailuresAsync

      CompletionStage<MetricsFailures[]> getMapMetricsFailuresAsync(String view, String map, Current current) throws UnknownMetricsView
      Gets the metrics failures associated with the given view and map.
      Parameters:
      view - The name of the metrics view.
      map - The name of the metrics map.
      current - the Current object of the incoming request
      Returns:
      The metrics failures associated with the map.
      Throws:
      UnknownMetricsView - Thrown when the metrics view cannot be found.

    • getMetricsFailuresAsync

      CompletionStage<MetricsFailures> getMetricsFailuresAsync(String view, String map, String id, Current current) throws UnknownMetricsView
      Gets the metrics failure associated for the given metrics.
      Parameters:
      view - The name of the metrics view.
      map - The name of the metrics map.
      id - The ID of the metrics.
      current - the Current object of the incoming request
      Returns:
      The metrics failures associated with the metrics.
      Throws:
      UnknownMetricsView - Thrown when the metrics view cannot be found.

    • ice_staticId

      static String ice_staticId()
      Gets the type ID of the associated Slice interface.
      Returns:
      the string "::IceMX::MetricsAdmin"

    • dispatch

      default CompletionStage<OutgoingResponse> dispatch(IncomingRequest request) throws UserException
      Dispatches an incoming request to one of the methods of this generated interface, based on the operation name carried by the request.
      Specified by:
      dispatch in interface Object
      Parameters:
      request - the incoming request
      Returns:
      the outgoing response
      Throws:
      UserException - if a UserException is thrown, Ice will marshal it as the response payload.