Package net.sf.basedb.opengrid.filetransfer

Class AbstractFileTransfer

java.lang.Object

net.sf.basedb.opengrid.filetransfer.AbstractFileTransfer

Direct Known Subclasses:

BaseFileDownloadTarget, BaseFileUploadSource, ByteArrayDownloadTarget, ByteArrayUploadSource, OutputStreamDownloadTarget, ServletResponseDownloadTarget

public abstract class AbstractFileTransfer
extends Object

Abstract base implementation that is suitable when implementing both file upload and download. This class provides functionality that is common to both the DownloadTarget and UploadSource interfaces, eg. the name and file metdata information. DownloadTarget implementations only need to extend this class and implement the DownloadTarget.getOutputStream() method. File metadata about the remote file should be available in the getMetadata() instance when the DownloadTarget.getOutputStream() method is called. UploadSource implementations that are extending this class need to implement the UploadSource.getInputStream() method. If file metadata is important the implementation should call getMetadata() and initialize the information before the UploadSource.getInputStream() method is called.

Since:

1.0

Author:

nicklas

Field Summary

Fields

Modifier and Type	Field	Description
private FileMetaData	metadata
private final String	name

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractFileTransfer(String name)

Method Summary

Modifier and Type	Method	Description
FileMetaData	getMetadata()	Get metadata about the local file or receive metadata for the remote file.
String	getName()	Get the name of the file.
protected void	initMetadata(FileMetaData metadata)	Subclasses that are implementing the UploadSource interface should override this method and initialize the metadata instance with information about the loca file.

Methods inherited from class java.lang.Object

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

Field Details

name

private final String name

metadata

private FileMetaData metadata

Constructor Details

AbstractFileTransfer

protected AbstractFileTransfer(String name)

Method Details

getName

public String getName()

Get the name of the file.

See Also:

• UploadSource.getName()
• DownloadTarget.getName()

getMetadata

public FileMetaData getMetadata()

Get metadata about the local file or receive metadata for the remote file.

See Also:

• UploadSource.getMetadata()
• DownloadTarget.getMetadata()

initMetadata

protected void initMetadata(FileMetaData metadata)

Subclasses that are implementing the UploadSource interface should override this method and initialize the metadata instance with information about the loca file. This method is called also for DownloadTarget implementations but can typically be ignored since the metadata will be overwritten with information from the remote server.