net.bluemind.filehosting.service.internal

Class FileHostingService

java.lang.Object

net.bluemind.filehosting.service.internal.FileHostingService

All Implemented Interfaces:

IFileHosting

Direct Known Subclasses:

FileHostingTestService

public class FileHostingService
extends java.lang.Object
implements IFileHosting

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<IFileHostingService>	delegates

Constructor Summary

Constructors

Constructor and Description
FileHostingService(SecurityContext context, java.lang.String domainUid)

Method Summary

Modifier and Type	Method and Description
void	delete(java.lang.String path) Deletes a document
boolean	exists(java.lang.String path) Checks if a file exists
java.util.List<FileHostingItem>	find(java.lang.String query) Finds items in the file hosting repository
Stream	get(java.lang.String path) Retrieves a document from the file hosting repository
FileHostingItem	getComplete(java.lang.String uid) Retrieves an entity from the file hosting repository
Configuration	getConfiguration() Retrieves the configuration
Stream	getSharedFile(java.lang.String uid) Retrieves a document from the file hosting repository by its public uid
FileHostingInfo	info() Retrieves informations about the filehosting implementation
java.util.List<FileHostingItem>	list(java.lang.String path) Lists files and folders.
protected java.util.List<IFileHostingService>	searchExtensionPoints()
FileHostingPublicLink	share(java.lang.String path, java.lang.Integer downloadLimit, java.lang.String expirationDate) Retrieves a public URL to the document in the file hosting repository
void	store(java.lang.String path, Stream document) Update/insert a document
void	unShare(java.lang.String url) Remove a public link

Methods inherited from class java.lang.Object

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

Field Detail

delegates

public final java.util.List<IFileHostingService> delegates

Constructor Detail

FileHostingService

public FileHostingService(SecurityContext context,
                          java.lang.String domainUid)

Method Detail

searchExtensionPoints

protected java.util.List<IFileHostingService> searchExtensionPoints()

list

public java.util.List<FileHostingItem> list(java.lang.String path)
                                     throws ServerFault

Description copied from interface: IFileHosting

Lists files and folders. The listing contains only non-recursive items

Specified by:

list in interface IFileHosting

Parameters:

path - the folder path

Returns:

the files and folders found under this path

Throws:

ServerFault - common error object

find

public java.util.List<FileHostingItem> find(java.lang.String query)
                                     throws ServerFault

Description copied from interface: IFileHosting

Finds items in the file hosting repository

Specified by:

find in interface IFileHosting

Parameters:

query - the query. The format of the query is repository dependent

Returns:

all items matching the query

Throws:

ServerFault - common error object

get

public Stream get(java.lang.String path)
           throws ServerFault

Description copied from interface: IFileHosting

Retrieves a document from the file hosting repository

Specified by:

get in interface IFileHosting

Parameters:

path - the relative path to the document

Returns:

the document data

Throws:

ServerFault - common error object

getComplete

public FileHostingItem getComplete(java.lang.String uid)
                            throws ServerFault

Description copied from interface: IFileHosting

Retrieves an entity from the file hosting repository

Specified by:

getComplete in interface IFileHosting

Parameters:

uid - the entity uid

Returns:

the document data

Throws:

ServerFault - common error object

getSharedFile

public Stream getSharedFile(java.lang.String uid)
                     throws ServerFault

Description copied from interface: IFileHosting

Retrieves a document from the file hosting repository by its public uid

Specified by:

getSharedFile in interface IFileHosting

Parameters:

uid - the document uid

Returns:

the document data

Throws:

ServerFault - common error object

share

public FileHostingPublicLink share(java.lang.String path,
                                   java.lang.Integer downloadLimit,
                                   java.lang.String expirationDate)
                            throws ServerFault

Description copied from interface: IFileHosting

Retrieves a public URL to the document in the file hosting repository

Specified by:

share in interface IFileHosting

Parameters:

path - the relative path to the document

downloadLimit - the number of times the file can be downloaded, <= 0 if unlimited

expirationDate - a ISO-8601 compliant date, null otherwise

Returns:

the URL pointing to this document

Throws:

ServerFault - common error object

unShare

public void unShare(java.lang.String url)
             throws ServerFault

Description copied from interface: IFileHosting

Remove a public link

Specified by:

unShare in interface IFileHosting

Parameters:

url - the share url

Throws:

ServerFault - common error object

store

public void store(java.lang.String path,
                  Stream document)
           throws ServerFault

Description copied from interface: IFileHosting

Update/insert a document

Specified by:

store in interface IFileHosting

Parameters:

path - the relative path in the file hosting repository

document - the document data

Throws:

ServerFault - common error object

delete

public void delete(java.lang.String path)
            throws ServerFault

Description copied from interface: IFileHosting

Deletes a document

Specified by:

delete in interface IFileHosting

Parameters:

path - the relative path in the file hosting repository

Throws:

ServerFault - common error object

exists

public boolean exists(java.lang.String path)
               throws ServerFault

Description copied from interface: IFileHosting

Checks if a file exists

Specified by:

exists in interface IFileHosting

Parameters:

path - the relative path to the document

Returns:

true if the file exists, false otherwise

Throws:

ServerFault - common error object

info

public FileHostingInfo info()
                     throws ServerFault

Description copied from interface: IFileHosting

Retrieves informations about the filehosting implementation

Specified by:

info in interface IFileHosting

Throws:

ServerFault - common error object

getConfiguration

public Configuration getConfiguration()
                               throws ServerFault

Description copied from interface: IFileHosting

Retrieves the configuration

Specified by:

getConfiguration in interface IFileHosting

Returns:

the Filehosting service configuration

Throws:

ServerFault - common error object