IceMX

Class _MetricsAdminDisp

java.lang.Object

Ice.ObjectImpl

IceMX._MetricsAdminDisp

All Implemented Interfaces:

Object, _MetricsAdminOperations, _MetricsAdminOperationsNC, MetricsAdmin, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

MetricsAdminI

public abstract class _MetricsAdminDisp
extends ObjectImpl
implements MetricsAdmin

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.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	__ids
static long	serialVersionUID

Fields inherited from interface IceMX.MetricsAdmin

ice_staticId

Constructor Summary

Constructors

Constructor and Description
_MetricsAdminDisp()

Method Summary

Modifier and Type	Method and Description
static DispatchStatus	___disableMetricsView(MetricsAdmin __obj, Incoming __inS, Current __current)
static DispatchStatus	___enableMetricsView(MetricsAdmin __obj, Incoming __inS, Current __current)
static DispatchStatus	___getMapMetricsFailures(MetricsAdmin __obj, Incoming __inS, Current __current)
static DispatchStatus	___getMetricsFailures(MetricsAdmin __obj, Incoming __inS, Current __current)
static DispatchStatus	___getMetricsView(MetricsAdmin __obj, Incoming __inS, Current __current)
static DispatchStatus	___getMetricsViewNames(MetricsAdmin __obj, Incoming __inS, Current __current)
DispatchStatus	__dispatch(Incoming in, Current __current)
protected void	__readImpl(BasicStream __is)
protected void	__writeImpl(BasicStream __os)
void	disableMetricsView(java.lang.String name) Disable a metrics view.
void	enableMetricsView(java.lang.String name) Enables a metrics view.
MetricsFailures[]	getMapMetricsFailures(java.lang.String view, java.lang.String map) Get the metrics failures associated with the given view and map.
MetricsFailures	getMetricsFailures(java.lang.String view, java.lang.String map, java.lang.String id) Get the metrics failure associated for the given metrics.
java.util.Map<java.lang.String,Metrics[]>	getMetricsView(java.lang.String view, LongHolder timestamp) Get the metrics objects for the given metrics view.
java.lang.String[]	getMetricsViewNames(StringSeqHolder disabledViews) Get the names of enabled and disabled metrics.
protected void	ice_copyStateFrom(Object __obj)
java.lang.String	ice_id() Returns the Slice type ID of the most-derived interface supported by this object.
java.lang.String	ice_id(Current __current) Returns the Slice type ID of the most-derived interface supported by this object.
java.lang.String[]	ice_ids() Returns the Slice type IDs of the interfaces supported by this object.
java.lang.String[]	ice_ids(Current __current) Returns the Slice type IDs of the interfaces supported by this object.
boolean	ice_isA(java.lang.String s) Tests whether this object supports a specific Slice interface.
boolean	ice_isA(java.lang.String s, Current __current) Tests whether this object supports a specific Slice interface.
static java.lang.String	ice_staticId()

Methods inherited from class Ice.ObjectImpl

___ice_id, ___ice_ids, ___ice_isA, ___ice_ping, __checkMode, __read, __read, __readImpl, __write, __write, __writeImpl, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Ice.Object

__read, __read, __write, __write, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Methods inherited from interface IceMX._MetricsAdminOperations

disableMetricsView, enableMetricsView, getMapMetricsFailures, getMetricsFailures, getMetricsView, getMetricsViewNames

Field Detail

__ids

public static final java.lang.String[] __ids

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

_MetricsAdminDisp

public _MetricsAdminDisp()

Method Detail

ice_copyStateFrom

protected void ice_copyStateFrom(Object __obj)
                          throws java.lang.CloneNotSupportedException

Throws:

java.lang.CloneNotSupportedException

ice_isA

public boolean ice_isA(java.lang.String s)

Description copied from class: ObjectImpl

Tests whether this object supports a specific Slice interface.

Specified by:

ice_isA in interface Object

Overrides:

ice_isA in class ObjectImpl

Parameters:

s - The type ID of the Slice interface to test against.

Returns:

The return value is true if s is ::Ice::Object.

ice_isA

public boolean ice_isA(java.lang.String s,
                       Current __current)

Description copied from class: ObjectImpl

Tests whether this object supports a specific Slice interface.

Specified by:

ice_isA in interface Object

Overrides:

ice_isA in class ObjectImpl

Parameters:

s - The type ID of the Slice interface to test against.

__current - The current object for the invocation.

Returns:

The return value is true if s is ::Ice::Object.

ice_ids

public java.lang.String[] ice_ids()

Description copied from class: ObjectImpl

Returns the Slice type IDs of the interfaces supported by this object.

Specified by:

ice_ids in interface Object

Overrides:

ice_ids in class ObjectImpl

Returns:

An array whose only element is ::Ice::Object.

ice_ids

public java.lang.String[] ice_ids(Current __current)

Description copied from class: ObjectImpl

Returns the Slice type IDs of the interfaces supported by this object.

Specified by:

ice_ids in interface Object

Overrides:

ice_ids in class ObjectImpl

Parameters:

__current - The current object for the invocation.

Returns:

An array whose only element is ::Ice::Object.

ice_id

public java.lang.String ice_id()

Description copied from class: ObjectImpl

Returns the Slice type ID of the most-derived interface supported by this object.

Specified by:

ice_id in interface Object

Overrides:

ice_id in class ObjectImpl

Returns:

The return value is always ::Ice::Object.

ice_id

public java.lang.String ice_id(Current __current)

Description copied from class: ObjectImpl

Returns the Slice type ID of the most-derived interface supported by this object.

Specified by:

ice_id in interface Object

Overrides:

ice_id in class ObjectImpl

Parameters:

__current - The current object for the invocation.

Returns:

A Slice type ID.

ice_staticId

public static java.lang.String ice_staticId()

disableMetricsView

public final void disableMetricsView(java.lang.String name)
                              throws UnknownMetricsView

Disable a metrics view.

Specified by:

disableMetricsView in interface _MetricsAdminOperationsNC

Parameters:

name - The metrics view name.

Throws:

UnknownMetricsView - Raised if the metrics view cannot be found.

enableMetricsView

public final void enableMetricsView(java.lang.String name)
                             throws UnknownMetricsView

Enables a metrics view.

Specified by:

enableMetricsView in interface _MetricsAdminOperationsNC

Parameters:

name - The metrics view name.

Throws:

UnknownMetricsView - Raised if the metrics view cannot be found.

getMapMetricsFailures

public final MetricsFailures[] getMapMetricsFailures(java.lang.String view,
                                                     java.lang.String map)
                                              throws UnknownMetricsView

Get the metrics failures associated with the given view and map.

Specified by:

getMapMetricsFailures in interface _MetricsAdminOperationsNC

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.

getMetricsFailures

public final MetricsFailures getMetricsFailures(java.lang.String view,
                                                java.lang.String map,
                                                java.lang.String id)
                                         throws UnknownMetricsView

Get the metrics failure associated for the given metrics.

Specified by:

getMetricsFailures in interface _MetricsAdminOperationsNC

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.

getMetricsView

public final java.util.Map<java.lang.String,Metrics[]> getMetricsView(java.lang.String view,
                                                                      LongHolder timestamp)
                                                               throws UnknownMetricsView

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.

Specified by:

getMetricsView in interface _MetricsAdminOperationsNC

Parameters:

view - The name of the metrics view.

timestamp - The local time of the process when the metrics object were retrieved.

Returns:

The metrics view data.

Throws:

UnknownMetricsView - Raised if the metrics view cannot be found.

getMetricsViewNames

public final java.lang.String[] getMetricsViewNames(StringSeqHolder disabledViews)

Get the names of enabled and disabled metrics.

Specified by:

getMetricsViewNames in interface _MetricsAdminOperationsNC

Parameters:

disabledViews - The names of the disabled views.

Returns:

The name of the enabled views.

___getMetricsViewNames

public static DispatchStatus ___getMetricsViewNames(MetricsAdmin __obj,
                                                    Incoming __inS,
                                                    Current __current)

___enableMetricsView

public static DispatchStatus ___enableMetricsView(MetricsAdmin __obj,
                                                  Incoming __inS,
                                                  Current __current)

___disableMetricsView

public static DispatchStatus ___disableMetricsView(MetricsAdmin __obj,
                                                   Incoming __inS,
                                                   Current __current)

___getMetricsView

public static DispatchStatus ___getMetricsView(MetricsAdmin __obj,
                                               Incoming __inS,
                                               Current __current)

___getMapMetricsFailures

public static DispatchStatus ___getMapMetricsFailures(MetricsAdmin __obj,
                                                      Incoming __inS,
                                                      Current __current)

___getMetricsFailures

public static DispatchStatus ___getMetricsFailures(MetricsAdmin __obj,
                                                   Incoming __inS,
                                                   Current __current)

__dispatch

public DispatchStatus __dispatch(Incoming in,
                                 Current __current)

Specified by:

__dispatch in interface Object

Overrides:

__dispatch in class ObjectImpl

__writeImpl

protected void __writeImpl(BasicStream __os)

Overrides:

__writeImpl in class ObjectImpl

__readImpl

protected void __readImpl(BasicStream __is)

Overrides:

__readImpl in class ObjectImpl