public class

FtpURLConnection

extends URLConnection

java.lang.Object
↳	java.net.URLConnection
	↳	sun.net.www.URLConnection
		↳	sun.net.www.protocol.ftp.FtpURLConnection

Class Overview

This class Opens an FTP input (or output) stream given a URL. It works as a one shot FTP transfer :

Login
Get (or Put) the file
Disconnect

You should not have to use it directly in most cases because all will be handled in a abstract layer. Here is an example of how to use the class :

URL url = new URL("ftp://ftp.sun.com/pub/test.txt");

UrlConnection con = url.openConnection();

InputStream is = con.getInputStream();

...

is.close();

Summary

Nested Classes
class	FtpURLConnection.FtpInputStream	For FTP URLs we need to have a special InputStream because we need to close 2 sockets after we're done with it : - The Data socket (for the file).
class	FtpURLConnection.FtpOutputStream	For FTP URLs we need to have a special OutputStream because we need to close 2 sockets after we're done with it : - The Data socket (for the file).

[Expand]

Inherited Fields

From class sun.net.www.URLConnection

From class java.net.URLConnection

Public Constructors
	FtpURLConnection(URL url) Creates an FtpURLConnection from a URL.

Public Methods
synchronized void	connect() Connects to the FTP server and logs in.
int	getConnectTimeout() Returns setting for connect timeout.
InputStream	getInputStream() Get the InputStream to retreive the remote file.
OutputStream	getOutputStream() Get the OutputStream to store the remote file.
Permission	getPermission() Gets the `Permission` associated with the host & port.
int	getReadTimeout() Returns setting for read timeout.
String	getRequestProperty(String key) Returns the value of the named general request property for this connection.
void	setConnectTimeout(int timeout) Sets a specified timeout value, in milliseconds, to be used when opening a communications link to the resource referenced by this URLConnection.
void	setReadTimeout(int timeout) Sets the read timeout to a specified timeout, in milliseconds.
void	setRequestProperty(String key, String value) Sets the general request property.

[Expand]

Inherited Methods

From class sun.net.www.URLConnection

void	addRequestProperty(String key, String value) The following three methods addRequestProperty, getRequestProperty, and getRequestProperties were copied from the superclass implementation before it was changed by CR:6230836, to maintain backward compatibility.
boolean	canCache() Returns true if the data associated with this URL can be cached.
void	close() Call this to close the connection and flush any remaining data.
int	getContentLength() Call this routine to get the content-length associated with this object.
String	getContentType() Call this routine to get the content-type associated with this object.
String	getHeaderField(String name) Returns the value of the named header field.
String	getHeaderField(int n) Return the value for the nth header field.
String	getHeaderFieldKey(int n) Return the key for the nth header field.
MessageHeader	getProperties() Call this routine to get the property list for this object.
Map<String, List<String>>	getRequestProperties() Returns an unmodifiable Map of general request properties for this connection.
String	getRequestProperty(String key) Returns the value of the named general request property for this connection.
synchronized static boolean	isProxiedHost(String host)
void	setContentLength(int length) Call this routine to set the content-length associated with this object.
void	setContentType(String type) Set the content type of this URL to a specific value.
void	setProperties(MessageHeader properties) Call this routine to set the property list for this object.
synchronized static void	setProxiedHost(String host)
void	setRequestProperty(String key, String value) Sets the general request property.

From class java.net.URLConnection

void	addRequestProperty(String key, String value) Adds a general request property specified by a key-value pair.
abstract void	connect() Opens a communications link to the resource referenced by this URL, if such a connection has not already been established.
boolean	getAllowUserInteraction() Returns the value of the `allowUserInteraction` field for this object.
int	getConnectTimeout() Returns setting for connect timeout.
Object	getContent() Retrieves the contents of this URL connection.
Object	getContent(Class[] classes) Retrieves the contents of this URL connection.
String	getContentEncoding() Returns the value of the `content-encoding` header field.
int	getContentLength() Returns the value of the `content-length` header field.
String	getContentType() Returns the value of the `content-type` header field.
long	getDate() Returns the value of the `date` header field.
static boolean	getDefaultAllowUserInteraction() Returns the default value of the `allowUserInteraction` field.
static String	getDefaultRequestProperty(String key) This method is deprecated. The instance specific getRequestProperty method should be used after an appropriate instance of URLConnection is obtained.
boolean	getDefaultUseCaches() Returns the default value of a `URLConnection`'s `useCaches` flag.
boolean	getDoInput() Returns the value of this `URLConnection`'s `doInput` flag.
boolean	getDoOutput() Returns the value of this `URLConnection`'s `doOutput` flag.
long	getExpiration() Returns the value of the `expires` header field.
synchronized static FileNameMap	getFileNameMap() Loads filename map (a mimetable) from a data file.
String	getHeaderField(String name) Returns the value of the named header field.
String	getHeaderField(int n) Returns the value for the `n`^th header field.
long	getHeaderFieldDate(String name, long Default) Returns the value of the named field parsed as date.
int	getHeaderFieldInt(String name, int Default) Returns the value of the named field parsed as a number.
String	getHeaderFieldKey(int n) Returns the key for the `n`^th header field.
Map<String, List<String>>	getHeaderFields() Returns an unmodifiable Map of the header fields.
long	getIfModifiedSince() Returns the value of this object's `ifModifiedSince` field.
InputStream	getInputStream() Returns an input stream that reads from this open connection.
long	getLastModified() Returns the value of the `last-modified` header field.
OutputStream	getOutputStream() Returns an output stream that writes to this connection.
Permission	getPermission() Returns a permission object representing the permission necessary to make the connection represented by this object.
int	getReadTimeout() Returns setting for read timeout.
Map<String, List<String>>	getRequestProperties() Returns an unmodifiable Map of general request properties for this connection.
String	getRequestProperty(String key) Returns the value of the named general request property for this connection.
URL	getURL() Returns the value of this `URLConnection`'s `URL` field.
boolean	getUseCaches() Returns the value of this `URLConnection`'s `useCaches` field.
static String	guessContentTypeFromName(String fname) Tries to determine the content type of an object, based on the specified "file" component of a URL.
static String	guessContentTypeFromStream(InputStream is) Tries to determine the type of an input stream based on the characters at the beginning of the input stream.
void	setAllowUserInteraction(boolean allowuserinteraction) Set the value of the `allowUserInteraction` field of this `URLConnection`.
void	setConnectTimeout(int timeout) Sets a specified timeout value, in milliseconds, to be used when opening a communications link to the resource referenced by this URLConnection.
synchronized static void	setContentHandlerFactory(ContentHandlerFactory fac) Sets the `ContentHandlerFactory` of an application.
static void	setDefaultAllowUserInteraction(boolean defaultallowuserinteraction) Sets the default value of the `allowUserInteraction` field for all future `URLConnection` objects to the specified value.
static void	setDefaultRequestProperty(String key, String value) This method is deprecated. The instance specific setRequestProperty method should be used after an appropriate instance of URLConnection is obtained. Invoking this method will have no effect.
void	setDefaultUseCaches(boolean defaultusecaches) Sets the default value of the `useCaches` field to the specified value.
void	setDoInput(boolean doinput) Sets the value of the `doInput` field for this `URLConnection` to the specified value.
void	setDoOutput(boolean dooutput) Sets the value of the `doOutput` field for this `URLConnection` to the specified value.
static void	setFileNameMap(FileNameMap map) Sets the FileNameMap.
void	setIfModifiedSince(long ifmodifiedsince) Sets the value of the `ifModifiedSince` field of this `URLConnection` to the specified value.
void	setReadTimeout(int timeout) Sets the read timeout to a specified timeout, in milliseconds.
void	setRequestProperty(String key, String value) Sets the general request property.
void	setUseCaches(boolean usecaches) Sets the value of the `useCaches` field of this `URLConnection` to the specified value.
String	toString() Returns a `String` representation of this URL connection.

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

Public Constructors

public FtpURLConnection (URL url)

Creates an FtpURLConnection from a URL.

Parameters

url	The `URL` to retrieve or store.

Public Methods

public synchronized void connect ()

Connects to the FTP server and logs in.

Throws

	if the login is unsuccessful
FtpProtocolException	if an error occurs
UnknownHostException	if trying to connect to an unknown host
IOException

public int getConnectTimeout ()

Returns setting for connect timeout.

0 return implies that the option is disabled (i.e., timeout of infinity).

Returns

an int that indicates the connect timeout value in milliseconds

public InputStream getInputStream ()

Get the InputStream to retreive the remote file. It will issue the "get" (or "dir") command to the ftp server.

Returns

the InputStream to the connection.

Throws

IOException	if already opened for output
FtpProtocolException	if errors occur during the transfert.

public OutputStream getOutputStream ()

Get the OutputStream to store the remote file. It will issue the "put" command to the ftp server.

Returns

the OutputStream to the connection.

Throws

IOException	if already opened for input or the URL points to a directory
FtpProtocolException	if errors occur during the transfert.

public Permission getPermission ()

Gets the Permission associated with the host & port.

Returns

The Permission object.

public int getReadTimeout ()

Returns setting for read timeout. 0 return implies that the option is disabled (i.e., timeout of infinity).

Returns

an int that indicates the read timeout value in milliseconds

public String getRequestProperty (String key)

Returns the value of the named general request property for this connection.

Parameters

key	the keyword by which the request is known (e.g., "accept").

Returns

the value of the named general request property for this connection.

Throws

IllegalStateException	if already connected

public void setConnectTimeout (int timeout)

Sets a specified timeout value, in milliseconds, to be used when opening a communications link to the resource referenced by this URLConnection. If the timeout expires before the connection can be established, a java.net.SocketTimeoutException is raised. A timeout of zero is interpreted as an infinite timeout.

Some non-standard implmentation of this method may ignore the specified timeout. To see the connect timeout set, please call getConnectTimeout().

Parameters

timeout	an `int` that specifies the connect timeout value in milliseconds

public void setReadTimeout (int timeout)

Sets the read timeout to a specified timeout, in milliseconds. A non-zero value specifies the timeout when reading from Input stream when a connection is established to a resource. If the timeout expires before there is data available for read, a java.net.SocketTimeoutException is raised. A timeout of zero is interpreted as an infinite timeout.

Some non-standard implementation of this method ignores the specified timeout. To see the read timeout set, please call getReadTimeout().

Parameters

timeout	an `int` that specifies the timeout value to be used in milliseconds

public void setRequestProperty (String key, String value)

Sets the general request property. If a property with the key already exists, overwrite its value with the new value.

Parameters

key	the keyword by which the request is known (e.g., "`accept`").
value	the value associated with it.

Throws

IllegalStateException	if already connected

Classes

FtpURLConnection

Class Overview

See Also

Summary

Public Constructors

public FtpURLConnection (URL url)

Parameters

Public Methods

public synchronized void connect ()

Throws

public int getConnectTimeout ()

Returns

public InputStream getInputStream ()

Returns

Throws

public OutputStream getOutputStream ()

Returns

Throws

public Permission getPermission ()

Returns

public int getReadTimeout ()

Returns

public String getRequestProperty (String key)

Parameters

Returns

Throws

See Also

public void setConnectTimeout (int timeout)

Parameters

public void setReadTimeout (int timeout)

Parameters

public void setRequestProperty (String key, String value)

Parameters

Throws

See Also