org.restlet
Class Client

java.lang.Object
  extended by org.restlet.Uniform
      extended by org.restlet.Restlet
          extended by org.restlet.Connector
              extended by org.restlet.Client

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.

Author:
Jerome Louvel

Constructor Summary
Client(Context context, java.util.List<Protocol> protocols)
          Constructor.
Client(Context context, java.util.List<Protocol> protocols, java.lang.String helperClass)
          Constructor.
Client(Context context, Protocol protocol)
          Constructor.
Client(java.util.List<Protocol> protocols)
          Constructor.
Client(Protocol protocol)
          Constructor.
Client(java.lang.String protocolName)
          Constructor.
 
Method Summary
 int getConnectTimeout()
          Returns the connection timeout in milliseconds.
 void handle(Request request, Response response)
          Handles a call.
 void setConnectTimeout(int connectTimeout)
          Sets the connection timeout in milliseconds.
 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
getApplication, getContext, getLogger, init, isStarted, isStopped, setContext
 
Methods inherited from class org.restlet.Uniform
delete, delete, get, get, handle, head, head, options, options, post, post, put, put
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Client

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

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

Client

public Client(Context context,
              java.util.List<Protocol> protocols,
              java.lang.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(java.util.List<Protocol> protocols)
Constructor.

Parameters:
protocols - The connector protocols.

Client

public Client(Protocol protocol)
Constructor.

Parameters:
protocol - The connector protocol.

Client

public Client(java.lang.String protocolName)
Constructor.

Parameters:
protocolName - The connector protocol.
Method Detail

getConnectTimeout

public int getConnectTimeout()
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 call the (now deprecated) Restlet.init(Request, Response) method. In next version, Restlet.init(Request, Response) will be removed and its logic directly added to this method instead.

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

Overrides:
handle in class Restlet
Parameters:
request - The request to handle.
response - The response to update.

setConnectTimeout

public void setConnectTimeout(int connectTimeout)
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 java.lang.Exception
Description copied from class: Restlet
Starts the Restlet.

Overrides:
start in class Restlet
Throws:
java.lang.Exception

stop

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

Overrides:
stop in class Restlet
Throws:
java.lang.Exception


Copyright © 2005-2008 Noelios Technologies.