org.apache.muse.ws.dm.muws
Interface Metric
- All Known Implementing Classes:
- SimpleMetric
public interface Metric
Metric is an interface that describes the metadata surrounding resource
properties that are metrics, as defined by the WSDM Metrics capability.
It does not represent the Metrics capability itself - that is handled by
the Metrics interface. Implementations of this type
can be used to store and update the metadata about a metric property as
read and write operations are performed against it.
- Author:
- Dan Jemiolo (danj)
COUNTER
static final int COUNTER
- See Also:
- Constant Field Values
GAUGE
static final int GAUGE
- See Also:
- Constant Field Values
UNKNOWN
static final int UNKNOWN
- See Also:
- Constant Field Values
INTERVAL
static final int INTERVAL
- See Also:
- Constant Field Values
POINT_IN_TIME
static final int POINT_IN_TIME
- See Also:
- Constant Field Values
SINCE_RESET
static final int SINCE_RESET
- See Also:
- Constant Field Values
ON_CHANGE
static final int ON_CHANGE
- See Also:
- Constant Field Values
ON_DEMAND
static final int ON_DEMAND
- See Also:
- Constant Field Values
PERIODIC
static final int PERIODIC
- See Also:
- Constant Field Values
getDuration
String getDuration()
getGroup
String getGroup()
getInterval
long getInterval()
getIntervalString
String getIntervalString()
getLastUpdated
Date getLastUpdated()
getName
QName getName()
- Returns:
- The name of the resource property that this metric represents.
getResetAt
Date getResetAt()
getWsResource
WsResource getWsResource()
- Returns:
- The resource instance that contains the resource property that
this metric represents.
hasBeenReset
boolean hasBeenReset()
- Returns:
- True if no calls to update() have been made since the last
call to reset().
isCounter
boolean isCounter()
isGauge
boolean isGauge()
isInterval
boolean isInterval()
isOnChange
boolean isOnChange()
isOnDemand
boolean isOnDemand()
isPeriodic
boolean isPeriodic()
isPointInTime
boolean isPointInTime()
isSinceReset
boolean isSinceReset()
reset
void reset(Object value)
throws BaseFault
- Updates the resource property via WSRP and then adjusts the metric
metadata to reflect the change.
- Parameters:
value
- The value to be provided to the WSRP implementation when updating
the resource property.
- Throws:
BaseFault
update
void update()
- Notifies the metric metadata container that an update to the resource
property occurred, so it should adjust the metadata values to reflect
this change.
Copyright © 2005-2011 Apache Web Services - Muse. All Rights Reserved.