csbase.server.services.repositoryservice

Interface IRepository

public interface IRepository

Interface que define um repositório. A idéia básica do repositório é encapsular todas as operações feitas sobre os arquivos de repositório. Além disso, essa interface permite abstrair qual repositório está sendo manipulado e também a sua localização. Por fim, todo repositório é gerenciado pelo serviço RepositoryService.

Author:

Tecgraf/PUC-Rio

See Also:

IRepositoryFile, RepositoryService

Method Summary

Methods

Modifier and Type	Method and Description
IRepositoryFile	copyFile(String srcPath, String... destPath) Retorna uma cópia do arquivo indicado por srcPath dentro do caminho indicado por targetDirPath.
IRepositoryFile	createDir(String... path) Cria novo diretório.
IRepositoryFile	createFile(String[] path, String name) Cria um novo arquivo no diretório especificado.
boolean	fileExists(String... path) Verifica se um arquivo existe no repositório.
IRepositoryFile	getDir(String... path) Retorna o diretório dado seu caminho no repositório.
IRepositoryFile	getFile(String... path) Retorna o arquivo dado seu caminho no repositório.
char	getFileSeparator() Retorna o padrão utilizado para separar as hierarquias de path deste repositório.
String	getURI() Identificador único do repositório.
boolean	isLocked(IRepositoryFile file) Verifica se o arquivo está bloqueado.
List<IRepositoryFile>	listFiles() Retorna lista de arquivos do repositório.
boolean	lock(IRepositoryFile file) Bloqueia o arquivo.
boolean	release(IRepositoryFile file) Libera o bloqueio do arquivo.
boolean	removeFile(String... path) Remove arquivo ou diretório no caminho especificado.
boolean	renameFile(String srcFilePath, String newFileName) Renomeia o arquivo.

Method Detail

getURI

String getURI()

Identificador único do repositório.

Returns:

identificador.

getFile

IRepositoryFile getFile(String... path)

Retorna o arquivo dado seu caminho no repositório.

Parameters:

path - caminho.

Returns:

arquivo do repositório ou null caso o arquivo não exista.

getDir

IRepositoryFile getDir(String... path)

Retorna o diretório dado seu caminho no repositório.

Parameters:

path - caminho.

Returns:

diretório do repositório.

listFiles

List<IRepositoryFile> listFiles()

Retorna lista de arquivos do repositório.

Returns:

lista de arquivos do repositório.

createFile

IRepositoryFile createFile(String[] path,
                         String name)
                           throws RepositoryFileException

Cria um novo arquivo no diretório especificado. O caminho do diretório deve ser informado em forma de array para evitar problemas de separadores dependentes de plataforma. Exemplos: (Diretório corrente) "./" -> null ou array vazio (Caminho relativo) "./dir/abc/" -> {"dir", "abc"} (Caminho absoluto) "/tmp/dir/abc/" -> { "", "tmp", "dir", "abc"}.

Parameters:

path - caminho do diretório pai.

name - o nome do arquivo a ser criado.

Returns:

o arquivo criado.

Throws:

RepositoryFileException - em caso de erro ao criar o arquivo.

createDir

IRepositoryFile createDir(String... path)
                          throws IOException

Cria novo diretório.

Parameters:

path - caminho do novo diretório.

Returns:

diretório.

Throws:

IOException - em caso de erro de IO.

renameFile

boolean renameFile(String srcFilePath,
                 String newFileName)
                   throws IOException

Renomeia o arquivo. Obs: Mesmo comportamento do comando move.

Parameters:

srcFilePath - o caminho do arquivo, relativo ao repositório, a ser renomeado.

newFileName - o novo nome para o arquivo.

Returns:

true se o arquivo foi renomeado, false caso contrário.

Throws:

IOException - em caso de erro de IO.

removeFile

boolean removeFile(String... path)
                   throws IOException

Remove arquivo ou diretório no caminho especificado. O diretório não precisa estar vazio para ser removido.

Parameters:

path - caminho.

Returns:

true se o arquivo ou diretório foi removido, false caso contrário.

Throws:

IOException - em caso de erro ao remover o arquivo ou diretório.

fileExists

boolean fileExists(String... path)

Verifica se um arquivo existe no repositório.

Parameters:

path - caminho para o arquivo.

Returns:

true se o arquivo existe, false caso contrário.

lock

boolean lock(IRepositoryFile file)

Bloqueia o arquivo. TODO Esse método de lock ainda está em construção, a ideia é receber um parâmetro que especifica o tipo de lock (exclusivo, compartilhado, leitura, escrita, etc)

Parameters:

file - arquivo.

Returns:

true se o arquivo foi bloqueado, false caso contrário.

release

boolean release(IRepositoryFile file)

Libera o bloqueio do arquivo. TODO Esse método de lock ainda está em construção, a ideia é receber um parâmetro que especifica o tipo de lock (exclusivo, compartilhado, leitura, escrita, etc)

Parameters:

file - arquivo.

Returns:

true se o arquivo foi liberado, false caso contrário.

isLocked

boolean isLocked(IRepositoryFile file)

Verifica se o arquivo está bloqueado. TODO Esse método de lock ainda está em construção, a ideia é receber um parâmetro que especifica o tipo de lock (exclusivo, compartilhado, leitura, escrita, etc)

Parameters:

file - arquivo.

Returns:

true se o arquivo estiver bloqueado, false caso contrário.

copyFile

IRepositoryFile copyFile(String srcPath,
                       String... destPath)
                         throws IOException

Retorna uma cópia do arquivo indicado por srcPath dentro do caminho indicado por targetDirPath.

Parameters:

srcPath - o caminho do arquivo de origem.

destPath - o destino da nova cópia.

Returns:

a nova cópia.

Throws:

IOException - em caso de falha na cópia do arquivo.

getFileSeparator

char getFileSeparator()

Retorna o padrão utilizado para separar as hierarquias de path deste repositório.

Returns:

o separador.