org.alfresco.bm.file

Class AbstractTestFileService

java.lang.Object

org.alfresco.bm.file.AbstractTestFileService

All Implemented Interfaces:

TestFileService, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

FtpTestFileService, LocalTestFileService

public abstract class AbstractTestFileService
extends Object
implements TestFileService, org.springframework.beans.factory.InitializingBean

Abstract service implementation of FileDataService based on MongoDB.

Since:

1.4

Author:

Derek Hulley

Constructor Summary

Constructors

Constructor and Description
AbstractTestFileService(FileDataService fileDataService, String localDir)

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected abstract void	downloadRemoteFile(FileData fileData, File localFile) Download the file represented from the remote location to the local file.
File	getFile() Get a random file of any description
File	getFile(String extension) Get a random file with the given extension
File	getFileByName(String filename) Find a specific file by name
protected abstract String	getMirrorPath() Get the data mirror path (relative to the root location).
protected abstract List<FileData>	listRemoteFiles() List all files on the remote server

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractTestFileService

public AbstractTestFileService(FileDataService fileDataService,
                       String localDir)

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

getMirrorPath

protected abstract String getMirrorPath()

Get the data mirror path (relative to the root location). This is implementation-specific as it depends on the way in which data is stored in the remote location.

Returns:

a relative path in which local files will be mirrored

listRemoteFiles

protected abstract List<FileData> listRemoteFiles()

List all files on the remote server

Returns:

a list of data with the remote name populated

downloadRemoteFile

protected abstract void downloadRemoteFile(FileData fileData,
                      File localFile)
                                    throws IOException

Download the file represented from the remote location to the local file. Note that all stream closures must be handled internally but IO errors can be allowed out.

Parameters:

fileData - data containing details of the remote file

localFile - the local file to write to

Throws:

IOException - will be handled by the calling code

getFileByName

public File getFileByName(String filename)

Description copied from interface: TestFileService

Find a specific file by name

Specified by:

getFileByName in interface TestFileService

Parameters:

filename - the name of the remote file to find

Returns:

a file or null if no test file with that name exists

getFile

public File getFile()

Description copied from interface: TestFileService

Get a random file of any description

Specified by:

getFile in interface TestFileService

Returns:

a file or null if no test files exist

getFile

public File getFile(String extension)

Description copied from interface: TestFileService

Get a random file with the given extension

Specified by:

getFile in interface TestFileService

Parameters:

extension - the file extension, which is no guarantee of mimetype

Returns:

a file or null if no such test file exists