Package org.opencastproject.fileupload.service

Class FileUploadServiceImpl

java.lang.Object

org.opencastproject.fileupload.service.FileUploadServiceImpl

All Implemented Interfaces:

FileUploadService, org.osgi.service.cm.ManagedService

public class FileUploadServiceImpl
extends Object
implements FileUploadService, org.osgi.service.cm.ManagedService

A service for big file uploads via HTTP.

Constructor Summary

Constructors

Constructor	Description
FileUploadServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	acceptChunk(FileUploadJob job, long chunkNumber, InputStream content)	Appends the next part to the payload and updates the upload job accordingly.
protected void	activate(org.osgi.service.component.ComponentContext cc)
void	cleanOutdatedJobs()	Cleans outdated jobs on the file system
FileUploadJob	createJob(String filename, long filesize, int chunksize, MediaPackage mp, MediaPackageElementFlavor flavor)	Creates a new upload job with the given metadata.
protected void	deactivate(org.osgi.service.component.ComponentContext cc)
void	deleteJob(String id)	Deletes the job permanently, thus deleting persistent data.
FileUploadJob	getJob(String id)	Returns the upload job with the given ID, throws FileUploadException if the job can not be found.
InputStream	getPayload(FileUploadJob job)	Returns an InputStream containing the data from the payload.
boolean	hasJob(String id)	Returns true is a job with the given ID exists.
protected void	setIngestService(IngestService ingestService)
protected void	setWorkspace(Workspace workspace)
void	updated(Dictionary properties)

Methods inherited from class java.lang.Object

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

Constructor Details

FileUploadServiceImpl

public FileUploadServiceImpl()

Method Details

activate

protected void activate(org.osgi.service.component.ComponentContext cc)
                 throws Exception

Throws:

Exception

deactivate

protected void deactivate(org.osgi.service.component.ComponentContext cc)

updated

public void updated(Dictionary properties)
             throws org.osgi.service.cm.ConfigurationException

Specified by:

updated in interface org.osgi.service.cm.ManagedService

Throws:

org.osgi.service.cm.ConfigurationException

setWorkspace

protected void setWorkspace(Workspace workspace)

setIngestService

protected void setIngestService(IngestService ingestService)

createJob

public FileUploadJob createJob(String filename,
 long filesize,
 int chunksize,
 MediaPackage mp,
 MediaPackageElementFlavor flavor)
                        throws FileUploadException

Creates a new upload job with the given metadata.

Specified by:

createJob in interface FileUploadService

Parameters:

filename - name of the file to be uploaded

filesize - size of the file

chunksize - size of the file parts that will be uploaded

mp - the mediapackage this file should belong to

Returns:

FileUploadJob the job object

Throws:

FileUploadException

See Also:

• FileUploadService.createJob(String, long, int, org.opencastproject.mediapackage.MediaPackage, org.opencastproject.mediapackage.MediaPackageElementFlavor)

hasJob

public boolean hasJob(String id)

Returns true is a job with the given ID exists.

Specified by:

hasJob in interface FileUploadService

Parameters:

id - ID of the job in question

Returns:

true if job exists, false otherwise

See Also:

• FileUploadService.hasJob(String id)

getJob

public FileUploadJob getJob(String id)
                     throws FileUploadException

Returns the upload job with the given ID, throws FileUploadException if the job can not be found.

Specified by:

getJob in interface FileUploadService

Parameters:

id - ID of the upload job to retrieve

Returns:

FileUploadJob the job object in question

Throws:

FileUploadException

See Also:

• FileUploadService.getJob(String id)

cleanOutdatedJobs

public void cleanOutdatedJobs()
                       throws IOException

Cleans outdated jobs on the file system

Specified by:

cleanOutdatedJobs in interface FileUploadService

Throws:

IOException

See Also:

• FileUploadService.cleanOutdatedJobs()

deleteJob

public void deleteJob(String id)
               throws FileUploadException

Deletes the job permanently, thus deleting persistent data.

Specified by:

deleteJob in interface FileUploadService

Parameters:

id - ID of the upload job to delete

Throws:

FileUploadException

See Also:

• FileUploadService.deleteJob(String id)

acceptChunk

public void acceptChunk(FileUploadJob job,
 long chunkNumber,
 InputStream content)
                 throws FileUploadException

Description copied from interface: FileUploadService

Appends the next part to the payload and updates the upload job accordingly.

Specified by:

acceptChunk in interface FileUploadService

Parameters:

job - the job object for the upload

chunkNumber - the number of the chunk being transfered

content - the actual payload data

Throws:

FileUploadException

getPayload

public InputStream getPayload(FileUploadJob job)
                       throws FileUploadException

Description copied from interface: FileUploadService

Returns an InputStream containing the data from the payload.

Specified by:

getPayload in interface FileUploadService

Parameters:

job - job to retrieve payload data from

Returns:

InputStream the payload data

Throws:

FileUploadException