Package org.opencastproject.staticfiles.impl

Class StaticFileServiceImpl

java.lang.Object

org.opencastproject.staticfiles.impl.StaticFileServiceImpl

All Implemented Interfaces:

StaticFileService

public class StaticFileServiceImpl
extends Object
implements StaticFileService

Stores and retrieves static file resources.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	STATICFILES_ROOT_DIRECTORY_KEY	The key to find the root directory for the static file service in the OSGi properties.

Constructor Summary

Constructors

Constructor	Description
StaticFileServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	OSGI callback for activating this component
void	deactivate()	Callback from OSGi on service deactivation.
void	deleteFile(String uuid)	Deletes a static file.
Long	getContentLength(String uuid)	Returns the content length of a file stored in the static file service.
InputStream	getFile(String uuid)	Returns an InputStream to read a file from the static file service by its UUID.
String	getFileName(String uuid)	Returns the original filename of a file stored in the static file service.
void	persistFile(String uuid)	Persists a file that was previously uploaded to the temporary storage section with #storeFile(String, InputStream) for long-term usage.
void	setOrganizationDirectoryService(OrganizationDirectoryService directoryService)	OSGi DI
void	setSecurityService(SecurityService securityService)	OSGi DI
String	storeFile(String filename, InputStream inputStream)	Stores a file in the temporary storage section of the static file service.

Methods inherited from class java.lang.Object

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

Field Details

STATICFILES_ROOT_DIRECTORY_KEY

public static final String STATICFILES_ROOT_DIRECTORY_KEY

The key to find the root directory for the static file service in the OSGi properties.

See Also:

• Constant Field Values

Constructor Details

StaticFileServiceImpl

public StaticFileServiceImpl()

Method Details

activate

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

OSGI callback for activating this component

Parameters:

cc - the osgi component context

deactivate

public void deactivate()

Callback from OSGi on service deactivation.

setSecurityService

public void setSecurityService(SecurityService securityService)

OSGi DI

setOrganizationDirectoryService

public void setOrganizationDirectoryService(OrganizationDirectoryService directoryService)

OSGi DI

storeFile

public String storeFile(String filename,
 InputStream inputStream)
                 throws IOException

Description copied from interface: StaticFileService

Stores a file in the temporary storage section of the static file service. Make sure you call StaticFileService.persistFile(String) if you want to persist a file durable. A file that is stored in the temporary storage section may be removed at any time without notice!

Specified by:

storeFile in interface StaticFileService

Parameters:

filename - The filename and extension for the file.

inputStream - The InputStream that represents the file itself.

Returns:

A UUID that represents the static file.

Throws:

IOException - Thrown if there is a problem storing the file.

getFile

public InputStream getFile(String uuid)
                    throws NotFoundException,
IOException

Description copied from interface: StaticFileService

Returns an InputStream to read a file from the static file service by its UUID.

Specified by:

getFile in interface StaticFileService

Parameters:

uuid - The UUID of the file.

Returns:

The input stream to read the file

Throws:

NotFoundException - Thrown if the file cannot be found.

IOException - If the file could not be read.

persistFile

public void persistFile(String uuid)
                 throws NotFoundException,
IOException

Description copied from interface: StaticFileService

Persists a file that was previously uploaded to the temporary storage section with #storeFile(String, InputStream) for long-term usage.

Specified by:

persistFile in interface StaticFileService

Parameters:

uuid - The UUID of the file to persist.

Throws:

NotFoundException - If the file could not be found.

IOException

deleteFile

public void deleteFile(String uuid)
                throws NotFoundException,
IOException

Description copied from interface: StaticFileService

Deletes a static file.

Specified by:

deleteFile in interface StaticFileService

Parameters:

uuid - The uuid of the static file.

Throws:

NotFoundException - if the file cannot be found.

IOException

getFileName

public String getFileName(String uuid)
                   throws NotFoundException

Description copied from interface: StaticFileService

Returns the original filename of a file stored in the static file service.

Specified by:

getFileName in interface StaticFileService

Parameters:

uuid - The UUID of the file.

Returns:

The filename.

Throws:

NotFoundException - If the file with the given UUID was not found.

getContentLength

public Long getContentLength(String uuid)
                      throws NotFoundException

Description copied from interface: StaticFileService

Returns the content length of a file stored in the static file service.

Specified by:

getContentLength in interface StaticFileService

Parameters:

uuid - The UUID of the file.

Returns:

The content length.

Throws:

NotFoundException - If the file with the given UUID was not found.