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

Interface MetricsAdminPrx

All Superinterfaces:
ObjectPrx
public interface MetricsAdminPrx extends ObjectPrx
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.

  • Method Details

    • getMetricsViewNames

      default MetricsAdmin.GetMetricsViewNamesResult getMetricsViewNames()
      Gets the names of enabled and disabled metrics.
      Returns:
      An instance of MetricsAdmin.GetMetricsViewNamesResult.

    • getMetricsViewNames

      default MetricsAdmin.GetMetricsViewNamesResult getMetricsViewNames(Map<String,String> context)
      Gets the names of enabled and disabled metrics.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      An instance of MetricsAdmin.GetMetricsViewNamesResult.

    • getMetricsViewNamesAsync

      default CompletableFuture<MetricsAdmin.GetMetricsViewNamesResult> getMetricsViewNamesAsync()
      Gets the names of enabled and disabled metrics.
      Returns:
      A future that will be completed with an instance of MetricsAdmin.GetMetricsViewNamesResult.

    • getMetricsViewNamesAsync

      default CompletableFuture<MetricsAdmin.GetMetricsViewNamesResult> getMetricsViewNamesAsync(Map<String,String> context)
      Gets the names of enabled and disabled metrics.
      Parameters:
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed with an instance of MetricsAdmin.GetMetricsViewNamesResult.

    • enableMetricsView

      default void enableMetricsView(String name) throws UnknownMetricsView
      Enables a metrics view.
      Parameters:
      name - The metrics view name.
      Throws:
      UnknownMetricsView - Thrown when the metrics view cannot be found.

    • enableMetricsView

      default void enableMetricsView(String name, Map<String,String> context) throws UnknownMetricsView
      Enables a metrics view.
      Parameters:
      name - The metrics view name.
      context - The Context map to send with the invocation.
      Throws:
      UnknownMetricsView - Thrown when the metrics view cannot be found.

    • enableMetricsViewAsync

      default CompletableFuture<Void> enableMetricsViewAsync(String name)
      Enables a metrics view.
      Parameters:
      name - The metrics view name.
      Returns:
      A future that will be completed when the invocation completes.

    • enableMetricsViewAsync

      default CompletableFuture<Void> enableMetricsViewAsync(String name, Map<String,String> context)
      Enables a metrics view.
      Parameters:
      name - The metrics view name.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • disableMetricsView

      default void disableMetricsView(String name) throws UnknownMetricsView
      Disables a metrics view.
      Parameters:
      name - The metrics view name.
      Throws:
      UnknownMetricsView - Thrown when the metrics view cannot be found.

    • disableMetricsView

      default void disableMetricsView(String name, Map<String,String> context) throws UnknownMetricsView
      Disables a metrics view.
      Parameters:
      name - The metrics view name.
      context - The Context map to send with the invocation.
      Throws:
      UnknownMetricsView - Thrown when the metrics view cannot be found.

    • disableMetricsViewAsync

      default CompletableFuture<Void> disableMetricsViewAsync(String name)
      Disables a metrics view.
      Parameters:
      name - The metrics view name.
      Returns:
      A future that will be completed when the invocation completes.

    • disableMetricsViewAsync

      default CompletableFuture<Void> disableMetricsViewAsync(String name, Map<String,String> context)
      Disables a metrics view.
      Parameters:
      name - The metrics view name.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed when the invocation completes.

    • getMetricsView

      default MetricsAdmin.GetMetricsViewResult getMetricsView(String view) throws UnknownMetricsView
      Gets the metrics objects for the given metrics view.
      Parameters:
      view - The name of the metrics view.
      Returns:
      An instance of MetricsAdmin.GetMetricsViewResult.
      Throws:
      UnknownMetricsView - Thrown when the metrics view cannot be found.

    • getMetricsView

      default MetricsAdmin.GetMetricsViewResult getMetricsView(String view, Map<String,String> context) throws UnknownMetricsView
      Gets the metrics objects for the given metrics view.
      Parameters:
      view - The name of the metrics view.
      context - The Context map to send with the invocation.
      Returns:
      An instance of MetricsAdmin.GetMetricsViewResult.
      Throws:
      UnknownMetricsView - Thrown when the metrics view cannot be found.

    • getMetricsViewAsync

      default CompletableFuture<MetricsAdmin.GetMetricsViewResult> getMetricsViewAsync(String view)
      Gets the metrics objects for the given metrics view.
      Parameters:
      view - The name of the metrics view.
      Returns:
      A future that will be completed with an instance of MetricsAdmin.GetMetricsViewResult.

    • getMetricsViewAsync

      default CompletableFuture<MetricsAdmin.GetMetricsViewResult> getMetricsViewAsync(String view, Map<String,String> context)
      Gets the metrics objects for the given metrics view.
      Parameters:
      view - The name of the metrics view.
      context - The Context map to send with the invocation.
      Returns:
      A future that will be completed with an instance of MetricsAdmin.GetMetricsViewResult.

    • getMapMetricsFailures

      default MetricsFailures[] getMapMetricsFailures(String view, String map) 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.
      Returns:
      The metrics failures associated with the map.
      Throws:
      UnknownMetricsView - Thrown when the metrics view cannot be found.

    • getMapMetricsFailures

      default MetricsFailures[] getMapMetricsFailures(String view, String map, Map<String,String> context) 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.
      context - The Context map to send with the invocation.
      Returns:
      The metrics failures associated with the map.
      Throws:
      UnknownMetricsView - Thrown when the metrics view cannot be found.

    • getMapMetricsFailuresAsync

      default CompletableFuture<MetricsFailures[]> getMapMetricsFailuresAsync(String view, String map)
      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.
      Returns:
      The metrics failures associated with the map.

    • getMapMetricsFailuresAsync

      default CompletableFuture<MetricsFailures[]> getMapMetricsFailuresAsync(String view, String map, Map<String,String> context)
      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.
      context - The Context map to send with the invocation.
      Returns:
      The metrics failures associated with the map.

    • getMetricsFailures

      default MetricsFailures getMetricsFailures(String view, String map, String id) 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.
      Returns:
      The metrics failures associated with the metrics.
      Throws:
      UnknownMetricsView - Thrown when the metrics view cannot be found.

    • getMetricsFailures

      default MetricsFailures getMetricsFailures(String view, String map, String id, Map<String,String> context) 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.
      context - The Context map to send with the invocation.
      Returns:
      The metrics failures associated with the metrics.
      Throws:
      UnknownMetricsView - Thrown when the metrics view cannot be found.

    • getMetricsFailuresAsync

      default CompletableFuture<MetricsFailures> getMetricsFailuresAsync(String view, String map, String id)
      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.
      Returns:
      The metrics failures associated with the metrics.

    • getMetricsFailuresAsync

      default CompletableFuture<MetricsFailures> getMetricsFailuresAsync(String view, String map, String id, Map<String,String> context)
      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.
      context - The Context map to send with the invocation.
      Returns:
      The metrics failures associated with the metrics.

    • createProxy

      static MetricsAdminPrx createProxy(Communicator communicator, String proxyString)
      Creates a new proxy that implements MetricsAdminPrx.
      Parameters:
      communicator - The communicator of the new proxy.
      proxyString - The string representation of the proxy.
      Returns:
      The new proxy.

    • checkedCast

      static MetricsAdminPrx checkedCast(ObjectPrx obj)
      Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation. Throws a local exception if a communication error occurs.
      Parameters:
      obj - The source proxy.
      Returns:
      A proxy for this type, or null if the object does not support this type.

    • checkedCast

      static MetricsAdminPrx checkedCast(ObjectPrx obj, Map<String,String> context)
      Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation. Throws a local exception if a communication error occurs.
      Parameters:
      obj - The source proxy.
      context - The Context map to send with the invocation.
      Returns:
      A new proxy for this type, or null if the object does not support this type.

    • checkedCast

      static MetricsAdminPrx checkedCast(ObjectPrx obj, String facet)
      Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation. Throws a local exception if a communication error occurs.
      Parameters:
      obj - The source proxy.
      facet - The name of the desired facet.
      Returns:
      A new proxy for this type, or null if the facet does not support this type.

    • checkedCast

      static MetricsAdminPrx checkedCast(ObjectPrx obj, String facet, Map<String,String> context)
      Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation. Throws a local exception if a communication error occurs.
      Parameters:
      obj - The source proxy.
      facet - The name of the desired facet.
      context - The Context map to send with the invocation.
      Returns:
      A new proxy for this type, or null if the object does not support this type.

    • uncheckedCast

      static MetricsAdminPrx uncheckedCast(ObjectPrx obj)
      Creates a new proxy from an existing proxy.
      Parameters:
      obj - The untyped proxy.
      Returns:
      A new proxy for this type.

    • uncheckedCast

      static MetricsAdminPrx uncheckedCast(ObjectPrx obj, String facet)
      Creates a new proxy from an existing proxy.
      Parameters:
      obj - The untyped proxy.
      facet - The name of the desired facet.
      Returns:
      A new proxy for this type.

    • ice_context

      MetricsAdminPrx ice_context(Map<String,String> newContext)
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, except for the per-proxy context.
      Specified by:
      ice_context in interface ObjectPrx
      Parameters:
      newContext - The context for the new proxy.
      Returns:
      A proxy with the new per-proxy context.

    • ice_adapterId

      MetricsAdminPrx ice_adapterId(String newAdapterId)
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, except for the adapter ID.
      Specified by:
      ice_adapterId in interface ObjectPrx
      Parameters:
      newAdapterId - The adapter ID for the new proxy.
      Returns:
      A proxy with the new adapter ID.

    • ice_endpoints

      MetricsAdminPrx ice_endpoints(Endpoint[] newEndpoints)
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, except for the endpoints.
      Specified by:
      ice_endpoints in interface ObjectPrx
      Parameters:
      newEndpoints - The endpoints for the new proxy.
      Returns:
      A proxy with the new endpoints.

    • ice_locatorCacheTimeout

      MetricsAdminPrx ice_locatorCacheTimeout(int newTimeout)
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, except for the locator cache timeout.
      Specified by:
      ice_locatorCacheTimeout in interface ObjectPrx
      Parameters:
      newTimeout - The new locator cache timeout (in seconds).
      Returns:
      A proxy with the new timeout.
      See Also:

    • ice_invocationTimeout

      MetricsAdminPrx ice_invocationTimeout(int newTimeout)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for the invocation timeout.
      Specified by:
      ice_invocationTimeout in interface ObjectPrx
      Parameters:
      newTimeout - The new invocation timeout (in milliseconds).
      Returns:
      The proxy with the new timeout.

    • ice_invocationTimeout

      MetricsAdminPrx ice_invocationTimeout(Duration newTimeout)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for the invocation timeout.
      Specified by:
      ice_invocationTimeout in interface ObjectPrx
      Parameters:
      newTimeout - The new invocation timeout.
      Returns:
      The proxy with the new timeout.

    • ice_connectionCached

      MetricsAdminPrx ice_connectionCached(boolean newCache)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for connection caching.
      Specified by:
      ice_connectionCached in interface ObjectPrx
      Parameters:
      newCache - true if the new proxy should cache connections; false otherwise.
      Returns:
      The proxy with the specified caching policy.

    • ice_endpointSelection

      MetricsAdminPrx ice_endpointSelection(EndpointSelectionType newType)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for the endpoint selection policy.
      Specified by:
      ice_endpointSelection in interface ObjectPrx
      Parameters:
      newType - The new endpoint selection policy.
      Returns:
      The proxy with the specified endpoint selection policy.
      See Also:

    • ice_encodingVersion

      MetricsAdminPrx ice_encodingVersion(EncodingVersion e)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
      Specified by:
      ice_encodingVersion in interface ObjectPrx
      Parameters:
      e - The encoding version to use to marshal request parameters.
      Returns:
      The proxy with the specified encoding version.

    • ice_router

      MetricsAdminPrx ice_router(RouterPrx router)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for the router.
      Specified by:
      ice_router in interface ObjectPrx
      Parameters:
      router - The router for the new proxy.
      Returns:
      The proxy with the specified router.

    • ice_locator

      MetricsAdminPrx ice_locator(LocatorPrx locator)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for the locator.
      Specified by:
      ice_locator in interface ObjectPrx
      Parameters:
      locator - The locator for the new proxy.
      Returns:
      The proxy with the specified locator.

    • ice_collocationOptimized

      MetricsAdminPrx ice_collocationOptimized(boolean b)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for collocation optimization.
      Specified by:
      ice_collocationOptimized in interface ObjectPrx
      Parameters:
      b - true if the new proxy enables collocation optimization; false otherwise.
      Returns:
      The proxy with the specified collocation optimization.

    • ice_twoway

      MetricsAdminPrx ice_twoway()
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, but uses twoway invocations.
      Specified by:
      ice_twoway in interface ObjectPrx
      Returns:
      A proxy that uses twoway invocations.

    • ice_oneway

      MetricsAdminPrx ice_oneway()
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, but uses oneway invocations.
      Specified by:
      ice_oneway in interface ObjectPrx
      Returns:
      A proxy that uses oneway invocations.

    • ice_batchOneway

      MetricsAdminPrx ice_batchOneway()
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, but uses batch oneway invocations.
      Specified by:
      ice_batchOneway in interface ObjectPrx
      Returns:
      A proxy that uses batch oneway invocations.

    • ice_datagram

      MetricsAdminPrx ice_datagram()
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, but uses datagram invocations.
      Specified by:
      ice_datagram in interface ObjectPrx
      Returns:
      A proxy that uses datagram invocations.

    • ice_batchDatagram

      MetricsAdminPrx ice_batchDatagram()
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, but uses batch datagram invocations.
      Specified by:
      ice_batchDatagram in interface ObjectPrx
      Returns:
      A proxy that uses batch datagram invocations.

    • ice_compress

      MetricsAdminPrx ice_compress(boolean co)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints.
      Specified by:
      ice_compress in interface ObjectPrx
      Parameters:
      co - true enables compression for the new proxy; false disables compression.
      Returns:
      A proxy with the specified compression setting.

    • ice_connectionId

      MetricsAdminPrx ice_connectionId(String connectionId)
      Description copied from interface: ObjectPrx
      Returns a proxy that is identical to this proxy, except for its connection ID.
      Specified by:
      ice_connectionId in interface ObjectPrx
      Parameters:
      connectionId - The connection ID for the new proxy. An empty string removes the connection ID.
      Returns:
      A proxy with the specified connection ID.

    • ice_fixed

      MetricsAdminPrx ice_fixed(Connection connection)
      Description copied from interface: ObjectPrx
      Creates a new proxy that is identical to this proxy, except it's a fixed proxy bound to the given connection.
      Specified by:
      ice_fixed in interface ObjectPrx
      Parameters:
      connection - The fixed proxy connection.
      Returns:
      A fixed proxy bound to the given connection.

    • ice_staticId

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