net.bluemind.filehosting.service.export

Interface IFileHostingService

All Known Implementing Classes:

FileSystemFileHostingService, WebDavFileHostingService, WebDavTestImpl

public interface IFileHostingService

Method Summary

Modifier and Type	Method and Description
void	delete(SecurityContext context, java.lang.String path) Deletes a document
boolean	exists(SecurityContext context, java.lang.String path) Checks if a file exists
java.util.List<FileHostingItem>	find(SecurityContext context, java.lang.String query) Finds items in the file hosting repository
Stream	get(SecurityContext context, java.lang.String path) Retrieves a document from the file hosting repository
FileHostingItem	getComplete(SecurityContext context, java.lang.String uid) Deprecated.
Stream	getSharedFile(SecurityContext context, java.lang.String uid) Deprecated.
FileHostingInfo	info(SecurityContext context) Retrieves informations about the filehosting implementation
default boolean	isDefaultImplementation()
java.util.List<FileHostingItem>	list(SecurityContext context, java.lang.String path) Lists files and folders.
FileHostingPublicLink	share(SecurityContext context, 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(SecurityContext context, java.lang.String path, Stream document) Update/insert a document
default boolean	supports(SecurityContext context) Checks, if filehosting operations are available using the provided context
void	unShare(SecurityContext context, java.lang.String url) Remove a public link

Method Detail

isDefaultImplementation

default boolean isDefaultImplementation()

supports

default boolean supports(SecurityContext context)

Checks, if filehosting operations are available using the provided context

Parameters:

context -

Returns:

list

java.util.List<FileHostingItem> list(SecurityContext context,
                                     java.lang.String path)
                              throws ServerFault

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

Parameters:

path - the folder path

Returns:

the files and folders found under this path

Throws:

ServerFault

find

java.util.List<FileHostingItem> find(SecurityContext context,
                                     java.lang.String query)
                              throws ServerFault

Finds items in the file hosting repository

Parameters:

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

Returns:

all items matching the query

Throws:

ServerFault

get

Stream get(SecurityContext context,
           java.lang.String path)
    throws ServerFault

Retrieves a document from the file hosting repository

Parameters:

path - the relative path to the document

Returns:

the document data

Throws:

ServerFault

exists

boolean exists(SecurityContext context,
               java.lang.String path)
        throws ServerFault

Checks if a file exists

Parameters:

path - the relative path to the document

Returns:

true if the file exists, false otherwise

Throws:

ServerFault - common error object

share

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

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

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

unShare

void unShare(SecurityContext context,
             java.lang.String url)
      throws ServerFault

Remove a public link

Parameters:

context - the securityContext

url - the share url

Throws:

ServerFault

store

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

Update/insert a document

Parameters:

path - the relative path in the file hosting repository

document - the document data

Throws:

ServerFault

delete

void delete(SecurityContext context,
            java.lang.String path)
     throws ServerFault

Deletes a document

Parameters:

path - the relative path in the file hosting repository

Throws:

ServerFault

getComplete

@Deprecated
FileHostingItem getComplete(SecurityContext context,
                                        java.lang.String uid)
                                 throws ServerFault

Deprecated.

Retrieves an entity from the file hosting repository

Parameters:

uid - the entity uid

Returns:

the document data

Throws:

ServerFault

getSharedFile

@GET
 @Path(value="{path}/_public")
 @Deprecated
Stream getSharedFile(SecurityContext context,
                                                                      java.lang.String uid)
                                                               throws ServerFault

Deprecated.

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

Parameters:

uid - the document uid

Returns:

the document data

Throws:

ServerFault

info

@GET
 @Path(value="_info")
FileHostingInfo info(SecurityContext context)
                                         throws ServerFault

Retrieves informations about the filehosting implementation

Throws:

ServerFault