org.apache.excalibur.source.impl
Class FTPSource

java.lang.Object
  org.apache.excalibur.source.impl.AbstractSource
      org.apache.excalibur.source.impl.URLSource
          org.apache.excalibur.source.impl.FTPSource

All Implemented Interfaces:

ModifiableSource, Source

public class FTPSource
extends URLSource
implements ModifiableSource

Source implementation for the File Transfer Protocol.

Author:

Avalon Development Team

Field Summary

Fields inherited from class org.apache.excalibur.source.impl.URLSource

m_cachedLastModificationDate, m_cachedValidity, m_connection, m_encoding, m_exists, m_isPost, m_mimeType, m_parameters, m_url

Constructor Summary

FTPSource()

Method Summary

boolean	canCancel(OutputStream stream) Can the data sent to an OutputStream returned by getOutputStream() be cancelled ?
void	cancel(OutputStream stream) Cancel the data sent to an OutputStream returned by getOutputStream().
void	delete() Delete the source.
protected void	getInfos() Get the last modification date and content length of the source.
OutputStream	getOutputStream() Return an OutputStream to write to.
void	init(URL url, Map parameters) Initialize a new object from a URL.

Methods inherited from class org.apache.excalibur.source.impl.URLSource

exists, getInputStream, getMimeType, getUserInfo, getValidity, parameterize, refresh

Methods inherited from class org.apache.excalibur.source.impl.AbstractSource

checkInfos, getContentLength, getLastModified, getScheme, getURI, setContentLength, setLastModified, setScheme, setSystemId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.excalibur.source.Source

exists, getContentLength, getInputStream, getLastModified, getMimeType, getScheme, getURI, getValidity, refresh

Constructor Detail

FTPSource

public FTPSource()

Method Detail

init

public void init(URL url,
                 Map parameters)
          throws IOException

Initialize a new object from a URL.

Overrides:

init in class URLSource

Parameters:

parameters - This is optional

Throws:

IOException

canCancel

public boolean canCancel(OutputStream stream)

Can the data sent to an OutputStream returned by getOutputStream() be cancelled ?

Specified by:

canCancel in interface ModifiableSource

Returns:

true if the stream can be cancelled

cancel

public void cancel(OutputStream stream)
            throws IOException

Cancel the data sent to an OutputStream returned by getOutputStream().

After cancel, the stream should not be used.

Specified by:

cancel in interface ModifiableSource

Throws:

IOException

delete

public void delete()
            throws SourceException

Delete the source.

Specified by:

delete in interface ModifiableSource

Throws:

SourceException

getInfos

protected void getInfos()

Get the last modification date and content length of the source. Any exceptions are ignored.

Overrides:

getInfos in class URLSource

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Return an OutputStream to write to. The returned stream must be closed or cancelled by the calling code.

Specified by:

getOutputStream in interface ModifiableSource

Throws:

IOException