org.apache.muse.ws.resource.properties.get.impl
Class SimpleGetCapability

java.lang.Object
  extended by org.apache.muse.core.AbstractCapability
      extended by org.apache.muse.ws.resource.impl.AbstractWsResourceCapability
          extended by org.apache.muse.ws.resource.properties.get.impl.SimpleGetCapability
All Implemented Interfaces:
Capability, Initialization, InitializationParameters, Shutdown, GetCapability, GetMultipleResourceProperties, GetResourceProperty, GetResourcePropertyDocument, WsResourceCapability

public class SimpleGetCapability
extends AbstractWsResourceCapability
implements GetCapability

SimpleGetCapability is Muse's default implementation of the WS-RP 'get' operations - the implementation simply forwards these requests to the equivalent methods in ResourcePropertyCollection.

Author:
Dan Jemiolo (danj)

Constructor Summary
SimpleGetCapability()
           
 
Method Summary
protected  MessageHandler createGetDocumentHandler()
           
protected  MessageHandler createGetHandler()
           
protected  MessageHandler createGetMultipleHandler()
           
 void deleteProperty(QName property)
           
 Element[] getMultipleResourceProperties(QName[] qnames)
          Returns zero or more instances of the given properties.
 Element[] getProperty(QName property)
           
 QName[] getPropertyNames()
          Concrete capability classes that define properties MUST override this method and provide the names of the properties.
 Element[] getResourceProperty(QName qname)
          Returns zero or more instances of the given property.
 Element getResourcePropertyDocument()
           
 void initialize()
          

AbstractWsResourceCapability continues the initialization process by inspecting the concrete class to find all of the getters (and, if applicable, setters) for its resource properties.
 void insertProperty(QName property, Element[] values)
           
 void updateProperty(QName property, Element[] values)
           
 
Methods inherited from class org.apache.muse.ws.resource.impl.AbstractWsResourceCapability
createGettersAndSetters, deleteProperty, getGetter, getProperty, getPropertyElements, getPropertyNames, getSetter, getWsResource, insertProperty, invokeMethod, setResource, updateProperty
 
Methods inherited from class org.apache.muse.core.AbstractCapability
getActions, getCapabilityURI, getEnvironment, getInitializationParameter, getInitializationParameters, getLog, getMessageHandler, getPersistence, getResource, hasBeenInitialized, hasBeenShutdown, initializeCompleted, prepareShutdown, setCapabilityURI, setEnvironment, setInitializationParameters, setLog, setMessageHandler, setMessageHandlers, setPersistence, shutdown
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
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
 
Methods inherited from interface org.apache.muse.core.InitializationParameters
getInitializationParameter, getInitializationParameters, setInitializationParameters
 
Methods inherited from interface org.apache.muse.core.Shutdown
hasBeenShutdown, shutdown
 

Constructor Detail

SimpleGetCapability

public SimpleGetCapability()
Method Detail

createGetDocumentHandler

protected MessageHandler createGetDocumentHandler()

createGetHandler

protected MessageHandler createGetHandler()

createGetMultipleHandler

protected MessageHandler createGetMultipleHandler()

getMultipleResourceProperties

public Element[] getMultipleResourceProperties(QName[] qnames)
                                        throws InvalidResourcePropertyQNameFault,
                                               BaseFault
Description copied from interface: GetMultipleResourceProperties
Returns zero or more instances of the given properties.

Specified by:
getMultipleResourceProperties in interface GetMultipleResourceProperties
Parameters:
qnames - The names of the properties to find.
Returns:
An array of DOM Elements, where each Element is an instance of one of the properties named. The Elements will be ordered such that all properties with the same name are grouped together, with Group #1 = QName #1, Group #2 = QName #2, etc. There is no guarantee that the Elements are the internal data structures used by the WS-RP document.
Throws:
BaseFault -
  • If one of the properties is undefined in the document's schema. This is not the same as finding zero instances of a defined property.
InvalidResourcePropertyQNameFault

getResourceProperty

public Element[] getResourceProperty(QName qname)
                              throws InvalidResourcePropertyQNameFault,
                                     BaseFault
Description copied from interface: GetResourceProperty
Returns zero or more instances of the given property.

Specified by:
getResourceProperty in interface GetResourceProperty
Parameters:
qname - The name of the property to find.
Returns:
An array of DOM Elements, where each Element is an instance of the property named. There is no guarantee that the Elements are the internal data structures used by the WS-RP document.
Throws:
InvalidResourcePropertyQNameFault -
  • If the property is undefined in the document's schema. This is not the same as finding zero instances of a defined property.
BaseFault

getResourcePropertyDocument

public Element getResourcePropertyDocument()
                                    throws BaseFault
Specified by:
getResourcePropertyDocument in interface GetResourcePropertyDocument
Returns:
The resource's entire WS-RP document, with the most up-to-date values of all properties.
Throws:
BaseFault

initialize

public void initialize()
                throws SoapFault
Description copied from class: AbstractWsResourceCapability


AbstractWsResourceCapability continues the initialization process by inspecting the concrete class to find all of the getters (and, if applicable, setters) for its resource properties. It then registers itself with the resource's WSRP collection so that read and write requests for its properties are delegated to it.

Specified by:
initialize in interface Initialization
Overrides:
initialize in class AbstractWsResourceCapability
Throws:
SoapFault

deleteProperty

public void deleteProperty(QName property)
                    throws BaseFault
Throws:
BaseFault

getProperty

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

getPropertyNames

public 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

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

updateProperty

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


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