org.apache.muse.ws.dm.muws
Interface Metrics

All Superinterfaces:
Capability, Initialization, InitializationParameters, ManageabilityCapability, Shutdown, WsResourceCapability, org.apache.muse.ws.resource.WsResourceCapabilityProperties
All Known Implementing Classes:
SimpleMetrics

public interface Metrics
extends ManageabilityCapability

Metrics is an interface that represents the WSDM Metrics capability. It provides access to the one Metrics property (muws2:CurrentTime) along with methods for reading and modifying metrics based on existing properties. Implementations of this capability may provide varying levels of support for the initialization of updating of metric metadata.

Author:
Dan Jemiolo (danj)

Field Summary
static QName[] PROPERTIES
           
 
Method Summary
 java.util.Date getCurrentTime()
           
 Metric getMetric(QName propertyQName)
           
 
Methods inherited from interface org.apache.muse.ws.resource.WsResourceCapability
deleteProperty, getProperty, getPropertyNames, getWsResource, insertProperty, updateProperty
 
Methods inherited from interface org.apache.muse.core.Capability
getActions, getCapabilityURI, getEnvironment, getLog, getMessageHandler, getPersistence, getResource, initializeCompleted, prepareShutdown, setCapabilityURI, setEnvironment, setLog, setMessageHandlers, setPersistence, setResource
 
Methods inherited from interface org.apache.muse.core.Initialization
hasBeenInitialized, initialize
 
Methods inherited from interface org.apache.muse.core.InitializationParameters
getInitializationParameter, getInitializationParameters, setInitializationParameters
 
Methods inherited from interface org.apache.muse.core.Shutdown
hasBeenShutdown, shutdown
 

Field Detail

PROPERTIES

public static final QName[] PROPERTIES
Method Detail

getCurrentTime

public java.util.Date getCurrentTime()
                              throws BaseFault
Returns:
The current time, according to the resource or its manager.
Throws:
BaseFault

getMetric

public Metric getMetric(QName propertyQName)
Parameters:
propertyQName - The name of the property that is also defined as a metric.
Returns:
The collection of metric metadata for the property, or null if the property does not exist.