com.suncode.plugin.framework

Interface PluginStore

public interface PluginStore

Interfejs umożliwiający przechowywanie dowolnych zasobów w lokalnej przestrzeni wtyczki. Każda wtyczka posiada własny PluginStore, a jego zawartość jest zachowywana pomiędzy uruchomieniami wtyczki lub systemu.
PluginStore przeznaczony jest głównie do przechowywania plików wykorzystywanych przez wtyczkę w przypadku, kiedy nie chcemy w tym celu wykorzystać bazy danych.

Author:

Cezary Kozar 27 paź 2014

Method Summary

Modifier and Type	Method and Description
void	clear() Czyści cały PluginStore usuwając wszystkie przechowywane w nim pliki.
void	delete(PluginStoreResource resource) Usuwa podany zasób
void	delete(String path) Usuwa zasób o podanej ścieżce.
Map<String,PluginStoreResource>	getStoredResources() Zwraca wszystkie zasoby przechowywane w tym store'rze.
PluginStoreResource	read(String path) Odczytuje zasób zapisany w tym store pod podaną ścieżką.
PluginStoreResource	store(String path, File file) Zapisuje podany plik.
PluginStoreResource	store(String path, File file, boolean overwrite) Zapisuje podany plik, nadpisując go w zależności od parametru.
PluginStoreResource	store(String path, InputStream inputStream) Zapisuje podany strumień.
PluginStoreResource	store(String path, InputStream inputStream, boolean overwrite) Zapisuje zawartość podanego strumienia w lokalnej przestrzeni wtyczki.
PluginStoreResource	store(String path, org.springframework.core.io.Resource resource) Zapisuje podany zasób.
PluginStoreResource	store(String path, org.springframework.core.io.Resource resource, boolean overwrite) Zapisuje podany zasób, nadpisując go w zależności od parametru.

Method Detail

getStoredResources

Map<String,PluginStoreResource> getStoredResources()

Zwraca wszystkie zasoby przechowywane w tym store'rze.

Returns:

mapa zasobów, w której klucz stanowi ścieżka do zasobu

store

PluginStoreResource store(String path,
                          InputStream inputStream)
                   throws IOException

Zapisuje podany strumień. Podana ścieżka nie może wskazywać na istniejący zasób.

Parameters:

path - ścieżka zasobu wewnątrz tego store'a

resource - zapisywany zasób

Returns:

zapisany zasób PluginStoreResource

Throws:

IOException

See Also:

store(String, InputStream, boolean)

store

PluginStoreResource store(String path,
                          InputStream inputStream,
                          boolean overwrite)
                   throws IOException

Zapisuje zawartość podanego strumienia w lokalnej przestrzeni wtyczki. Zasób identyfikowany jest przez podaną ścieżkę, która może być później wykorzystana do odczytu tego zasobu read(String).
Istnieje możliwość opcjonalnego nadpisania danych.

Parameters:

path - ścieżka zasobu wewnątrz tego store'a

inputStream - strumień wejściowy

overwrite - true jeżeli chcemy nadpisać zasób

Returns:

zapisany zasób PluginStoreResource

Throws:

IOException

store

PluginStoreResource store(String path,
                          org.springframework.core.io.Resource resource)
                   throws IOException

Zapisuje podany zasób. Podana ścieżka nie może wskazywać na istniejący zasób.

Parameters:

path - ścieżka zasobu wewnątrz tego store'a

resource - zapisywany zasób

Returns:

zapisany zasób PluginStoreResource

Throws:

IOException

See Also:

store(String, InputStream, boolean)

store

PluginStoreResource store(String path,
                          org.springframework.core.io.Resource resource,
                          boolean overwrite)
                   throws IOException

Zapisuje podany zasób, nadpisując go w zależności od parametru.

Parameters:

path - ścieżka zasobu wewnątrz tego store'a

resource - zapisywany zasób

overwrite - true jeżeli chcemy nadpisać zasób

Returns:

zapisany zasób PluginStoreResource

Throws:

IOException

See Also:

store(String, InputStream, boolean)

store

PluginStoreResource store(String path,
                          File file)
                   throws IOException

Zapisuje podany plik. Podana ścieżka nie może wskazywać na istniejący zasób.

Parameters:

path - ścieżka zasobu wewnątrz tego store'a

file - zapisywany plik

Returns:

zapisany zasób PluginStoreResource

Throws:

IOException

See Also:

store(String, InputStream, boolean)

store

PluginStoreResource store(String path,
                          File file,
                          boolean overwrite)
                   throws IOException

Zapisuje podany plik, nadpisując go w zależności od parametru.

Parameters:

path - ścieżka zasobu wewnątrz tego store'a

file - zapisywany plik

Returns:

zapisany zasób PluginStoreResource

Throws:

IOException

See Also:

store(String, InputStream, boolean)

read

PluginStoreResource read(String path)
                  throws IOException

Odczytuje zasób zapisany w tym store pod podaną ścieżką.

Parameters:

path - ścieżka zasobu PluginStoreResource.getPath()

Returns:

zapisany zasób PluginStoreResource lub null, jeżeli zasób nie istnieje

Throws:

IOException

delete

void delete(String path)

Usuwa zasób o podanej ścieżce.

Parameters:

path - ścieżka zasobu PluginStoreResource.getPath()

delete

void delete(PluginStoreResource resource)

Usuwa podany zasób

Parameters:

resource - zasób z tego store'a

clear

void clear()

Czyści cały PluginStore usuwając wszystkie przechowywane w nim pliki.