org.apache.muse.ws.resource.remote
Class WsResourceClient

java.lang.Object
  extended by org.apache.muse.core.AbstractResourceClient
      extended by org.apache.muse.ws.resource.remote.WsResourceClient
All Implemented Interfaces:
Traceable, SoapMonitor
Direct Known Subclasses:
MetricsClient, NotificationConsumerClient, NotificationProducerClient, RelationshipsClient, ServiceGroupClient, SubscriptionClient

public class WsResourceClient
extends AbstractResourceClient

WsResourceClient is a web service client that allows users to invoke standard WSRF operations without writing any XML plumbing code. This class includes all of the operations from WSRF, but this does not mean that all Muse resource types implement all WSRF operations; rather, it is more convenient to have one client class since all WSRF operations are defined as separate capabilities (which would result in one client per operation); if users need more detailed information about what operations are supported by a resource, they can use the WS-MetadataExchange client in combination with the Muse ResourceInspector tool.

Author:
Dan Jemiolo (danj)

Constructor Summary
WsResourceClient(EndpointReference destination)
           
WsResourceClient(EndpointReference destination, EndpointReference source)
           
WsResourceClient(EndpointReference destination, EndpointReference source, Environment environment)
           
WsResourceClient(EndpointReference destination, EndpointReference source, SoapClient soapClient)
           
 
Method Summary
 void deleteResourceProperty(QName qname)
           
 void destroy()
           
 Element[] getMultipleResourceProperties(QName[] qnames)
           
 Object getPropertyAsObject(QName qname, Class type)
          This is a convenience method that calls getResourceProperty() and then parses the XML results into POJOs of the given type using the Muse serializer framework.
 Element[] getResourceProperty(QName qname)
           
 Element getResourcePropertyDocument()
           
 void insertResourceProperty(QName qname, Object[] values)
           
 Element putResourcePropertyDocument(Element wsrpDoc)
           
 Node[] queryResourceProperties(String query, String dialect)
           
 void setResourceProperties(SetRequest request)
           
 Date setTerminationTime(Date time)
           
 void updateResourceProperty(QName qname, Object[] values)
           
 
Methods inherited from class org.apache.muse.core.AbstractResourceClient
getDestination, getEndpointReference, getSoapClient, getSoapMonitorPort, getSource, getTraceWriter, invoke, invoke, invoke, invoke, isUsingSoapMonitor, isUsingTrace, setTrace, setTraceWriter, startSoapMonitor, stopSoapMonitor
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WsResourceClient

public WsResourceClient(EndpointReference destination)

WsResourceClient

public WsResourceClient(EndpointReference destination,
                        EndpointReference source)

WsResourceClient

public WsResourceClient(EndpointReference destination,
                        EndpointReference source,
                        Environment environment)

WsResourceClient

public WsResourceClient(EndpointReference destination,
                        EndpointReference source,
                        SoapClient soapClient)
Method Detail

deleteResourceProperty

public void deleteResourceProperty(QName qname)
                            throws SoapFault
Throws:
SoapFault

destroy

public void destroy()
             throws SoapFault
Throws:
SoapFault

getMultipleResourceProperties

public Element[] getMultipleResourceProperties(QName[] qnames)
                                        throws SoapFault
Throws:
SoapFault

getPropertyAsObject

public Object getPropertyAsObject(QName qname,
                                  Class type)
                           throws SoapFault
This is a convenience method that calls getResourceProperty() and then parses the XML results into POJOs of the given type using the Muse serializer framework.

Throws:
SoapFault

getResourceProperty

public Element[] getResourceProperty(QName qname)
                              throws SoapFault
Throws:
SoapFault

getResourcePropertyDocument

public Element getResourcePropertyDocument()
                                    throws SoapFault
Throws:
SoapFault

insertResourceProperty

public void insertResourceProperty(QName qname,
                                   Object[] values)
                            throws SoapFault
Throws:
SoapFault

putResourcePropertyDocument

public Element putResourcePropertyDocument(Element wsrpDoc)
                                    throws SoapFault
Throws:
SoapFault

queryResourceProperties

public Node[] queryResourceProperties(String query,
                                      String dialect)
                               throws SoapFault
Throws:
SoapFault

setResourceProperties

public void setResourceProperties(SetRequest request)
                           throws SoapFault
Throws:
SoapFault

setTerminationTime

public Date setTerminationTime(Date time)
                        throws SoapFault
Throws:
SoapFault

updateResourceProperty

public void updateResourceProperty(QName qname,
                                   Object[] values)
                            throws SoapFault
Throws:
SoapFault


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