com.suncode.pwfl.archive

Interface ArchiveStorageService

public interface ArchiveStorageService

Umożliwia zarządzanie strukturą archiwum.

Author:

Paweł Rosolak 28-03-2013

Method Summary

Modifier and Type	Method and Description
void	createDevice(Device dev) Zapisuje urządzenie w bazie danych
void	createDirectory(Directory dir) Zapisuje katalog w bazie danych
void	deleteDevice(String devName) Usuwa urządzenie
void	deleteDirectory(Long dirId) Usuwa katalog po id
void	deleteDirectory(String dirName) Usuwa katalog
List<Directory>	findDirectoriesByCriteria(org.hibernate.criterion.DetachedCriteria dc) Wyszukuje katalogi
void	forceDeleteDeviceByName(String devName) Usuwa urządzenie, jeżeli zawiera katalogi to również są usuwane.
List<Device>	getAllDevices(String... joins) Pobiera listę wszystkich urządzeń
List<Directory>	getAllDirectories(String... joins) Pobiera listę wszystkich katalogów archiwum
List<Directory>	getChildDirectories(Directory dir) Pobiera podkatalogi
Device	getDevice(String name, String... joins) Pobiera urządzenie po nazwie
Device	getDeviceById(Long deviceId, String... joins) Pobiera urządzenie po id
Device	getDeviceForDocumentClass(Long dcId, String... joins) Pobiera urządzenia dla klasy dokumentów
Directory	getDirectory(Long id, String... joins) Pobiera katalog po id
Directory	getDirectory(String name, String... joins) Pobiera katalog po nazwie
Long	getDirectoryFreeSpaceFromDB(Directory dir) Zwraca ilość wolnego miejsca w katalogu.
Long	getDirectoryFreeSpaceOnDisc(Directory dir) Zwraca ilość wolnego miejsca w katalogu.
String	getDirectoryPath(Directory dir) Pobiera pełną ścieżkę do katalogu
Long	getDirectoryUsedSpaceFromDB(Directory dir) Zwraca ilość zajętego miejsca w katalogu.
Long	getDirectoryUsedSpaceOnDisc(Directory dir) Zwraca ilość zajętego miejsca w katalogu.
List<Directory>	getSubDirectories(Long dirId, String... joins) Pobiera wszystkie podkatalogi katalogu o podanym id
boolean	isRootDirectory(Directory dir) Sprawdza czy katalog jest katalogiem nadrzędnym
void	updateDevice(Device dev) Modyfikuje urządzenie
void	updateDirectory(Directory dir) Modyfikuje katalog

Method Detail

createDevice

void createDevice(Device dev)
           throws DeviceNotExistOnDiskException

Zapisuje urządzenie w bazie danych

Parameters:

dev - Definicja urządzenia

Throws:

DeviceNotExistOnDiskException - Jeżeli na dysku nie znaleziono ścieżki do katalogu urządzenia

createDirectory

void createDirectory(Directory dir)
              throws DeviceNotFoundException,
                     NotEnoughSpaceOnDeviceException

Zapisuje katalog w bazie danych

Parameters:

dir - Definicja katalogu

Throws:

DeviceNotFoundException - Jeżeli nie znaleziono urządzenia na którym ma zostać utworzony katalog

NotEnoughSpaceOnDeviceException - Jeżeli rozmiar katalogu jest większy nie dostępna na urządzeniu przestrzeń

deleteDevice

void deleteDevice(String devName)
           throws RemovingDeviceWithDirException

Usuwa urządzenie

Parameters:

devName - Nazwa urządzenia

Throws:

RemovingDeviceWithDirException - Jeżeli urządzenie zawiera katalogi

deleteDirectory

void deleteDirectory(String dirName)
              throws RemovingRootDirectoryException,
                     RemovingDirWithDocClassException

Usuwa katalog

Parameters:

dirName - Nazwa katalogu

Throws:

RemovingRootDirectoryException - Jeżeli próbujemy usunąć katalog będący katalogiem nadrzędnym

RemovingDirWithDocClassException - Jeżeli próbujemy usunąć katalog do którego są przypisane klasy dokumentów

getDevice

Device getDevice(String name,
                 String... joins)

Pobiera urządzenie po nazwie

Parameters:

name - Nazwa urządzenia

joins - Określa, które elementy mamy dołączyć do obiektu urządzenia.

Returns:

Zwraca obiekt urządzenia

getDirectoryPath

String getDirectoryPath(Directory dir)

Pobiera pełną ścieżkę do katalogu

Parameters:

dir - Katalog

Returns:

Zwaraca ścieżkę do katalogu

isRootDirectory

boolean isRootDirectory(Directory dir)

Sprawdza czy katalog jest katalogiem nadrzędnym

Parameters:

dir - Katalog

Returns:

true jeżeli katalog jest nadrzędny

getChildDirectories

List<Directory> getChildDirectories(Directory dir)

Pobiera podkatalogi

Parameters:

dir - Katalog

Returns:

Listę katalogów podrzędnych

forceDeleteDeviceByName

void forceDeleteDeviceByName(String devName)

Usuwa urządzenie, jeżeli zawiera katalogi to również są usuwane. Jeżeli katalogi zawierają Klasy dokumentów to też są usuwane

Parameters:

devName - Nazwa urządzenia

getDirectory

Directory getDirectory(String name,
                       String... joins)

Pobiera katalog po nazwie

Parameters:

name - Nazwa katalogu

joins - Określa, które elementy mamy dołączyć do katalogu.

Returns:

Zwraca obiekt katalogu

getAllDevices

List<Device> getAllDevices(String... joins)

Pobiera listę wszystkich urządzeń

Returns:

Lista urządzeń

getDeviceById

Device getDeviceById(Long deviceId,
                     String... joins)

Pobiera urządzenie po id

Parameters:

deviceId - Id urządzenia

joins - Określa, które elementy mamy dołączyć do katalogu.

Returns:

Urządzenie

getAllDirectories

List<Directory> getAllDirectories(String... joins)

Pobiera listę wszystkich katalogów archiwum

Returns:

Lista katalogów

updateDevice

void updateDevice(Device dev)

Modyfikuje urządzenie

Parameters:

dev - Obiekt urządzenia

updateDirectory

void updateDirectory(Directory dir)

Modyfikuje katalog

Parameters:

dir - Obiekt katalogu

findDirectoriesByCriteria

List<Directory> findDirectoriesByCriteria(org.hibernate.criterion.DetachedCriteria dc)

Wyszukuje katalogi

Parameters:

dc - Kryteria wyszukiwania

Returns:

Lista znalezionych katalogów

getDirectory

Directory getDirectory(Long id,
                       String... joins)

Pobiera katalog po id

Parameters:

id - Id katalogu

joins - Określa, które elementy mamy dołączyć do katalogu.

Returns:

getSubDirectories

List<Directory> getSubDirectories(Long dirId,
                                  String... joins)

Pobiera wszystkie podkatalogi katalogu o podanym id

Parameters:

dirId - Id katalogu

joins - Określa, które elementy mamy dołączyć do katalogu.

Returns:

Lista katalgów

deleteDirectory

void deleteDirectory(Long dirId)

Usuwa katalog po id

Parameters:

dirId - Id katalogu

getDeviceForDocumentClass

Device getDeviceForDocumentClass(Long dcId,
                                 String... joins)

Pobiera urządzenia dla klasy dokumentów

Parameters:

dcId - Id klasy dokumentów

Returns:

Obiekt urządzenia

getDirectoryUsedSpaceFromDB

Long getDirectoryUsedSpaceFromDB(Directory dir)

Zwraca ilość zajętego miejsca w katalogu. Obliczenie odbywa się na podstawie przechowywanych rozmiarów plików w bazie. Uwzględniane są również podkatalogi. Wynik może nieco różnić się od rzeczywistego zajętego rozmiaru na dysku, gdyż ktoś może ręcznie usunąć plik z dysku, a w bazie on pozostanie.

Parameters:

dir - Katalog

Returns:

Ilość zajętego miejsca przez katalog w MB.

getDirectoryFreeSpaceFromDB

Long getDirectoryFreeSpaceFromDB(Directory dir)

Zwraca ilość wolnego miejsca w katalogu. Obliczenie odbywa się na podstawie przechowywanych rozmiarów plików w bazie. Uwzględniane są również podkatalogi. Wynik może nieco różnić się od rzeczywistego zajętego rozmiaru na dysku, gdyż ktoś może ręcznie usunąć plik z dysku, a w bazie on pozostanie.

Parameters:

dir - Katalog

Returns:

Ilość wolnego miejsca w katalogu w MB.

getDirectoryUsedSpaceOnDisc

Long getDirectoryUsedSpaceOnDisc(Directory dir)

Zwraca ilość zajętego miejsca w katalogu. Obliczenie odbywa się na podstawie rozmiarów rzeczywistych plików na dysku.

Parameters:

dir - Katalog

Returns:

Ilość zajętego miejsca przez katalog w MB.

getDirectoryFreeSpaceOnDisc

Long getDirectoryFreeSpaceOnDisc(Directory dir)

Zwraca ilość wolnego miejsca w katalogu. Obliczenie odbywa się na podstawie rozmiarów rzeczywistych plików na dysku.

Parameters:

dir - Katalog

Returns:

Ilość wolnego miejsca w katalogu w MB.