adams.flow.webservice
Interface WebServiceClient

All Superinterfaces:
CleanUpHandler, Destroyable, OptionHandler
All Known Subinterfaces:
WebServiceClientConsumer<T>, WebServiceClientProducer<T>
All Known Implementing Classes:
AbstractWebServiceClientSink, AbstractWebServiceClientSinkWithGlobalTransformer, AbstractWebServiceClientSource, AbstractWebServiceClientSourceWithGlobalTransformer, AbstractWebServiceClientTransformer, AbstractWebServiceClientTransformerWithGlobalTransformer, CustomersByName, CustomersByNameGlobalTransformer, UpdateCustomer

public interface WebServiceClient
extends OptionHandler, CleanUpHandler

Interface for classes that use webservices.

Version:
$Revision: 6420 $
Author:
fracpete (fracpete at waikato dot ac dot nz)

Method Summary
 int getConnectionTimeout()
          Returns the timeout for the http connection in msec.
 AbstractActor getOwner()
          Returns the owning actor.
 int getReceiveTimeout()
          Returns the timeout for receiving in msec.
 void query()
          Queries the webservice.
 void setConnectionTimeout(int value)
          Sets the timeout for the http connection in msec.
 void setOwner(AbstractActor value)
          Sets the actor that executes this webservice.
 void setReceiveTimeout(int value)
          Sets the timeout for receiving in msec.
 
Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, defineOptions, getOptionManager
 
Methods inherited from interface adams.core.Destroyable
destroy
 
Methods inherited from interface adams.core.CleanUpHandler
cleanUp
 

Method Detail

setOwner

void setOwner(AbstractActor value)
Sets the actor that executes this webservice.

Parameters:
value - the owner

getOwner

AbstractActor getOwner()
Returns the owning actor.

Returns:
the owner

setConnectionTimeout

void setConnectionTimeout(int value)
Sets the timeout for the http connection in msec.

Parameters:
value - the timeout in msec, 0 is infinite

getConnectionTimeout

int getConnectionTimeout()
Returns the timeout for the http connection in msec.

Returns:
the timeout in msec, 0 is infinite

setReceiveTimeout

void setReceiveTimeout(int value)
Sets the timeout for receiving in msec.

Parameters:
value - the timeout in msec, 0 is infinite

getReceiveTimeout

int getReceiveTimeout()
Returns the timeout for receiving in msec.

Returns:
the timeout in msec, 0 is infinite

query

void query()
           throws Exception
Queries the webservice.

Throws:
Exception - if accessing webservice fails for some reason


Copyright © 2013 University of Waikato, Hamilton, NZ. All Rights Reserved.