org.apache.muse.ws.dm.muws
Interface CorrelatableProperties
- All Superinterfaces:
- Capability, Initialization, InitializationParameters, ManageabilityCapability, Shutdown, WsResourceCapability
- All Known Implementing Classes:
- SimpleCorrelatableProperties
public interface CorrelatableProperties
- extends ManageabilityCapability
This interface represents the WSDM CorrelatableProperties capability.
Concrete implementations must maintain a collection of
correlation expressions which can be evaluated
against any resource for the purposes of equality testing. Each correlation
expression maps to an instance of the MUWS CorrelatableProperties property.
- Author:
- Dan Jemiolo (danj)
Methods inherited from interface org.apache.muse.core.Capability |
getActions, getCapabilityURI, getEnvironment, getLog, getMessageHandler, getPersistence, getResource, initializeCompleted, prepareShutdown, setCapabilityURI, setEnvironment, setLog, setMessageHandlers, setPersistence, setResource |
PROPERTIES
static final QName[] PROPERTIES
addCorrelation
void addCorrelation(Correlation correlation)
throws BaseFault
- Parameters:
correlation
- A new correlation expression that will be recorded in a new
instance of the CorrelatableProperties property.
- Throws:
BaseFault
getCorrelatableProperties
Correlation[] getCorrelatableProperties()
throws BaseFault
- Returns:
- The Correlation expressions defined in the instances of the
CorrelatableProperties property. Each Correlation can be
evaluated against a target Resource, and there is no requirement
that a caller use all Correlations to decide whether two
resources are the same.
- Throws:
BaseFault
matches
boolean matches(EndpointReference epr)
throws SoapFault
- Parameters:
epr
- The EPR of the resource (local or remote) to evaluate the
current correlation expressions against.
- Returns:
- True, if all of the correlation expressions evaluated to
true when run against the given endpoint's resource properties
document.
- Throws:
SoapFault
-
- If there was an error when trying to contact the resource
at the given EPR, or if the endpoint does not support WS-RP.
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.