software.coolstuff.springframework.owncloud.service.api

Interface OwncloudResourceService

All Known Subinterfaces:

OwncloudLocalResourceService

public interface OwncloudResourceService

Access Files and Directories on the Owncloud.

Only Files and Directories of the User which has been authenticated by the OwncloudAuthenticationProvider can be accessed.

Since:

1.2.0

Method Summary

Modifier and Type	Method and Description
OwncloudResource	createDirectory(URI directory) Create a new Directory
void	delete(OwncloudResource resource) Delete a Resource.
Optional<OwncloudResource>	find(URI path) Find a specific OwncloudResource specified by the Path of the URI
InputStream	getInputStream(OwncloudFileResource resource) Get the Content of a File Resource
OutputStream	getOutputStream(OwncloudFileResource resource) Overwrite the Content of an existing File Resource
OutputStream	getOutputStream(URI path, org.springframework.http.MediaType mediaType) Create a new File Resource or overwrite the Content of an existing File Resource
OwncloudQuota	getQuota() Get the actual Quota Information of the authenticated User
List<OwncloudResource>	list(URI relativeTo) Get all Files and Directories relative to the given Path of the URI
default List<OwncloudResource>	listRoot() Get all Files and Directories of the Root Directory of the User

Method Detail

listRoot

default List<OwncloudResource> listRoot()

Get all Files and Directories of the Root Directory of the User

Returns:

List of Resources relative to the User Root Directory

list

List<OwncloudResource> list(URI relativeTo)

Get all Files and Directories relative to the given Path of the URI

Parameters:

relativeTo - Path relative to the User Root Directory

Returns:

List of Resources relative to the given Path

find

Optional<OwncloudResource> find(URI path)

Find a specific OwncloudResource specified by the Path of the URI

Parameters:

path - Path to a specific Resource (File or Directory)

Returns:

found OwncloudResource or Optional.empty() when the Resource has not been found

createDirectory

OwncloudResource createDirectory(URI directory)

Create a new Directory

Parameters:

directory - Path of the new Directory relative to the User Root Directory

Returns:

Resource Information of the created Directory

delete

void delete(OwncloudResource resource)

Delete a Resource.

Caution: When the Resource represents a Directory then all Contents of this Directory will be removed recursively.

Parameters:

resource - Directory or File Resource returned by listRoot(), list(URI) or find(URI)

See Also:

listRoot(), list(URI), find(URI)

getInputStream

InputStream getInputStream(OwncloudFileResource resource)

Get the Content of a File Resource

Parameters:

resource - File Resource returned by listRoot(), list(URI) or find(URI)

Returns:

Content of the File Resource

See Also:

listRoot(), list(URI), find(URI), OwncloudUtils.toOwncloudFileResource(OwncloudResource)

getOutputStream

OutputStream getOutputStream(OwncloudFileResource resource)

Overwrite the Content of an existing File Resource

Parameters:

resource - existing File Resource returned by listRoot(), list(URI) or find(URI)

Returns:

OutputStream to write a new Content

See Also:

listRoot(), list(URI), find(URI), OwncloudUtils.toOwncloudFileResource(OwncloudResource)

getOutputStream

OutputStream getOutputStream(URI path,
                             org.springframework.http.MediaType mediaType)

Create a new File Resource or overwrite the Content of an existing File Resource

Parameters:

path - Path of the new or existing File Resource

mediaType - Media Type of the new File Resource

Returns:

OutputStream to write a new Content

getQuota

OwncloudQuota getQuota()

Get the actual Quota Information of the authenticated User

Returns:

Quota of the authenticated User