org.apache.muse.ws.resource
Interface WsResourceCapability

All Superinterfaces:
Capability, Initialization, InitializationParameters, Shutdown
All Known Subinterfaces:
Configuration, CorrelatableProperties, Description, Entry, GetCapability, Identity, ImmediateTermination, ManageabilityCapability, ManageabilityCharacteristics, Metrics, NotificationProducer, OperationalStatus, PullPointCreation, QueryCapability, RelationshipResource, Relationships, ScheduledTermination, ServiceGroup, ServiceGroupRegistration, SetCapability, State, SubscriptionManager
All Known Implementing Classes:
AbstractManageabilityCapability, AbstractWsResourceCapability, SimpleConfiguration, SimpleCorrelatableProperties, SimpleDescription, SimpleEntry, SimpleGetCapability, SimpleIdentity, SimpleImmediateTermination, SimpleManageabilityCharacteristics, SimpleMetrics, SimpleNotificationProducer, SimpleOperationalStatus, SimplePullPoint, SimplePullPointCreation, SimpleQueryCapability, SimpleRelationshipResource, SimpleRelationships, SimpleScheduledTermination, SimpleServiceGroup, SimpleServiceGroupRegistration, SimpleSetCapability, SimpleState, SimpleSubscriptionManager

public interface WsResourceCapability
extends Capability

WsResourceCapability is an extension of the core Muse Capability concept. It provides a safely-typed convenience method for accessing the WS-resource that contains the capability as well as generic, WSRP-like methods for accessing its property values. A WsResourceCapability is responsible for its own state - the WSRP ResourcePropertyCollection will use these capabilities as delegates for reading and writing property values. This allows the WS-resource capabilities to leverage different state models within a single resource type.

Author:
Dan Jemiolo (danj)

Method Summary
 void deleteProperty(QName property)
           
 Element[] getProperty(QName property)
           
 QName[] getPropertyNames()
          Concrete capability classes that define properties MUST override this method and provide the names of the properties.
 WsResource getWsResource()
           
 void insertProperty(QName property, Element[] values)
           
 void updateProperty(QName property, Element[] values)
           
 
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
 

Method Detail

getWsResource

WsResource getWsResource()
Returns:
The same as getResource(), cast to the WsResource type.

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.