Package org.restlet.engine.connector

Class FtpClientHelper

java.lang.Object
org.restlet.engine.Helper
org.restlet.engine.RestletHelper<T>
org.restlet.engine.connector.ConnectorHelper<Client>
org.restlet.engine.connector.ClientHelper
org.restlet.engine.connector.FtpClientHelper
public class FtpClientHelper extends ClientHelper
FTP client connector using the URLConnection. Here is the list of parameters that are supported. They should be set in the Client's context before it is started:
list of supported parameters
Parameter name Value type Default value Description
allowUserInteraction boolean false If true, this URL is being examined in a context in which it makes sense to allow user interactions such as popping up an authentication dialog.
readTimeout int 60000 Sets the read timeout to a specified timeout, in milliseconds. A timeout of zero is interpreted as an infinite timeout.
useCaches boolean false If true, the protocol is allowed to use caching whenever it can.
Author:
Jerome Louvel
See Also:

  • Constructor Details

    • FtpClientHelper

      public FtpClientHelper(Client client)
      Constructor.
      Parameters:
      client - The client to help.

  • Method Details

    • getReadTimeout

      public int getReadTimeout()
      Returns the read timeout value. A timeout of zero is interpreted as an infinite timeout.
      Returns:
      The read timeout value.

    • getSocketConnectTimeoutMs

      public int getSocketConnectTimeoutMs()
      Returns the connection timeout. Defaults to 15000.
      Returns:
      The connection timeout.

    • handle

      public void handle(Request request, Response response)
      Description copied from class: RestletHelper
      Handles a call.
      Overrides:
      handle in class RestletHelper<Client>
      Parameters:
      request - The request to handle.
      response - The response to update.

    • isAllowUserInteraction

      public boolean isAllowUserInteraction()
      Indicates if this URL is being examined in a context in which it makes sense to allow user interactions such as popping up an authentication dialog.
      Returns:
      True if it makes sense to allow user interactions.

    • isUseCaches

      public boolean isUseCaches()
      Indicates if the protocol is allowed to use caching whenever it can.
      Returns:
      True if the protocol is allowed to use caching whenever it can.

    • start

      public void start() throws Exception
      Description copied from class: RestletHelper
      Start callback.
      Overrides:
      start in class ConnectorHelper<Client>
      Throws:
      Exception

    • stop

      public void stop() throws Exception
      Description copied from class: RestletHelper
      Stop callback.
      Overrides:
      stop in class ConnectorHelper<Client>
      Throws:
      Exception