Package org.opencastproject.workingfilerepository.impl

Class WorkingFileRepositoryImpl

java.lang.Object

org.opencastproject.workingfilerepository.impl.WorkingFileRepositoryImpl

All Implemented Interfaces:

StorageUsage, PathMappable, WorkingFileRepository

Direct Known Subclasses:

WorkingFileRepositoryRestEndpoint

public class WorkingFileRepositoryImpl
extends Object
implements WorkingFileRepository, PathMappable

A very simple (read: inadequate) implementation that stores all files under a root directory using the media package ID as a subdirectory and the media package element ID as the file name.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MD5_EXTENSION	The extension we use for the md5 hash calculated from the file contents
protected ServiceRegistry	remoteServiceManager	The remote service manager
protected String	rootDirectory	The root directory for storing files
protected SecurityService	securityService	The security service to get current organization from
protected String	serverUrl	The Base URL for this server
protected String	servicePath	The URL path for the services provided by the working file repository
static final String	WORKING_FILE_REPOSITORY_CLEANUP_MAX_AGE_KEY	Configuration key for garbage collection max age.
static final String	WORKING_FILE_REPOSITORY_CLEANUP_PERIOD_KEY	Configuration key for garbage collection period.

Fields inherited from interface org.opencastproject.workingfilerepository.api.WorkingFileRepository

CHAR_ENCODING, COLLECTION_PATH_PREFIX, MEDIAPACKAGE_PATH_PREFIX, SERVICE_TYPE, URI_PREFIX

Constructor Summary

Constructors

Constructor	Description
WorkingFileRepositoryImpl()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	Activate the component
protected void	checkPathSafe(String id)
boolean	cleanupOldFilesFromCollection(String collectionId, long days)	Cleans up collection files older than the number of days passed.
boolean	cleanupOldFilesFromMediaPackage(long days)	Cleans up media files older than the number of days passed.
URI	copyTo(String fromCollection, String fromFileName, String toMediaPackage, String toMediaPackageElement, String toFileName)
protected File	createMd5(File f)	Creates a file containing the md5 hash for the contents of a source file.
void	deactivate()	Callback from OSGi on service deactivation.
boolean	delete(String mediaPackageID, String mediaPackageElementID)	Delete the file stored at the given media package and element IDs.
boolean	deleteFromCollection(String collectionId, String fileName)	Removes a file from a collection
boolean	deleteFromCollection(String collectionId, String fileName, boolean removeCollection)	Removes a file from a collection, and the parent folder if empty
InputStream	get(String mediaPackageID, String mediaPackageElementID)	Stream the file stored under the given media package and element IDs.
URI	getBaseUri()	Gets the base URI for this service.
URI[]	getCollectionContents(String collectionId)	Gets the URIs of the members of this collection
long	getCollectionSize(String id)
URI	getCollectionURI(String collectionID, String fileName)	Get the URL for a file stored under the given collection.
String	getDiskSpace()	A textual representation of available and total storage
protected File	getFile(String mediaPackageID, String mediaPackageElementID)	Returns the file to the media package element.
File	getFileFromCollection(String collectionId, String fileName)	Returns the file from the given collection.
InputStream	getFromCollection(String collectionId, String fileName)
String	getPathPrefix()	Returns the prefix to the working file repository file system root directory.
protected File	getSourceFile(File md5File)	Gets the file handle for a source file from its md5 file.
Option<Long>	getTotalSpace()	Gets the total space of storage in Bytes
URI	getURI(String mediaPackageID, String mediaPackageElementID)	Get the URL for a file stored under the given media package and element IDs.
URI	getURI(String mediaPackageID, String mediaPackageElementID, String fileName)	Get the URL for a file stored under the given media package and element IDs.
String	getUrlPrefix()	Returns the repository's base url.
Option<Long>	getUsableSpace()	Gets the available space of storage in Bytes This is free storage that is not reserved
Option<Long>	getUsedSpace()	Gets the used space of storage in Bytes
URI	moveTo(String fromCollection, String fromFileName, String toMediaPackage, String toMediaPackageElement, String toFileName)	Moves a file from a collection into a mediapackage
URI	put(String mediaPackageID, String mediaPackageElementID, String filename, InputStream in)	Store the data stream under the given media package and element IDs with filename as name of the file.
URI	putInCollection(String collectionId, String fileName, InputStream in)	Puts a file into a collection, overwriting the existing file if present.
void	setRemoteServiceManager(ServiceRegistry remoteServiceManager)	Sets the remote service manager.
void	setSecurityService(SecurityService securityService)
String	toSafeName(String fileName)	Returns the filename translated into a version that can safely be used as part of a file system path.

Methods inherited from class java.lang.Object

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

Field Details

MD5_EXTENSION

public static final String MD5_EXTENSION

The extension we use for the md5 hash calculated from the file contents

See Also:

• Constant Field Values

WORKING_FILE_REPOSITORY_CLEANUP_PERIOD_KEY

public static final String WORKING_FILE_REPOSITORY_CLEANUP_PERIOD_KEY

Configuration key for garbage collection period.

See Also:

• Constant Field Values

WORKING_FILE_REPOSITORY_CLEANUP_MAX_AGE_KEY

public static final String WORKING_FILE_REPOSITORY_CLEANUP_MAX_AGE_KEY

Configuration key for garbage collection max age.

See Also:

• Constant Field Values

remoteServiceManager

protected ServiceRegistry remoteServiceManager

The remote service manager

rootDirectory

protected String rootDirectory

The root directory for storing files

serverUrl

protected String serverUrl

The Base URL for this server

servicePath

protected String servicePath

The URL path for the services provided by the working file repository

securityService

protected SecurityService securityService

The security service to get current organization from

Constructor Details

WorkingFileRepositoryImpl

public WorkingFileRepositoryImpl()

Method Details

activate

public void activate(org.osgi.service.component.ComponentContext cc)
              throws IOException

Activate the component

Throws:

IOException

deactivate

public void deactivate()

Callback from OSGi on service deactivation.

toSafeName

public String toSafeName(String fileName)

Returns the filename translated into a version that can safely be used as part of a file system path. The method shortens both the base file name and the extension to a maximum of 255 characters each, and replaces unsafe characters with <doce>_</doce>.

Specified by:

toSafeName in interface WorkingFileRepository

Parameters:

fileName - The file name

Returns:

the safe version

delete

public boolean delete(String mediaPackageID,
 String mediaPackageElementID)
               throws IOException

Delete the file stored at the given media package and element IDs.

Specified by:

delete in interface WorkingFileRepository

Parameters:

mediaPackageID - the media package identifier

mediaPackageElementID - the media package element identifier

Throws:

IOException - if the element cannot be deleted

See Also:

• WorkingFileRepository.delete(java.lang.String, java.lang.String)

get

public InputStream get(String mediaPackageID,
 String mediaPackageElementID)
                throws NotFoundException,
IOException

Stream the file stored under the given media package and element IDs.

Specified by:

get in interface WorkingFileRepository

Parameters:

mediaPackageID - the media package identifier

mediaPackageElementID - the media package element identifier

Returns:

the media package element contents

Throws:

NotFoundException - if the media package element can't be found

IOException - if there is a problem reading the data

See Also:

• WorkingFileRepository.get(java.lang.String, java.lang.String)

getCollectionURI

public URI getCollectionURI(String collectionID,
 String fileName)

Get the URL for a file stored under the given collection.

Specified by:

getCollectionURI in interface WorkingFileRepository

Parameters:

collectionID - the collection identifier

fileName - the file name

Returns:

the file's uri

See Also:

• WorkingFileRepository.getCollectionURI(java.lang.String, java.lang.String)

getURI

public URI getURI(String mediaPackageID,
 String mediaPackageElementID)

Get the URL for a file stored under the given media package and element IDs. This may be called for mediapackages, elements, or files that have not yet been stored in the repository.

Specified by:

getURI in interface WorkingFileRepository

Parameters:

mediaPackageID - the media package identifier

mediaPackageElementID - the media package element identifier

Returns:

the URI to this resource

See Also:

• WorkingFileRepository.getURI(java.lang.String, java.lang.String)

getURI

public URI getURI(String mediaPackageID,
 String mediaPackageElementID,
 String fileName)

Get the URL for a file stored under the given media package and element IDs. This may be called for mediapackages, elements, or files that have not yet been stored in the repository.

Specified by:

getURI in interface WorkingFileRepository

Parameters:

mediaPackageID - the media package identifier

mediaPackageElementID - the media package element identifier

fileName - the file name

Returns:

the URI to this resource

See Also:

• WorkingFileRepository.getURI(java.lang.String, java.lang.String, java.lang.String)

put

public URI put(String mediaPackageID,
 String mediaPackageElementID,
 String filename,
 InputStream in)
        throws IOException

Store the data stream under the given media package and element IDs with filename as name of the file.

Specified by:

put in interface WorkingFileRepository

Parameters:

mediaPackageID - the media package identifier

mediaPackageElementID - the media package element identifier

filename - the file name to use

in - the input stream

Returns:

The URL to access this file

Throws:

IOException - if the input stream cannot be accessed or the element cannot be written to the repository

See Also:

• WorkingFileRepository.put(java.lang.String, java.lang.String, java.lang.String, java.io.InputStream)

createMd5

protected File createMd5(File f)
                  throws IOException

Creates a file containing the md5 hash for the contents of a source file.

Parameters:

f - the source file containing the data to hash

Throws:

IOException - if the hash cannot be created

getSourceFile

protected File getSourceFile(File md5File)

Gets the file handle for a source file from its md5 file.

Parameters:

md5File - The md5 file

Returns:

The source file

checkPathSafe

protected void checkPathSafe(String id)

getFile

protected File getFile(String mediaPackageID,
 String mediaPackageElementID)
                throws IllegalStateException,
NotFoundException

Returns the file to the media package element.

Parameters:

mediaPackageID - the media package identifier

mediaPackageElementID - the media package element identifier

Returns:

the file or null if no such element exists

Throws:

IllegalStateException - if more than one matching elements were found

NotFoundException - if the file cannot be found in the Working File Repository

getFileFromCollection

public File getFileFromCollection(String collectionId,
 String fileName)
                           throws NotFoundException,
IllegalArgumentException

Returns the file from the given collection.

Parameters:

collectionId - the collection identifier

fileName - the file name

Returns:

the file

Throws:

NotFoundException - if either the collection or the file don't exist

IllegalArgumentException

getCollectionSize

public long getCollectionSize(String id)
                       throws NotFoundException

Throws:

NotFoundException

getFromCollection

public InputStream getFromCollection(String collectionId,
 String fileName)
                              throws NotFoundException,
IOException

Throws:

NotFoundException

IOException

putInCollection

public URI putInCollection(String collectionId,
 String fileName,
 InputStream in)
                    throws IOException

Puts a file into a collection, overwriting the existing file if present.

Specified by:

putInCollection in interface WorkingFileRepository

Parameters:

collectionId - The collection identifier

fileName - The filename to use in storing the input stream

in - the data to store

Returns:

The URI identifying the file

Throws:

IOException - if the hash can't be created

See Also:

• WorkingFileRepository.putInCollection(java.lang.String, java.lang.String, java.io.InputStream)

copyTo

public URI copyTo(String fromCollection,
 String fromFileName,
 String toMediaPackage,
 String toMediaPackageElement,
 String toFileName)
           throws NotFoundException,
IOException

Throws:

NotFoundException

IOException

moveTo

public URI moveTo(String fromCollection,
 String fromFileName,
 String toMediaPackage,
 String toMediaPackageElement,
 String toFileName)
           throws NotFoundException,
IOException

Moves a file from a collection into a mediapackage

Specified by:

moveTo in interface WorkingFileRepository

Parameters:

fromCollection - The collection holding the file

fromFileName - The filename

toMediaPackage - The media package ID to move the file into

toMediaPackageElement - the media package element ID of the file

toFileName - the name of the resulting file

Returns:

the URI pointing to the file's new location

Throws:

NotFoundException

IOException

See Also:

• WorkingFileRepository.moveTo(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

deleteFromCollection

public boolean deleteFromCollection(String collectionId,
 String fileName,
 boolean removeCollection)
                             throws IOException

Removes a file from a collection, and the parent folder if empty

Specified by:

deleteFromCollection in interface WorkingFileRepository

Parameters:

collectionId - the collection identifier

fileName - the filename to remove

removeCollection - remove the parent collection folder if empty

Returns:

true if the file existed and was removed

Throws:

IOException

See Also:

• WorkingFileRepository.deleteFromCollection(java.lang.String, java.lang.String,boolean)

deleteFromCollection

public boolean deleteFromCollection(String collectionId,
 String fileName)
                             throws IOException

Removes a file from a collection

Specified by:

deleteFromCollection in interface WorkingFileRepository

Parameters:

collectionId - the collection identifier

fileName - the filename to remove

Returns:

true if the file existed and was removed

Throws:

IOException

See Also:

• WorkingFileRepository.deleteFromCollection(java.lang.String, java.lang.String)

getCollectionContents

public URI[] getCollectionContents(String collectionId)
                            throws NotFoundException

Gets the URIs of the members of this collection

Specified by:

getCollectionContents in interface WorkingFileRepository

Parameters:

collectionId - the collection identifier

Returns:

the URIs for each member of the collection

Throws:

NotFoundException - if the collectionId does not exist

See Also:

• WorkingFileRepository.getCollectionContents(java.lang.String)

getTotalSpace

public Option<Long> getTotalSpace()

Gets the total space of storage in Bytes

Specified by:

getTotalSpace in interface StorageUsage

Returns:

Number of all bytes in storage

See Also:

• StorageUsage.getTotalSpace()

getUsableSpace

public Option<Long> getUsableSpace()

Gets the available space of storage in Bytes This is free storage that is not reserved

Specified by:

getUsableSpace in interface StorageUsage

Returns:

Number of available bytes in storage

See Also:

• StorageUsage.getUsableSpace()

getUsedSpace

public Option<Long> getUsedSpace()

Gets the used space of storage in Bytes

Specified by:

getUsedSpace in interface StorageUsage

Returns:

Number of used bytes in storage

See Also:

• StorageUsage.getUsedSpace()

getDiskSpace

public String getDiskSpace()

A textual representation of available and total storage

Specified by:

getDiskSpace in interface WorkingFileRepository

Returns:

Percentage and numeric values of used storage space

See Also:

• WorkingFileRepository.getDiskSpace()

cleanupOldFilesFromCollection

public boolean cleanupOldFilesFromCollection(String collectionId,
 long days)
                                      throws IOException

Cleans up collection files older than the number of days passed.

Specified by:

cleanupOldFilesFromCollection in interface WorkingFileRepository

Parameters:

collectionId - the collection identifier

days - files older than that will be deleted

Throws:

IOException

See Also:

• WorkingFileRepository.cleanupOldFilesFromCollection(java.lang.String, long)

cleanupOldFilesFromMediaPackage

public boolean cleanupOldFilesFromMediaPackage(long days)
                                        throws IOException

Description copied from interface: WorkingFileRepository

Cleans up media files older than the number of days passed.

Specified by:

cleanupOldFilesFromMediaPackage in interface WorkingFileRepository

Parameters:

days - files older than that will be deleted

Throws:

IOException

getPathPrefix

public String getPathPrefix()

Returns the prefix to the working file repository file system root directory.

Specified by:

getPathPrefix in interface PathMappable

Returns:

the root path on the file system

See Also:

• PathMappable.getPathPrefix()

getUrlPrefix

public String getUrlPrefix()

Returns the repository's base url.

Specified by:

getUrlPrefix in interface PathMappable

Returns:

the base url

See Also:

• PathMappable.getUrlPrefix()

getBaseUri

public URI getBaseUri()

Gets the base URI for this service.

Specified by:

getBaseUri in interface WorkingFileRepository

Returns:

The base URI

See Also:

• WorkingFileRepository.getBaseUri()

setRemoteServiceManager

public void setRemoteServiceManager(ServiceRegistry remoteServiceManager)

Sets the remote service manager.

Parameters:

remoteServiceManager -

setSecurityService

public void setSecurityService(SecurityService securityService)