RESTClient (adams-addons-pom 24.4.0-SNAPSHOT API)

All Superinterfaces:

adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.ErrorProvider, adams.core.option.OptionHandler

All Known Subinterfaces:

AlternativeUrlSupporter, RESTClientConsumer<T>, RESTClientProducer<T>

All Known Implementing Classes:

AbstractRESTClientSink, AbstractRESTClientSource, AbstractRESTClientTransformer, EchoClientSink, EchoClientSource, EchoClientTransformer
```
public interface RESTClient
extends adams.core.option.OptionHandler, adams.core.CleanUpHandler, adams.core.ErrorProvider
```
Interface for classes that use REST webservices.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`int`	`getConnectionTimeout()`	Returns the timeout for the http connection in msec.
`adams.flow.core.Actor`	`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(adams.flow.core.Actor 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.CleanUpHandler
cleanUp

Methods inherited from interface adams.core.Destroyable
destroy

Methods inherited from interface adams.core.ErrorProvider
getLastError, hasLastError

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, defineOptions, getOptionManager, toCommandLine

- Method Detail
  - setOwner
```
void setOwner(adams.flow.core.Actor value)
```
    Sets the actor that executes this webservice.
    
    Parameters:
    
    value - the owner
  - getOwner
```
adams.flow.core.Actor 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