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

All Superinterfaces:
Capability, Initialization, InitializationParameters, ManageabilityCapability, Shutdown, WsResourceCapability
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
 void deleteProperty(QName property)
           
 Date getCurrentTime()
           
 Metric getMetric(QName propertyQName)
           
 Element[] getProperty(QName property)
           
 QName[] getPropertyNames()
          Concrete capability classes that define properties MUST override this method and provide the names of the properties.
 void insertProperty(QName property, Element[] values)
           
 void updateProperty(QName property, Element[] values)
           
 
Methods inherited from interface org.apache.muse.ws.resource.WsResourceCapability
getWsResource
 
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

static final QName[] PROPERTIES
Method Detail

getCurrentTime

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

getMetric

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.

deleteProperty

void deleteProperty(QName property)
                    throws BaseFault
Throws:
BaseFault

getProperty

Element[] getProperty(QName property)
                      throws BaseFault
Throws:
BaseFault

getPropertyNames

QName[] getPropertyNames()
Concrete capability classes that define properties MUST override this method and provide the names of the properties.

Returns:
The names of the resource properties defined by this capability.

insertProperty

void insertProperty(QName property,
                    Element[] values)
                    throws BaseFault
Throws:
BaseFault

updateProperty

void updateProperty(QName property,
                    Element[] values)
                    throws BaseFault
Throws:
BaseFault


Copyright © 2005-2011 Apache Web Services - Muse. All Rights Reserved.