org.uberfire.backend.server.io.object

Interface ObjectStorage

All Known Implementing Classes:

ObjectStorageImpl

public interface ObjectStorage

Object Storage definition

Method Summary

Modifier and Type	Method and Description
void	delete(String path) Delete a path from the object storage if exists.
boolean	exists(String path) Checks if a path exists into the object storage.
Path	getPath(String first, String... path) Return a path based on the filesystem that is implemented for storage
void	init(String rootPath) Initialize the object storage.
<T> T	read(String path) Read the content of the path given
<T> void	write(String path, T value) Write an object into the object storage.

Method Detail

init

void init(String rootPath)

Initialize the object storage.

Parameters:

rootPath - The root path where is going to create the file system

exists

boolean exists(String path)

Checks if a path exists into the object storage.

Parameters:

path - the path to the stored object.

Returns:

true if exists that path into the storage else false.

read

<T> T read(String path)

Read the content of the path given

Parameters:

path - The path where the content is stored

Returns:

The content of the file unmarshalled

write

<T> void write(String path,
               T value)

Write an object into the object storage. That object is marshelled into JSON.

Parameters:

path - The path where the object is going to be written

value - The object itself

delete

void delete(String path)

Delete a path from the object storage if exists. That path contains the object stored.

Parameters:

path - The path to delete

getPath

Path getPath(String first,
             String... path)

Return a path based on the filesystem that is implemented for storage

Parameters:

first - the path string or initial part of the path string

path - additional strings to be joined to form the path string

Returns:

the path object that represents the path.