Modifier and Type	Class and Description
protected static 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).
protected static 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).

Field Summary

Modifier and Type	Field and Description
pack-priv static final int	ASCII
pack-priv static final int	BIN
private int	connectTimeout Hides java.net.URLConnection.connectTimeout.
pack-priv static final int	DIR
pack-priv String	filename
pack-priv FtpClient	ftp
pack-priv String	fullpath
pack-priv String	host
pack-priv HttpURLConnection	http
private final Proxy	instProxy
pack-priv InputStream	is
pack-priv static final int	NONE
pack-priv OutputStream	os
pack-priv String	password
pack-priv String	pathname
pack-priv Permission	permission
pack-priv int	port
private int	readTimeout Hides java.net.URLConnection.readTimeout.
pack-priv int	type
pack-priv String	user

Inherited from sun.net.www.URLConnection:: properties

Constructor Summary

Access	Constructor and Description
public	FtpURLConnection(URL The `URL` to retrieve or store. url) Creates an FtpURLConnection from a URL.
pack-priv	FtpURLConnection(URL url, Proxy p) Same as FtpURLconnection(URL) with a per connection proxy specified

Method Summary

Modifier and Type	Method and Description
private void	cd(String path)
private static URL	checkURL(URL u)
public synchronized void	connect() Implements abstract java.net.URLConnection.connect. Connects to the FTP server and logs in.
private void	decodePath(String path)
public int	getConnectTimeout() Overrides java.net.URLConnection.getConnectTimeout. Returns setting for connect timeout.
public InputStream	Returns: the `InputStream` to the connection. getInputStream() Overrides java.net.URLConnection.getInputStream. Get the InputStream to retrieve the remote file.
public OutputStream	Returns: the `OutputStream` to the connection. getOutputStream() Overrides java.net.URLConnection.getOutputStream. Get the OutputStream to store the remote file.
public Permission	Returns: The `Permission` object. getPermission() Overrides java.net.URLConnection.getPermission. Gets the `Permission` associated with the host and port.
public int	getReadTimeout() Overrides java.net.URLConnection.getReadTimeout. Returns setting for read timeout.
public String	Returns: the value of the named general request property for this connection. getRequestProperty(String the keyword by which the request is known (e.g., "accept"). key) Overrides sun.net.www.URLConnection.getRequestProperty. Returns the value of the named general request property for this connection.
pack-priv String	guessContentTypeFromFilename(String fname)
public void	setConnectTimeout(int an `int` that specifies the connect timeout value in milliseconds timeout) Overrides java.net.URLConnection.setConnectTimeout. Sets a specified timeout value, in milliseconds, to be used when opening a communications link to the resource referenced by this URLConnection.
public void	setReadTimeout(int an `int` that specifies the timeout value to be used in milliseconds timeout) Overrides java.net.URLConnection.setReadTimeout. Sets the read timeout to a specified timeout, in milliseconds.
public void	setRequestProperty(String the keyword by which the request is known (e.g., "`accept`"). key, String the value associated with it. value) Overrides sun.net.www.URLConnection.setRequestProperty. Sets the general request property.
private void	setTimeouts()

Inherited from sun.net.www.URLConnection:: addRequestProperty canCache close getContentLength getContentType getHeaderField getHeaderField getHeaderFieldKey getHeaderFields getProperties getRequestProperties isProxiedHost setContentLength setContentType setProperties setProxiedHost

Field Detail

ASCII	back to summary
pack-priv static final int ASCII

BIN	back to summary
pack-priv static final int BIN

connectTimeout	back to summary
private int connectTimeout Hides java.net.URLConnection.connectTimeout.

DIR	back to summary
pack-priv static final int DIR

filename	back to summary
pack-priv String filename

ftp	back to summary
pack-priv FtpClient ftp

fullpath	back to summary
pack-priv String fullpath

host	back to summary
pack-priv String host

http	back to summary
pack-priv HttpURLConnection http

instProxy	back to summary
private final Proxy instProxy

is	back to summary
pack-priv InputStream is

NONE	back to summary
pack-priv static final int NONE

os	back to summary
pack-priv OutputStream os

password	back to summary
pack-priv String password

pathname	back to summary
pack-priv String pathname

permission	back to summary
pack-priv Permission permission

port	back to summary
pack-priv int port

readTimeout	back to summary
private int readTimeout Hides java.net.URLConnection.readTimeout.

type	back to summary
pack-priv int type

user	back to summary
pack-priv String user

Constructor Detail

FtpURLConnection back to summary

FtpURLConnection	back to summary
public FtpURLConnection(URL url) throws MalformedURLException Creates an FtpURLConnection from a URL. Parameters url:URL The `URL` to retrieve or store.

public FtpURLConnection(URL url) throws MalformedURLException

Creates an FtpURLConnection from a URL.

Parameters

url:URL: The URL to retrieve or store.

FtpURLConnection	back to summary
pack-priv FtpURLConnection(URL url, Proxy p) throws MalformedURLException Same as FtpURLconnection(URL) with a per connection proxy specified

Method Detail

cd	back to summary
private void cd(String path) throws FtpProtocolException, IOException

checkURL	back to summary
private static URL checkURL(URL u) throws MalformedURLException

connect	back to summary
public synchronized void connect() throws IOException Implements abstract java.net.URLConnection.connect. Connects to the FTP server and logs in. Exceptions IOException: Doc from java.net.URLConnection.connect. if an I/O error occurs while opening the connection. FtpLoginException: if the login is unsuccessful FtpProtocolException: if an error occurs UnknownHostException: if trying to connect to an unknown host

connect

back to summary

public synchronized void connect() throws IOException

Implements abstract java.net.URLConnection.connect.

Connects to the FTP server and logs in.

Exceptions

IOException:

Doc from java.net.URLConnection.connect.

if an I/O error occurs while opening the connection.

FtpLoginException:

if the login is unsuccessful

FtpProtocolException:

if an error occurs

UnknownHostException:

if trying to connect to an unknown host

decodePath	back to summary
private void decodePath(String path)

getConnectTimeout back to summary

getConnectTimeout	back to summary
public int getConnectTimeout() Overrides java.net.URLConnection.getConnectTimeout. Doc from java.net.URLConnection.getConnectTimeout. Returns setting for connect timeout. 0 return implies that the option is disabled (i.e., timeout of infinity). Returns:int an `int` that indicates the connect timeout value in milliseconds Annotations @Override

public int getConnectTimeout()

Overrides java.net.URLConnection.getConnectTimeout.

Doc from java.net.URLConnection.getConnectTimeout.

Returns setting for connect timeout.

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

Returns:int

an int that indicates the connect timeout value in milliseconds

Annotations

@Override

getInputStream back to summary

getInputStream	back to summary
public InputStream getInputStream() throws IOException Overrides java.net.URLConnection.getInputStream. Get the InputStream to retrieve the remote file. It will issue the "get" (or "dir") command to the ftp server. Returns:InputStream the `InputStream` to the connection. Annotations @Override Exceptions IOException: if already opened for output FtpProtocolException: if errors occur during the transfer.

public InputStream getInputStream() throws IOException

Overrides java.net.URLConnection.getInputStream.

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

Returns:InputStream

the InputStream to the connection.

Annotations

@Override

Exceptions

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

getOutputStream back to summary

getOutputStream	back to summary
public OutputStream getOutputStream() throws IOException Overrides java.net.URLConnection.getOutputStream. Get the OutputStream to store the remote file. It will issue the "put" command to the ftp server. Returns:OutputStream the `OutputStream` to the connection. Annotations @Override Exceptions IOException: if already opened for input or the URL points to a directory FtpProtocolException: if errors occur during the transfer.

public OutputStream getOutputStream() throws IOException

Overrides java.net.URLConnection.getOutputStream.

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

Returns:OutputStream

the OutputStream to the connection.

Annotations

@Override

Exceptions

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

getPermission back to summary

getPermission	back to summary
public Permission getPermission() Overrides java.net.URLConnection.getPermission. Gets the `Permission` associated with the host and port. Returns:Permission The `Permission` object. Annotations @Override

public Permission getPermission()

Overrides java.net.URLConnection.getPermission.

Gets the Permission associated with the host and port.

Returns:Permission

The Permission object.

Annotations

@Override

getReadTimeout back to summary

getReadTimeout	back to summary
public int getReadTimeout() Overrides java.net.URLConnection.getReadTimeout. Doc from java.net.URLConnection.getReadTimeout. Returns setting for read timeout. 0 return implies that the option is disabled (i.e., timeout of infinity). Returns:int an `int` that indicates the read timeout value in milliseconds Annotations @Override

public int getReadTimeout()

Overrides java.net.URLConnection.getReadTimeout.

Doc from java.net.URLConnection.getReadTimeout.

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

Returns:int

an int that indicates the read timeout value in milliseconds

Annotations

@Override

getRequestProperty back to summary

getRequestProperty	back to summary
public String getRequestProperty(String key) Overrides sun.net.www.URLConnection.getRequestProperty. Returns the value of the named general request property for this connection. Parameters key:String the keyword by which the request is known (e.g., "accept"). Returns:String the value of the named general request property for this connection. Annotations @Override Exceptions IllegalStateException: if already connected See Also `setRequestProperty(java.lang.String, java.lang.String)`

public String getRequestProperty(String key)

Overrides sun.net.www.URLConnection.getRequestProperty.

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

Parameters

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

Returns:String

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

Annotations

@Override

Exceptions

IllegalStateException:: if already connected

guessContentTypeFromFilename	back to summary
pack-priv String guessContentTypeFromFilename(String fname)

setConnectTimeout back to summary

setConnectTimeout	back to summary
public void setConnectTimeout(int timeout) Overrides java.net.URLConnection.setConnectTimeout. Doc from java.net.URLConnection.setConnectTimeout. 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 implementation of this method may ignore the specified timeout. To see the connect timeout set, please call getConnectTimeout(). Parameters timeout:int an `int` that specifies the connect timeout value in milliseconds Annotations @Override

public void setConnectTimeout(int timeout)

Overrides java.net.URLConnection.setConnectTimeout.

Doc from java.net.URLConnection.setConnectTimeout.

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 implementation of this method may ignore the specified timeout. To see the connect timeout set, please call getConnectTimeout().

Parameters

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

Annotations

@Override

setReadTimeout back to summary

setReadTimeout	back to summary
public void setReadTimeout(int timeout) Overrides java.net.URLConnection.setReadTimeout. Doc from java.net.URLConnection.setReadTimeout. 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:int an `int` that specifies the timeout value to be used in milliseconds Annotations @Override

public void setReadTimeout(int timeout)

Overrides java.net.URLConnection.setReadTimeout.

Doc from java.net.URLConnection.setReadTimeout.

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:int: an int that specifies the timeout value to be used in milliseconds

Annotations

@Override

setRequestProperty back to summary

setRequestProperty	back to summary
public void setRequestProperty(String key, String value) Overrides sun.net.www.URLConnection.setRequestProperty. Sets the general request property. If a property with the key already exists, overwrite its value with the new value. Parameters key:String the keyword by which the request is known (e.g., "`accept`"). value:String the value associated with it. Annotations @Override Exceptions IllegalStateException: if already connected See Also `getRequestProperty(java.lang.String)`

public void setRequestProperty(String key, String value)

Overrides sun.net.www.URLConnection.setRequestProperty.

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

Parameters

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

Annotations

@Override

Exceptions

IllegalStateException:: if already connected

See Also

getRequestProperty(java.lang.String)

setTimeouts	back to summary
private void setTimeouts()

sun.net.www.protocol.ftp back to summary

protected Class FtpURLConnection.FtpInputStream

Class Inheritance

extends FilterInputStream

java.lang.Object
java.io.InputStream
java.io.FilterInputStream
sun.net.www.protocol.ftp.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). - The command socket (FtpClient). Since that's the only class that needs to see that, it is an inner class.

Field Summary

Modifier and Type	Field and Description
pack-priv FtpClient	ftp

Inherited from java.io.FilterInputStream:: in

Constructor Summary

Access	Constructor and Description
pack-priv	FtpInputStream(FtpClient cl, InputStream fd)

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides java.io.FilterInputStream.close. Implements java.io.Closeable.close. Closes this input stream and releases any system resources associated with the stream.

Inherited from java.io.FilterInputStream:: available mark markSupported read read read reset skip

Field Detail

ftp	back to summary
pack-priv FtpClient ftp

Constructor Detail

FtpInputStream	back to summary
pack-priv FtpInputStream(FtpClient cl, InputStream fd)

Method Detail

close	back to summary
public void close() throws IOException Overrides java.io.FilterInputStream.close. Implements java.io.Closeable.close. Doc from java.io.FilterInputStream.close. Closes this input stream and releases any system resources associated with the stream. Annotations @Override Exceptions IOException: if an I/O error occurs.

back to summary

public void close() throws IOException

Overrides java.io.FilterInputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.FilterInputStream.close.

Closes this input stream and releases any system resources associated with the stream.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

sun.net.www.protocol.ftp back to summary

protected Class FtpURLConnection.FtpOutputStream

Class Inheritance

extends FilterOutputStream

java.lang.Object
java.io.OutputStream
java.io.FilterOutputStream
sun.net.www.protocol.ftp.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). - The command socket (FtpClient). Since that's the only class that needs to see that, it is an inner class.

Field Summary

Modifier and Type	Field and Description
pack-priv FtpClient	ftp

Inherited from java.io.FilterOutputStream:: out

Constructor Summary

Access	Constructor and Description
pack-priv	FtpOutputStream(FtpClient cl, OutputStream fd)

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides java.io.FilterOutputStream.close. Implements java.io.Closeable.close. Closes this output stream and releases any system resources associated with the stream.