org.restlet.ext.net
Class FtpClientHelper
java.lang.Object
org.restlet.engine.Helper
org.restlet.engine.RestletHelper<T>
org.restlet.engine.ConnectorHelper<Client>
org.restlet.engine.ClientHelper
org.restlet.ext.net.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:
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 |
0 |
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:
- Networking
Features
Method Summary |
int |
getReadTimeout()
Returns the read timeout value. |
void |
handle(Request request,
Response response)
|
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. |
boolean |
isUseCaches()
Indicates if the protocol is allowed to use caching whenever it can. |
void |
start()
|
void |
stop()
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
FtpClientHelper
public FtpClientHelper(Client client)
- Constructor.
- Parameters:
client
- The client to help.
getReadTimeout
public int getReadTimeout()
- Returns the read timeout value. A timeout of zero is interpreted as an
infinite timeout.
- Returns:
- The read timeout value.
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.
handle
public void handle(Request request,
Response response)
- Overrides:
handle
in class RestletHelper<Client>
start
public void start()
throws Exception
- Overrides:
start
in class ConnectorHelper<Client>
- Throws:
Exception
stop
public void stop()
throws Exception
- Overrides:
stop
in class ConnectorHelper<Client>
- Throws:
Exception
Copyright © 2005-2013 Restlet.