Package com.zeroc.IceMX
Interface MetricsAdminPrx
- All Superinterfaces:
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.
-
Field Summary
Fields inherited from interface com.zeroc.Ice.ObjectPrx
ice_staticId, noExplicitContext
-
Method Summary
Modifier and TypeMethodDescriptionstatic MetricsAdminPrx
checkedCast
(ObjectPrx obj) Contacts the remote server to verify that the object implements this type.static MetricsAdminPrx
checkedCast
(ObjectPrx obj, String facet) Contacts the remote server to verify that a facet of the object implements this type.static MetricsAdminPrx
Contacts the remote server to verify that a facet of the object implements this type.static MetricsAdminPrx
checkedCast
(ObjectPrx obj, Map<String, String> context) Contacts the remote server to verify that the object implements this type.default void
disableMetricsView
(String name) Disable a metrics view.default void
disableMetricsView
(String name, Map<String, String> context) Disable a metrics view.default CompletableFuture<Void>
Disable a metrics view.default CompletableFuture<Void>
disableMetricsViewAsync
(String name, Map<String, String> context) Disable a metrics view.default void
enableMetricsView
(String name) Enables a metrics view.default void
enableMetricsView
(String name, Map<String, String> context) Enables a metrics view.default CompletableFuture<Void>
enableMetricsViewAsync
(String name) Enables a metrics view.default CompletableFuture<Void>
enableMetricsViewAsync
(String name, Map<String, String> context) Enables a metrics view.default MetricsFailures[]
getMapMetricsFailures
(String view, String map) Get the metrics failures associated with the given view and map.default MetricsFailures[]
Get the metrics failures associated with the given view and map.default CompletableFuture<MetricsFailures[]>
getMapMetricsFailuresAsync
(String view, String map) Get the metrics failures associated with the given view and map.default CompletableFuture<MetricsFailures[]>
Get the metrics failures associated with the given view and map.default MetricsFailures
getMetricsFailures
(String view, String map, String id) Get the metrics failure associated for the given metrics.default MetricsFailures
Get the metrics failure associated for the given metrics.default CompletableFuture<MetricsFailures>
getMetricsFailuresAsync
(String view, String map, String id) Get the metrics failure associated for the given metrics.default CompletableFuture<MetricsFailures>
Get the metrics failure associated for the given metrics.getMetricsView
(String view) Get the metrics objects for the given metrics view.getMetricsView
(String view, Map<String, String> context) Get the metrics objects for the given metrics view.getMetricsViewAsync
(String view) Get the metrics objects for the given metrics view.getMetricsViewAsync
(String view, Map<String, String> context) Get the metrics objects for the given metrics view.Get the names of enabled and disabled metrics.getMetricsViewNames
(Map<String, String> context) Get the names of enabled and disabled metrics.Get the names of enabled and disabled metrics.getMetricsViewNamesAsync
(Map<String, String> context) Get the names of enabled and disabled metrics.default MetricsAdminPrx
ice_adapterId
(String newAdapterId) Returns a proxy that is identical to this proxy, except for the adapter ID.default MetricsAdminPrx
Returns a proxy that is identical to this proxy, but uses batch datagram invocations.default MetricsAdminPrx
Returns a proxy that is identical to this proxy, but uses batch oneway invocations.default MetricsAdminPrx
ice_collocationOptimized
(boolean b) Returns a proxy that is identical to this proxy, except for collocation optimization.default MetricsAdminPrx
ice_compress
(boolean co) Returns a proxy that is identical to this proxy, except for compression.default MetricsAdminPrx
ice_connectionCached
(boolean newCache) Returns a proxy that is identical to this proxy, except for connection caching.default MetricsAdminPrx
ice_connectionId
(String connectionId) Returns a proxy that is identical to this proxy, except for its connection ID.default MetricsAdminPrx
ice_context
(Map<String, String> newContext) Returns a proxy that is identical to this proxy, except for the per-proxy context.default MetricsAdminPrx
Returns a proxy that is identical to this proxy, but uses datagram invocations.default MetricsAdminPrx
Returns a proxy that is identical to this proxy, except for the encoding used to marshal parameters.default MetricsAdminPrx
ice_endpoints
(Endpoint[] newEndpoints) Returns a proxy that is identical to this proxy, except for the endpoints.default MetricsAdminPrx
Returns a proxy that is identical to this proxy, except for the endpoint selection policy.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.default MetricsAdminPrx
ice_invocationTimeout
(int newTimeout) Returns a proxy that is identical to this proxy, except for the invocation timeout.default MetricsAdminPrx
ice_locator
(LocatorPrx locator) Returns a proxy that is identical to this proxy, except for the locator.default MetricsAdminPrx
ice_locatorCacheTimeout
(int newTimeout) Returns a proxy that is identical to this proxy, except for the locator cache timeout.default MetricsAdminPrx
Returns a proxy that is identical to this proxy, but uses oneway invocations.default MetricsAdminPrx
ice_preferSecure
(boolean b) Returns a proxy that is identical to this proxy, except for its endpoint selection policy.default MetricsAdminPrx
ice_router
(RouterPrx router) Returns a proxy that is identical to this proxy, except for the router.default MetricsAdminPrx
ice_secure
(boolean b) Returns a proxy that is identical to this proxy, except for how it selects endpoints.static String
Returns the Slice type ID associated with this type.default MetricsAdminPrx
ice_timeout
(int t) Returns a proxy that is identical to this proxy, except for its connection timeout setting.default MetricsAdminPrx
Returns a proxy that is identical to this proxy, but uses twoway invocations.static MetricsAdminPrx
uncheckedCast
(ObjectPrx obj) Downcasts the given proxy to this type without contacting the remote server.static MetricsAdminPrx
uncheckedCast
(ObjectPrx obj, String facet) Downcasts the given proxy to this type without contacting the remote server.Methods inherited from interface com.zeroc.Ice.ObjectPrx
equals, ice_executor, ice_facet, ice_flushBatchRequests, ice_flushBatchRequestsAsync, ice_getAdapterId, ice_getCachedConnection, ice_getCommunicator, ice_getCompress, ice_getConnection, ice_getConnectionAsync, ice_getConnectionId, ice_getContext, ice_getEncodingVersion, ice_getEndpoints, ice_getEndpointSelection, ice_getFacet, ice_getIdentity, ice_getInvocationTimeout, ice_getLocator, ice_getLocatorCacheTimeout, ice_getRouter, ice_getTimeout, ice_id, ice_id, ice_idAsync, ice_idAsync, ice_identity, ice_ids, ice_ids, ice_idsAsync, ice_idsAsync, ice_invoke, ice_invoke, ice_invokeAsync, ice_invokeAsync, ice_isA, ice_isA, ice_isAAsync, ice_isAAsync, ice_isBatchDatagram, ice_isBatchOneway, ice_isCollocationOptimized, ice_isConnectionCached, ice_isDatagram, ice_isFixed, ice_isOneway, ice_isPreferSecure, ice_isSecure, ice_isTwoway, ice_ping, ice_ping, ice_pingAsync, ice_pingAsync
-
Method Details
-
getMetricsViewNames
Get the names of enabled and disabled metrics.- Returns:
- An instance of MetricsAdmin.GetMetricsViewNamesResult.
-
getMetricsViewNames
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
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
Enables a metrics view.- Parameters:
name
- The metrics view name.- Throws:
UnknownMetricsView
- Raised if the metrics view cannot be found.
-
enableMetricsView
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
Enables a metrics view.- Parameters:
name
- The metrics view name.- Returns:
- A future that will be completed when the invocation completes.
-
enableMetricsViewAsync
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
Disable a metrics view.- Parameters:
name
- The metrics view name.- Throws:
UnknownMetricsView
- Raised if the metrics view cannot be found.
-
disableMetricsView
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
Disable a metrics view.- Parameters:
name
- The metrics view name.- Returns:
- A future that will be completed when the invocation completes.
-
disableMetricsViewAsync
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
Get the metrics objects for the given metrics view. This returns a dictionnary 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 UnknownMetricsViewGet the metrics objects for the given metrics view. This returns a dictionnary 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
Get the metrics objects for the given metrics view. This returns a dictionnary 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 dictionnary 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
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 UnknownMetricsViewGet 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
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 UnknownMetricsViewGet 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
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
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
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
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
Downcasts the given proxy to this type without contacting the remote server.- Parameters:
obj
- The untyped proxy.- Returns:
- A proxy for this type.
-
uncheckedCast
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
Returns a proxy that is identical to this proxy, except for the per-proxy context.- Specified by:
ice_context
in interfaceObjectPrx
- Parameters:
newContext
- The context for the new proxy.- Returns:
- A proxy with the specified per-proxy context.
-
ice_adapterId
Returns a proxy that is identical to this proxy, except for the adapter ID.- Specified by:
ice_adapterId
in interfaceObjectPrx
- Parameters:
newAdapterId
- The adapter ID for the new proxy.- Returns:
- A proxy with the specified adapter ID.
-
ice_endpoints
Returns a proxy that is identical to this proxy, except for the endpoints.- Specified by:
ice_endpoints
in interfaceObjectPrx
- Parameters:
newEndpoints
- The endpoints for the new proxy.- Returns:
- A proxy with the specified endpoints.
-
ice_locatorCacheTimeout
Returns a proxy that is identical to this proxy, except for the locator cache timeout.- Specified by:
ice_locatorCacheTimeout
in interfaceObjectPrx
- Parameters:
newTimeout
- The new locator cache timeout (in seconds).- Returns:
- A proxy with the specified locator cache timeout.
- See Also:
-
ice_invocationTimeout
Returns a proxy that is identical to this proxy, except for the invocation timeout.- Specified by:
ice_invocationTimeout
in interfaceObjectPrx
- Parameters:
newTimeout
- The new invocation timeout (in seconds).- Returns:
- A proxy with the specified invocation timeout.
-
ice_connectionCached
Returns a proxy that is identical to this proxy, except for connection caching.- Specified by:
ice_connectionCached
in interfaceObjectPrx
- Parameters:
newCache
-true
if the new proxy should cache connections;false
otherwise.- Returns:
- A proxy with the specified caching policy.
-
ice_endpointSelection
Returns a proxy that is identical to this proxy, except for the endpoint selection policy.- Specified by:
ice_endpointSelection
in interfaceObjectPrx
- Parameters:
newType
- The new endpoint selection policy.- Returns:
- A proxy with the specified endpoint selection policy.
- See Also:
-
ice_secure
Returns a proxy that is identical to this proxy, except for how it selects endpoints.- Specified by:
ice_secure
in interfaceObjectPrx
- Parameters:
b
- Ifb
istrue
, only endpoints that use a secure transport are used by the new proxy. Ifb
is false, the returned proxy uses both secure and insecure endpoints.- Returns:
- A proxy with the specified selection policy.
-
ice_encodingVersion
Returns a proxy that is identical to this proxy, except for the encoding used to marshal parameters.- Specified by:
ice_encodingVersion
in interfaceObjectPrx
- Parameters:
e
- The encoding version to use to marshal request parameters.- Returns:
- A proxy with the specified encoding version.
-
ice_preferSecure
Returns a proxy that is identical to this proxy, except for its endpoint selection policy.- Specified by:
ice_preferSecure
in interfaceObjectPrx
- Parameters:
b
- Ifb
istrue
, the new proxy will use secure endpoints for invocations and only use insecure endpoints if an invocation cannot be made via secure endpoints. Ifb
isfalse
, the proxy prefers insecure endpoints to secure ones.- Returns:
- A proxy with the specified selection policy.
-
ice_router
Returns a proxy that is identical to this proxy, except for the router.- Specified by:
ice_router
in interfaceObjectPrx
- Parameters:
router
- The router for the new proxy.- Returns:
- A proxy with the specified router.
-
ice_locator
Returns a proxy that is identical to this proxy, except for the locator.- Specified by:
ice_locator
in interfaceObjectPrx
- Parameters:
locator
- The locator for the new proxy.- Returns:
- A proxy with the specified locator.
-
ice_collocationOptimized
Returns a proxy that is identical to this proxy, except for collocation optimization.- Specified by:
ice_collocationOptimized
in interfaceObjectPrx
- Parameters:
b
-true
if the new proxy enables collocation optimization;false
otherwise.- Returns:
- A proxy with the specified collocation optimization.
-
ice_twoway
Returns a proxy that is identical to this proxy, but uses twoway invocations.- Specified by:
ice_twoway
in interfaceObjectPrx
- Returns:
- A proxy that uses twoway invocations.
-
ice_oneway
Returns a proxy that is identical to this proxy, but uses oneway invocations.- Specified by:
ice_oneway
in interfaceObjectPrx
- Returns:
- A proxy that uses oneway invocations.
-
ice_batchOneway
Returns a proxy that is identical to this proxy, but uses batch oneway invocations.- Specified by:
ice_batchOneway
in interfaceObjectPrx
- Returns:
- A proxy that uses batch oneway invocations.
-
ice_datagram
Returns a proxy that is identical to this proxy, but uses datagram invocations.- Specified by:
ice_datagram
in interfaceObjectPrx
- Returns:
- A proxy that uses datagram invocations.
-
ice_batchDatagram
Returns a proxy that is identical to this proxy, but uses batch datagram invocations.- Specified by:
ice_batchDatagram
in interfaceObjectPrx
- Returns:
- A proxy that uses batch datagram invocations.
-
ice_compress
Returns a proxy that is identical to this proxy, except for compression.- Specified by:
ice_compress
in interfaceObjectPrx
- Parameters:
co
-true
enables compression for the new proxy;false
disables compression.- Returns:
- A proxy with the specified compression setting.
-
ice_timeout
Returns a proxy that is identical to this proxy, except for its connection timeout setting.- Specified by:
ice_timeout
in interfaceObjectPrx
- Parameters:
t
- The connection timeout for the proxy in milliseconds.- Returns:
- A proxy with the specified timeout.
-
ice_connectionId
Returns a proxy that is identical to this proxy, except for its connection ID.- Specified by:
ice_connectionId
in interfaceObjectPrx
- 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
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. -
ice_staticId
Description copied from interface:ObjectPrx
Returns the Slice type ID associated with this type.- Returns:
- The Slice type ID.
-