net.bluemind.filehosting.webdav.service

Class WebDavFileHostingService

java.lang.Object

net.bluemind.filehosting.webdav.service.WebDavFileHostingService

All Implemented Interfaces:

IFileHostingService

Direct Known Subclasses:

WebDavTestImpl

public abstract class WebDavFileHostingService
extends java.lang.Object
implements IFileHostingService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	WebDavFileHostingService.ConnectionContext

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
WebDavFileHostingService()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	createUri(java.lang.String path, WebDavFileHostingService.ConnectionContext connectionContext)
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) Retrieves an entity from the file hosting repository
protected abstract WebDavFileHostingService.ConnectionContext	getConnectionContext(SecurityContext context)
Stream	getSharedFile(SecurityContext context, java.lang.String uid) Retrieves a document from the file hosting repository by its public uid
abstract FileHostingInfo	info(SecurityContext context) Retrieves informations about the filehosting implementation
java.util.List<FileHostingItem>	list(SecurityContext context, java.lang.String path) Lists files and folders.
abstract 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
boolean	supports(SecurityContext context) Checks, if filehosting operations are available using the provided context
abstract void	unShare(SecurityContext context, 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

Methods inherited from interface net.bluemind.filehosting.service.export.IFileHostingService

isDefaultImplementation

Field Detail

logger

protected static final org.slf4j.Logger logger

Constructor Detail

WebDavFileHostingService

public WebDavFileHostingService()

Method Detail

getConnectionContext

protected abstract WebDavFileHostingService.ConnectionContext getConnectionContext(SecurityContext context)

info

public abstract FileHostingInfo info(SecurityContext context)

Description copied from interface: IFileHostingService

Retrieves informations about the filehosting implementation

Specified by:

info in interface IFileHostingService

share

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

Description copied from interface: IFileHostingService

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

Specified by:

share in interface IFileHostingService

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

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

Description copied from interface: IFileHostingService

Remove a public link

Specified by:

unShare in interface IFileHostingService

Parameters:

context - the securityContext

url - the share url

Throws:

ServerFault

supports

public boolean supports(SecurityContext context)

Description copied from interface: IFileHostingService

Checks, if filehosting operations are available using the provided context

Specified by:

supports in interface IFileHostingService

Returns:

list

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

Description copied from interface: IFileHostingService

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

Specified by:

list in interface IFileHostingService

path - the folder path

Returns:

the files and folders found under this path

Throws:

ServerFault

find

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

Description copied from interface: IFileHostingService

Finds items in the file hosting repository

Specified by:

find in interface IFileHostingService

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

Returns:

all items matching the query

Throws:

ServerFault

exists

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

Description copied from interface: IFileHostingService

Checks if a file exists

Specified by:

exists in interface IFileHostingService

path - the relative path to the document

Returns:

true if the file exists, false otherwise

Throws:

ServerFault - common error object

get

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

Description copied from interface: IFileHostingService

Retrieves a document from the file hosting repository

Specified by:

get in interface IFileHostingService

path - the relative path to the document

Returns:

the document data

Throws:

ServerFault

store

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

Description copied from interface: IFileHostingService

Update/insert a document

Specified by:

store in interface IFileHostingService

path - the relative path in the file hosting repository

document - the document data

Throws:

ServerFault

delete

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

Description copied from interface: IFileHostingService

Deletes a document

Specified by:

delete in interface IFileHostingService

path - the relative path in the file hosting repository

Throws:

ServerFault

getComplete

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

Description copied from interface: IFileHostingService

Retrieves an entity from the file hosting repository

Specified by:

getComplete in interface IFileHostingService

uid - the entity uid

Returns:

the document data

Throws:

ServerFault

getSharedFile

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

Description copied from interface: IFileHostingService

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

Specified by:

getSharedFile in interface IFileHostingService

uid - the document uid

Returns:

the document data

Throws:

ServerFault

createUri

protected java.lang.String createUri(java.lang.String path,
                                     WebDavFileHostingService.ConnectionContext connectionContext)