de.deepamehta.plugins.files
Class FilesPlugin

java.lang.Object
  de.deepamehta.core.osgi.PluginActivator
      de.deepamehta.plugins.files.FilesPlugin

All Implemented Interfaces:

de.deepamehta.core.osgi.PluginContext, de.deepamehta.core.service.event.ResourceRequestFilterListener, de.deepamehta.core.service.EventListener, FilesService, org.osgi.framework.BundleActivator

public class FilesPlugin
extends de.deepamehta.core.osgi.PluginActivator
implements FilesService, de.deepamehta.core.service.event.ResourceRequestFilterListener

Field Summary

static de.deepamehta.core.service.DeepaMehtaEvent	CHECK_DISK_QUOTA
static int	DISK_QUOTA_MB
static String	FILE_REPOSITORY_PATH
static boolean	FILE_REPOSITORY_PER_WORKSPACE

Fields inherited from class de.deepamehta.core.osgi.PluginActivator

bundle, dms

Constructor Summary

FilesPlugin()

Method Summary

de.deepamehta.core.Topic	createFile(InputStream in, String path) Creates a file in the file repository, and creates a corresponding File topic.
void	createFolder(String folderName, String path) Creates a folder in the file repository.
de.deepamehta.core.Topic	getChildFileTopic(long folderTopicId, String path) Returns the File topic representing the file at a given repository path.
de.deepamehta.core.Topic	getChildFolderTopic(long folderTopicId, String path) Returns the Folder topic representing the folder at a given repository path.
DirectoryListing	getDirectoryListing(String path)
File	getFile(long fileTopicId) Accesses a file/directory in the file repository that is represented by the given File/Folder topic.
File	getFile(String path) Accesses a file/directory in the file repository by the given repository path.
de.deepamehta.core.Topic	getFileTopic(String path) Returns the File topic representing the file at a given repository path.
de.deepamehta.core.Topic	getFolderTopic(String path) Returns the Folder topic representing the folder at a given repository path.
String	getRepositoryPath(URL url) Checks if the given URL refers to the file repository of this DeepaMehta installation.
ResourceInfo	getResourceInfo(String path)
void	init()
void	openFile(long fileTopicId)
void	preInstall()
String	repoPath(File path) Maps an absolute path to a repository path.
String	repoPath(javax.servlet.http.HttpServletRequest request) Returns the repository path of a filerepo request.
void	resourceRequestFilter(javax.servlet.http.HttpServletRequest request)
void	shutdown()
StoredFile	storeFile(UploadedFile file, String path) Receives an uploaded file, stores it in the file repository, and creates a corresponding File topic.

Methods inherited from class de.deepamehta.core.osgi.PluginActivator

getBundleContext, getPluginName, getStaticResource, getUri, publishFileSystem, serviceArrived, serviceGone, setCoreService, start, stop, toString

Methods inherited from class java.lang.Object

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

Field Detail

FILE_REPOSITORY_PATH

public static final String FILE_REPOSITORY_PATH

FILE_REPOSITORY_PER_WORKSPACE

public static final boolean FILE_REPOSITORY_PER_WORKSPACE

DISK_QUOTA_MB

public static final int DISK_QUOTA_MB

CHECK_DISK_QUOTA

public static de.deepamehta.core.service.DeepaMehtaEvent CHECK_DISK_QUOTA

Constructor Detail

FilesPlugin

public FilesPlugin()

Method Detail

getFileTopic

public de.deepamehta.core.Topic getFileTopic(String path)

Description copied from interface: FilesService

Returns the File topic representing the file at a given repository path. If no such File topic exists it is created.

Specified by:

getFileTopic in interface FilesService

Parameters:

path - A repository path. Relative to the repository base path. Must begin with slash, no slash at the end.

Returns:

The File topic. Its child topics ("File Name", "Path", "Media Type", "Size") are included.

getFolderTopic

public de.deepamehta.core.Topic getFolderTopic(String path)

Description copied from interface: FilesService

Returns the Folder topic representing the folder at a given repository path. If no such Folder topic exists it is created.

Specified by:

getFolderTopic in interface FilesService

Parameters:

path - A repository path. Relative to the repository base path. Must begin with slash, no slash at the end.

Returns:

The Folder topic. Its child topics ("Folder Name", "Path") are included.

getChildFileTopic

public de.deepamehta.core.Topic getChildFileTopic(long folderTopicId,
                                                  String path)

Description copied from interface: FilesService

Returns the File topic representing the file at a given repository path. If no such File topic exists it is created.

Creates an association (type "Aggregation") between the File topic (role type "Child") and its parent Folder topic (role type "Parent"), if not exists already.

Specified by:

getChildFileTopic in interface FilesService

Parameters:

folderTopicId - ID of the parent Folder topic.

path - A repository path. Relative to the repository base path. Must begin with slash, no slash at the end.

Returns:

The File topic. Its child topics ("File Name", "Path", "Media Type", "Size") are included.

getChildFolderTopic

public de.deepamehta.core.Topic getChildFolderTopic(long folderTopicId,
                                                    String path)

Description copied from interface: FilesService

Returns the Folder topic representing the folder at a given repository path. If no such Folder topic exists it is created.

Creates an association (type "Aggregation") between the Folder topic (role type "Child") and its parent Folder topic (role type "Parent"), if not exists already.

Specified by:

getChildFolderTopic in interface FilesService

Parameters:

folderTopicId - ID of the parent Folder topic.

path - A repository path. Relative to the repository base path. Must begin with slash, no slash at the end.

Returns:

The Folder topic. Its child topics ("Folder Name", "Path") are included.

storeFile

public StoredFile storeFile(UploadedFile file,
                            String path)

Description copied from interface: FilesService

Receives an uploaded file, stores it in the file repository, and creates a corresponding File topic.

Specified by:

storeFile in interface FilesService

path - The directory where to store the uploaded file. A repository path. Relative to the repository base path. Must begin with slash, no slash at the end. The directory must exist.

Returns:

a StoredFile object which holds 2 information: the name of the uploaded file, and the ID of the created File topic.

createFile

public de.deepamehta.core.Topic createFile(InputStream in,
                                           String path)

Description copied from interface: FilesService

Creates a file in the file repository, and creates a corresponding File topic.

Specified by:

createFile in interface FilesService

Parameters:

in - The input stream the file content is read from.

path - The path and filename of the file to be created. A repository path. Relative to the repository base path. Must begin with slash, no slash at the end. If that file exists already it is overwritten. ### TODO: rethink overwriting

Returns:

the File topic that corresponds to the created file.

createFolder

public void createFolder(String folderName,
                         String path)

Description copied from interface: FilesService

Creates a folder in the file repository. Note: to corresponding Folder topic is created.

Specified by:

createFolder in interface FilesService

path - The directory where to create the folder. A repository path. Relative to the repository base path. Must begin with slash, no slash at the end.

getResourceInfo

public ResourceInfo getResourceInfo(String path)

Specified by:

getResourceInfo in interface FilesService

getDirectoryListing

public DirectoryListing getDirectoryListing(String path)

Specified by:

getDirectoryListing in interface FilesService

getRepositoryPath

public String getRepositoryPath(URL url)

Description copied from interface: FilesService

Checks if the given URL refers to the file repository of this DeepaMehta installation.

Specified by:

getRepositoryPath in interface FilesService

Returns:

the refered file's/directory's repository path, or null if the URL does not refer to the file repository of this DeepaMehta installation.

getFile

public File getFile(String path)

Description copied from interface: FilesService

Accesses a file/directory in the file repository by the given repository path. Note: this method doesn't require the corresponding File/Folder topic to exist.

Specified by:

getFile in interface FilesService

Parameters:

path - A repository path. Relative to the repository base path. Must begin with slash, no slash at the end.

getFile

public File getFile(long fileTopicId)

Description copied from interface: FilesService

Accesses a file/directory in the file repository that is represented by the given File/Folder topic.

Specified by:

getFile in interface FilesService

openFile

public void openFile(long fileTopicId)

Specified by:

openFile in interface FilesService

preInstall

public void preInstall()

Specified by:

preInstall in interface de.deepamehta.core.osgi.PluginContext

Overrides:

preInstall in class de.deepamehta.core.osgi.PluginActivator

init

public void init()

Specified by:

init in interface de.deepamehta.core.osgi.PluginContext

Overrides:

init in class de.deepamehta.core.osgi.PluginActivator

shutdown

public void shutdown()

Specified by:

shutdown in interface de.deepamehta.core.osgi.PluginContext

Overrides:

shutdown in class de.deepamehta.core.osgi.PluginActivator

resourceRequestFilter

public void resourceRequestFilter(javax.servlet.http.HttpServletRequest request)

Specified by:

resourceRequestFilter in interface de.deepamehta.core.service.event.ResourceRequestFilterListener

repoPath

public String repoPath(File path)

Maps an absolute path to a repository path.

Parameters:

path - An absolute path.

repoPath

public String repoPath(javax.servlet.http.HttpServletRequest request)

Returns the repository path of a filerepo request.

Returns:

The repository path or null if the request is not a filerepo request.