org.restlet
Class Client

java.lang.Object
  extended by org.restlet.Restlet
      extended by org.restlet.Connector
          extended by org.restlet.Client
All Implemented Interfaces:
Uniform

public class Client
extends Connector

Connector acting as a generic client. It internally uses one of the available connector helpers registered with the Restlet engine.

Concurrency note: instances of this class or its subclasses can be invoked by several threads at the same time and therefore must be thread-safe. You should be especially careful when storing state in member variables.

For advanced cases, it is possible to obtained the wrapped RestletHelper instance that is used by this client to handle the calls via the "org.restlet.engine.helper" attribute stored in the Context object.

Author:
Jerome Louvel

Constructor Summary
Client(Context context, List<Protocol> protocols)
          Constructor.
Client(Context context, List<Protocol> protocols, String helperClass)
          Constructor.
Client(Context context, Protocol protocol)
          Constructor.
Client(List<Protocol> protocols)
          Constructor.
Client(Protocol protocol)
          Constructor.
Client(String protocolName)
          Constructor.
 
Method Summary
 int getConnectTimeout()
          Deprecated. Use the equivalent "socketConnectTimeoutMs" connector parameter.
 void handle(Request request, Response response)
          Handles a call.
 boolean isAvailable()
          Indicates the underlying connector helper is available.
 void setConnectTimeout(int connectTimeout)
          Deprecated. Use the equivalent connector parameters.
 void start()
          Starts the Restlet.
 void stop()
          Stops the Restlet.
 
Methods inherited from class org.restlet.Connector
getProtocols, setProtocols
 
Methods inherited from class org.restlet.Restlet
createFinder, finalize, getApplication, getAuthor, getContext, getDescription, getFinderClass, getLogger, getName, getOwner, handle, handle, handle, isStarted, isStopped, setAuthor, setContext, setDescription, setFinderClass, setName, setOwner
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Client

public Client(Context context,
              List<Protocol> protocols)
Constructor.

Parameters:
context - The context.
protocols - The connector protocols.

Client

public Client(Context context,
              List<Protocol> protocols,
              String helperClass)
Constructor.

Parameters:
context - The context.
protocols - The connector protocols.
helperClass - Optional helper class name.

Client

public Client(Context context,
              Protocol protocol)
Constructor.

Parameters:
context - The context.
protocol - The connector protocol.

Client

public Client(List<Protocol> protocols)
Constructor.

Parameters:
protocols - The connector protocols.

Client

public Client(Protocol protocol)
Constructor.

Parameters:
protocol - The connector protocol.

Client

public Client(String protocolName)
Constructor.

Parameters:
protocolName - The connector protocol.
Method Detail

getConnectTimeout

@Deprecated
public int getConnectTimeout()
Deprecated. Use the equivalent "socketConnectTimeoutMs" connector parameter.

Returns the connection timeout in milliseconds. The default value is 0, meaning an infinite timeout.

Returns:
The connection timeout.

handle

public void handle(Request request,
                   Response response)
Description copied from class: Restlet
Handles a call. The default behavior is to initialize the Restlet by setting the current context using the Context.setCurrent(Context) method and by attempting to start it, unless it was already started. If an exception is thrown during the start action, then the response status is set to Status.SERVER_ERROR_INTERNAL.

Subclasses overriding this method should make sure that they call super.handle(request, response) before adding their own logic.

Specified by:
handle in interface Uniform
Overrides:
handle in class Restlet
Parameters:
request - The request to handle.
response - The response to update.

isAvailable

public boolean isAvailable()
Indicates the underlying connector helper is available.

Specified by:
isAvailable in class Connector
Returns:
True if the underlying connector helper is available.

setConnectTimeout

@Deprecated
public void setConnectTimeout(int connectTimeout)
Deprecated. Use the equivalent connector parameters.

Sets the connection timeout in milliseconds. The default value is 0, meaning an infinite timeout.

Parameters:
connectTimeout - The connection timeout.

start

public void start()
           throws Exception
Description copied from class: Restlet
Starts the Restlet.

Overrides:
start in class Restlet
Throws:
Exception

stop

public void stop()
          throws Exception
Description copied from class: Restlet
Stops the Restlet.

Overrides:
stop in class Restlet
Throws:
Exception


Copyright © 2005-2013 Restlet.