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 metrics of an application that enabled the Ice administrative facility and configured some metrics views.

  • Method Details

    • getMetricsViewNames

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

    • getMetricsViewNames

      default MetricsAdmin.GetMetricsViewNamesResult getMetricsViewNames(Map<String,String> context)
      Get 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()
      Get 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)
      Get 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 - Raised if 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 - Raised if 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
      Disable a metrics view.
      Parameters:
      name - The metrics view name.
      Throws:
      UnknownMetricsView - Raised if the metrics view cannot be found.

    • disableMetricsView

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

    • disableMetricsViewAsync

      default CompletableFuture<Void> disableMetricsViewAsync(String name)
      Disable 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)
      Disable 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
      Get the metrics objects for the given metrics view. This returns a dictionary of metric maps for each metrics class configured with the view. The timestamp allows the client to compute averages which are not dependent of the invocation latency for this operation.
      Parameters:
      view - The name of the metrics view.
      Returns:
      An instance of MetricsAdmin.GetMetricsViewResult.
      Throws:
      UnknownMetricsView - Raised if the metrics view cannot be found.

    • getMetricsView

      default MetricsAdmin.GetMetricsViewResult getMetricsView(String view, Map<String,String> context) throws UnknownMetricsView
      Get the metrics objects for the given metrics view. This returns a dictionary of metric maps for each metrics class configured with the view. The timestamp allows the client to compute averages which are not dependent of the invocation latency for this operation.
      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 - Raised if the metrics view cannot be found.

    • getMetricsViewAsync

      default CompletableFuture<MetricsAdmin.GetMetricsViewResult> getMetricsViewAsync(String view)
      Get the metrics objects for the given metrics view. This returns a dictionary of metric maps for each metrics class configured with the view. The timestamp allows the client to compute averages which are not dependent of the invocation latency for this operation.
      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)
      Get the metrics objects for the given metrics view. This returns a dictionary of metric maps for each metrics class configured with the view. The timestamp allows the client to compute averages which are not dependent of the invocation latency for this operation.
      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
      Get 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 - Raised if the metrics view cannot be found.

    • getMapMetricsFailures

      default MetricsFailures[] getMapMetricsFailures(String view, String map, Map<String,String> context) throws UnknownMetricsView
      Get 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 - Raised if the metrics view cannot be found.

    • getMapMetricsFailuresAsync

      default CompletableFuture<MetricsFailures[]> getMapMetricsFailuresAsync(String view, String map)
      Get 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)
      Get 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
      Get 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 - Raised if the metrics view cannot be found.

    • getMetricsFailures

      default MetricsFailures getMetricsFailures(String view, String map, String id, Map<String,String> context) throws UnknownMetricsView
      Get 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 - Raised if the metrics view cannot be found.

    • getMetricsFailuresAsync

      default CompletableFuture<MetricsFailures> getMetricsFailuresAsync(String view, String map, String id)
      Get 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)
      Get 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.

    • checkedCast

      static MetricsAdminPrx checkedCast(ObjectPrx obj)
      Contacts the remote server to verify that the object implements this type. Raises a local exception if a communication error occurs.
      Parameters:
      obj - The untyped 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)
      Contacts the remote server to verify that the object implements this type. Raises a local exception if a communication error occurs.
      Parameters:
      obj - The untyped proxy.
      context - The Context map to send with the invocation.
      Returns:
      A proxy for this type, or null if the object does not support this type.

    • checkedCast

      static MetricsAdminPrx checkedCast(ObjectPrx obj, String facet)
      Contacts the remote server to verify that a facet of the object implements this type. Raises a local exception if a communication error occurs.
      Parameters:
      obj - The untyped proxy.
      facet - The name of the desired facet.
      Returns:
      A proxy for this type, or null if the object does not support this type.

    • checkedCast

      static MetricsAdminPrx checkedCast(ObjectPrx obj, String facet, Map<String,String> context)
      Contacts the remote server to verify that a facet of the object implements this type. Raises a local exception if a communication error occurs.
      Parameters:
      obj - The untyped proxy.
      facet - The name of the desired facet.
      context - The Context map to send with the invocation.
      Returns:
      A proxy for this type, or null if the object does not support this type.

    • uncheckedCast

      static MetricsAdminPrx uncheckedCast(ObjectPrx obj)
      Downcasts the given proxy to this type without contacting the remote server.
      Parameters:
      obj - The untyped proxy.
      Returns:
      A proxy for this type.

    • uncheckedCast

      static MetricsAdminPrx uncheckedCast(ObjectPrx obj, String facet)
      Downcasts the given proxy to this type without contacting the remote server.
      Parameters:
      obj - The untyped proxy.
      facet - The name of the desired facet.
      Returns:
      A proxy for this type.

    • ice_context

      default MetricsAdminPrx ice_context(Map<String,String> newContext)
      Returns a 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 specified per-proxy context.

    • ice_adapterId

      default MetricsAdminPrx ice_adapterId(String newAdapterId)
      Returns a 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 specified adapter ID.

    • ice_endpoints

      default MetricsAdminPrx ice_endpoints(Endpoint[] newEndpoints)
      Returns a 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 specified endpoints.

    • ice_locatorCacheTimeout

      default MetricsAdminPrx ice_locatorCacheTimeout(int newTimeout)
      Returns a 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 specified locator cache timeout.
      See Also:

    • ice_invocationTimeout

      default MetricsAdminPrx ice_invocationTimeout(int newTimeout)
      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:
      A proxy with the specified invocation timeout.

    • ice_connectionCached

      default MetricsAdminPrx ice_connectionCached(boolean newCache)
      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:
      A proxy with the specified caching policy.

    • ice_endpointSelection

      default MetricsAdminPrx ice_endpointSelection(EndpointSelectionType newType)
      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:
      A proxy with the specified endpoint selection policy.
      See Also:

    • ice_secure

      default MetricsAdminPrx ice_secure(boolean b)
      Returns a proxy that is identical to this proxy, except for how it selects endpoints.
      Specified by:
      ice_secure in interface ObjectPrx
      Parameters:
      b - If b is true, only endpoints that use a secure transport are used by the new proxy. If b is false, the returned proxy uses both secure and insecure endpoints.
      Returns:
      A proxy with the specified selection policy.

    • ice_encodingVersion

      default MetricsAdminPrx ice_encodingVersion(EncodingVersion e)
      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:
      A proxy with the specified encoding version.

    • ice_preferSecure

      default MetricsAdminPrx ice_preferSecure(boolean b)
      Returns a proxy that is identical to this proxy, except for its endpoint selection policy.
      Specified by:
      ice_preferSecure in interface ObjectPrx
      Parameters:
      b - If b is true, the new proxy will use secure endpoints for invocations and only use insecure endpoints if an invocation cannot be made via secure endpoints. If b is false, the proxy prefers insecure endpoints to secure ones.
      Returns:
      A proxy with the specified selection policy.

    • ice_router

      default MetricsAdminPrx ice_router(RouterPrx router)
      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:
      A proxy with the specified router.

    • ice_locator

      default MetricsAdminPrx ice_locator(LocatorPrx locator)
      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:
      A proxy with the specified locator.

    • ice_collocationOptimized

      default MetricsAdminPrx ice_collocationOptimized(boolean b)
      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:
      A proxy with the specified collocation optimization.

    • ice_twoway

      default MetricsAdminPrx ice_twoway()
      Returns a 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

      default MetricsAdminPrx ice_oneway()
      Returns a 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

      default MetricsAdminPrx ice_batchOneway()
      Returns a 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

      default MetricsAdminPrx ice_datagram()
      Returns a 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

      default MetricsAdminPrx ice_batchDatagram()
      Returns a 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

      default MetricsAdminPrx ice_compress(boolean co)
      Returns a proxy that is identical to this proxy, except for compression.
      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_timeout

      default MetricsAdminPrx ice_timeout(int t)
      Returns a proxy that is identical to this proxy, except for its connection timeout setting.
      Specified by:
      ice_timeout in interface ObjectPrx
      Parameters:
      t - The connection timeout for the proxy in milliseconds.
      Returns:
      A proxy with the specified timeout.

    • ice_connectionId

      default MetricsAdminPrx ice_connectionId(String connectionId)
      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

      default MetricsAdminPrx ice_fixed(Connection connection)
      Returns a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection.@param connection The fixed proxy 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()
      Description copied from interface: ObjectPrx
      Returns the Slice type ID associated with this type.
      Returns:
      The Slice type ID.