net.bluemind.filehosting.api

Interface IFileHosting

All Known Implementing Classes:

FileHostingService, FileHostingTestService

@Path(value="/filehosting/{domainUid}")
public interface IFileHosting

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.
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

Method Detail

getConfiguration

@GET
 @Path(value="_config")
Configuration getConfiguration()
                                                     throws ServerFault

Retrieves the configuration

Returns:

the Filehosting service configuration

Throws:

ServerFault - common error object

list

@GET
 @Path(value="_list")
java.util.List<FileHostingItem> list(@QueryParam(value="path")
                                                                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 - common error object

find

@GET
 @Path(value="_find")
java.util.List<FileHostingItem> find(@QueryParam(value="query")
                                                                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 - common error object

exists

@GET
 @Path(value="{path}/_exists")
boolean exists(@PathParam(value="path")
                                                   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

get

@GET
 @Path(value="{path}/_content")
Stream get(@PathParam(value="path")
                                                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 - common error object

share

@GET
 @Path(value="_share")
FileHostingPublicLink share(@QueryParam(value="path")
                                                        java.lang.String path,
                                                        @QueryParam(value="downloadLimit")
                                                        java.lang.Integer downloadLimit,
                                                        @QueryParam(value="expirationDate")
                                                        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 - common error object

unShare

@DELETE
 @Path(value="{url}/unshare")
void unShare(@PathParam(value="url")
                                                   java.lang.String url)
                                            throws ServerFault

Remove a public link

Parameters:

url - the share url

Throws:

ServerFault - common error object

store

@PUT
 @Path(value="{path}")
void store(@PathParam(value="path")
                                       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 - common error object

delete

@DELETE
 @Path(value="{path}")
void delete(@PathParam(value="path")
                                           java.lang.String path)
                                    throws ServerFault

Deletes a document

Parameters:

path - the relative path in the file hosting repository

Throws:

ServerFault - common error object

info

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

Retrieves informations about the filehosting implementation

Throws:

ServerFault - common error object

getComplete

@GET
 @Path(value="{uid}/_complete")
FileHostingItem getComplete(@PathParam(value="uid")
                                                                 java.lang.String uid)
                                                          throws ServerFault

Retrieves an entity from the file hosting repository

Parameters:

uid - the entity uid

Returns:

the document data

Throws:

ServerFault - common error object

getSharedFile

@GET
 @Path(value="{uid}/_public")
Stream getSharedFile(@PathParam(value="uid")
                                                        java.lang.String uid)
                                                 throws ServerFault

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

Parameters:

uid - the document uid

Returns:

the document data

Throws:

ServerFault - common error object