csbase.logic

Class ClientProjectFile

java.lang.Object

csbase.logic.ClientProjectFile

All Implemented Interfaces:

ClientFile, Serializable, Comparable<ClientProjectFile>

public class ClientProjectFile
extends Object
implements ClientFile, Serializable, Comparable<ClientProjectFile>

Modela a visão que um cliente tem de um arquivo ou diretório de um projeto.

Author:

Tecgraf/PUC-Rio

See Also:

Serialized Form

Field Summary

Fields inherited from interface csbase.logic.ClientFile

OPTIMIZATION_MODE_GLOBAL, OPTIMIZATION_MODE_NONE

Constructor Summary

Constructors

Constructor and Description
ClientProjectFile(Object projectId, String name, String[] path, ClientProjectFile parent, String type, boolean isDirectory, boolean hasChildren, boolean isUnderConstruction, Object createdBy, long creationDate, long size, long modificationDate, boolean isLocked, boolean updatable, String updateUserLogin, long updateInterval) Construtor

Method Summary

Modifier and Type	Method and Description
Object	acquireExclusiveLock() Tenta obter lock exclusivo de escrita para o arquivo no servidor.
Object	acquireExclusiveLock(ClientFileLockListener listener, long timeout) Tenta obter um lock de escrita exclusivo para o arquivo.
Object	acquireSharedLock() Tenta obter lock compartilhado de escrita para o arquivo no servidor.
Object	acquireSharedLock(ClientFileLockListener listener, long timeout) Tenta obter lock compartilhado para o arquivo.
void	addChild(boolean clientSide, boolean fixParentsRecursively, ClientProjectFile newChild) Adiciona um novo arquivo neste diretório se ele ainda não existir.
void	appendDescription(String text) Anexa um texto à descrição atual deste arquivo.
boolean	canExecute() Retorna true se o arquivo pode ser executado, false caso contrário.
boolean	canRead() Retorna true se o arquivo pode ser lido, false caso contrário.
boolean	canWrite() Retorna true se o arquivo pode ser escrito, false caso contrário.
void	changeType(String newType) Solicita ao servidor para modificar o tipo do arquivo
void	close(boolean force) Fecha este arquivo.
int	compareTo(ClientProjectFile other)
void	copy(ClientProjectFile directory) Copia este arquivo para outro diretório.
void	createFile(String fileName, String fileType) Cria um arquivo dentro deste diretório.
void	createFiles(List<ProjectFileInfo> fileInfoList) Cria vários arquivos simultaneamente dentro deste diretório.
void	download(OutputStream out, long chunkSize, ProjectFileChannelLoadListener listener) Recupera o conteúdo completo de um arquivo projeto para um stream de saída.
boolean	equals(Object o) Testa a igualdade de dois arquivos.
boolean	exists() Verifica se o arquivo existe no servidor.
static boolean	existsFile(Object projectId, String[] path) Verifica se o arquivo existe no servidor.
ClientProjectFile	getChild(ProjectFileInfo prjFileInfo) Obtém o filho do diretório corrente a partir do ProjectFileInfo que o representa.
ClientProjectFile	getChild(String childName) Obtém um arquivo deste diretório ou null caso ele não seja encontrado ou este arquivo não represente um diretório.
ClientProjectFile	getChild(String[] path) Obtém o nó filho indicado pelo caminho fornecido.
int	getChildIndex(ClientProjectFile child) Obtém o índice de um arquivo dentro de um diretório
ClientProjectFile[]	getChildren() Retorna a lista de arquivos deste diretório.
ClientProjectFile[]	getChildren(boolean discardLocal, boolean recursive) Obtém os filhos do diretório corrente, opcionalmente descartando o cache local e obtendo toda a subárvore recursivamente.
ClientProjectFile[]	getChildren(String fileType) Retorna a lista de arquivos deste diretório do tipo especificado.
ClientFileType	getClientFileType() Retorna item de enumeração que identifica o tipo do arquivo quanto ao local onde o arquivo está armazenado.
long	getCreationDate() Informa o a data de criação arquivo.
String	getDescription() Obtém a descrição atual deste arquivo.
InputStream	getInputStream() Obtém um fluxo de entrada para leitura do arquivo.
ClientProjectFile[]	getLocalChildren() Retorna a lista de arquivos deste diretório, mas não vai ao servidor buscar os filhos se estes ainda não tiverem sido carregados.
long	getLocalTotalSize(ProjectFileFilter filter) Calcula o tamanho total de um arquivo.
long	getModificationDate() Informa a data da última modificação deste arquivo (formato numérico).
String	getName() Retorna o nome do arquivo.
OutputStream	getOutputStream() Obtém um fluxo de saída para escrita no arquivo.
ClientProjectFile	getParent() Retorna o diretório-pai
String[]	getPath() Retorna o caminho para o arquivo na forma de um array (não inclui o nome do projeto).
Object	getProjectId() Retorna o id do projeto.
String	getStringPath() Retorna o path pro arquivo na forma de string.
long	getTotalSize(ProjectFileFilter filter) Calcula o tamanho total de um arquivo.
String	getType() Informa o tipo do arquivo.
long	getUpdateInterval() Obtém o intervalo pelo qual o arquivo (somentes os atualizáveis) está sendo atualizado.
String	getUpdateUserLogin() Obtém o nome do usuário que agendou a a atualização do arquivo.
boolean	hasChildren() Verifica se o nó possui filhos.
static boolean	hasDirectories(ClientProjectFile[] projectFiles) Verifica se algum arquivo de projeto é diretório.
static boolean	hasFileUnderConstruction(ClientProjectFile[] projectFiles) Verifica se algum arquivo de projeto está em construção.
int	hashCode() Redefine a chave pela qual o arquivo deve ser buscado/inserido em hashtables.
boolean	isDirectory() Indica se este arquivo é um diretório.
boolean	isLocked() Retorna boolean indicando se este arquivo está bloqueado.
boolean	isMoving()
boolean	isOpen() Indica se este arquivo está aberto, ou seja, se já foi criado um canal para acesso ao seu conteúdo.
boolean	isRoot() Indica se este arquivo é o root da arvore.
boolean	isUnderConstruction() Indica se este arquivo é um arquivo em construção.
boolean	isUpdatable() Verifica se o arquivo é atualizável.
boolean	isUpdated() Indica se o arquivo está atualizado em relação ao servidor.
void	move(ClientProjectFile directory) Move este arquivo para outro diretório.
void	open(boolean readOnly) Abre o arquivo para leitura ou para leitura e escrita.
long	position() Informa a posição corrente deste arquivo.
void	position(long newPosition) Altera a posição corrente deste arquivo.
int	read(byte[] target, int offset, int length, long position) Lê uma sequência de bytes do arquivo.
int	read(byte[] dst, long position) Lê uma sequência de bytes do arquivo.
int	releaseLock(Object lockId) Libera o lock para o arquivo no servidor.
void	remove() Remove este arquivo.
int	removeChild(ClientProjectFile child) Remove um arquivo deste diretório.
void	rename(String fileName) Troca o nome deste arquivo.
void	resetChildren() Reseta a lista de filhos.
void	setChildren(boolean clientSide, boolean fixParentsRecursively, ClientProjectFile[] newChildren) Redefine a lista de filhos deste diretório.
void	setDescription(String text) Muda a descrição atual deste arquivo.
void	setHasChildren(boolean hasChildren) Define se o nó possui filhos.
void	setLocked(boolean isLocked) Muda o estado do arquivo para bloqueado ou desbloqueado
void	setModificationDate(long modificationDate) Muda a data de modificação do arquivo.
void	setMoving(boolean isMoving) Indica se este arquivo/diretório está sendo movido de lugar.
void	setName(String name) Muda o nome do arquivo.
void	setParent(ClientProjectFile newParent) Redefine o pai do arquivo.
void	setSize(long size) Muda o tamanho do arquivo.
void	setType(String newType) Muda o tipo do arquivo localmente.
void	setUnderConstruction(boolean isUnderConstruction) Muda o estado "em construção" do arquivo.
void	setUpdated(boolean updated) Informa se o arquivo está atualizado em relação ao servidor.
void	setUpdateInfo(String updateUserLogin, long updateInterval) Define informações sobre o agendamento da atualizado de um arquivo.
long	size() Informa o tamanho corrente deste arquivo.
static String[]	splitPath(String path) Método interno para decomposição de um caminho de arquivo (path) em um array de strings; onde cada elemento é montado no separador "/".
String	toString() Retorna um texto descritivo do arquivo.
void	truncate(long newSize) Ajusta o tamanho corrente deste arquivo.
void	updateInfo() Atualiza as informações desse arquivo buscando os dados reais no servidor.
void	updatePath() Corrige o path e o dos descendentes de acordo com o path do parent
void	upload(InputStream in, long chunkSize, ProjectFileChannelLoadListener listener) Envia o conteúdo de um stream de entrada para o arquivo do projeto.
boolean	userOwnsLock() Verifica se o usuário corrente é o dono do lock do arquivo.
Object	whoCreated() Retorna o usuário que criou esse arquivo.
void	write(byte[] src, int off, int len, long position) Escreve uma sequência de bytes do arquivo.
void	write(byte[] src, long position) Escreve uma sequência de bytes do arquivo.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ClientProjectFile

public ClientProjectFile(Object projectId,
                         String name,
                         String[] path,
                         ClientProjectFile parent,
                         String type,
                         boolean isDirectory,
                         boolean hasChildren,
                         boolean isUnderConstruction,
                         Object createdBy,
                         long creationDate,
                         long size,
                         long modificationDate,
                         boolean isLocked,
                         boolean updatable,
                         String updateUserLogin,
                         long updateInterval)

Construtor

Parameters:

projectId - identificador do projeto

name - nome do arquivo

path - caminho para o arquivo, a partir da raiz

parent - diretório-pai. Se estiver sendo construido no servidor, este valor deve ser null.

type - tipo do arquivo

isDirectory - indicativo de diretório

hasChildren - flag indicando se o nó possui filhos. Pode ser true mesmo que children seja null

isUnderConstruction - indicaivo de construção

createdBy - usuário que criou o arquivo/diretório

creationDate - data de criação

size - tamanho do arquivo

modificationDate - data da última modificação.

isLocked - indica se o arquivo está bloqueado

updatable - indica se o arquivo é atualizável.

updateUserLogin - Indica o login do usuário que agendou a atualização do arquivo.

updateInterval - Indica o intervalo entre as atualizações de um arquivo.

Method Detail

getName

public String getName()

Retorna o nome do arquivo.

Specified by:

getName in interface ClientFile

Returns:

Nome do arquivo.

setName

public void setName(String name)

Muda o nome do arquivo.

Parameters:

name - novo nome do arquivo.

setSize

public void setSize(long size)

Muda o tamanho do arquivo.

Parameters:

size - novo tamanho do arquivo.

setModificationDate

public void setModificationDate(long modificationDate)

Muda a data de modificação do arquivo.

Parameters:

modificationDate - nova data de modificação do arquivo.

getProjectId

public Object getProjectId()

Retorna o id do projeto.

Returns:

O id do projeto.

getStringPath

public String getStringPath()

Retorna o path pro arquivo na forma de string.

Specified by:

getStringPath in interface ClientFile

Returns:

O path pro arquivo na forma de string.

getPath

public String[] getPath()

Retorna o caminho para o arquivo na forma de um array (não inclui o nome do projeto).

Specified by:

getPath in interface ClientFile

Returns:

Caminho para o arquivo na forma de um array (não inclui o nome do projeto).

getType

public String getType()

Informa o tipo do arquivo.

Specified by:

getType in interface ClientFile

Returns:

O tipo do arquivo.

getCreationDate

public long getCreationDate()

Informa o a data de criação arquivo.

Returns:

a data de criação do arquivo em Milesegundos.

whoCreated

public Object whoCreated()

Retorna o usuário que criou esse arquivo.

Returns:

O nome do usuário que criou esse arquivo.

getParent

public ClientProjectFile getParent()

Retorna o diretório-pai Este método não deve ser utilizado no servidor pois o valor da propriedade a que ele referencia só será atribuido no cliente.

Specified by:

getParent in interface ClientFile

Returns:

o diretório que contem este arquivo.

setParent

public void setParent(ClientProjectFile newParent)

Redefine o pai do arquivo. Também altera a path para ficar consistente.

Parameters:

newParent - novo pai

updatePath

public void updatePath()
                throws RemoteException

Corrige o path e o dos descendentes de acordo com o path do parent

Throws:

RemoteException - em caso de erro de comunicação.

resetChildren

public void resetChildren()

Reseta a lista de filhos.

getLocalChildren

public ClientProjectFile[] getLocalChildren()

Retorna a lista de arquivos deste diretório, mas não vai ao servidor buscar os filhos se estes ainda não tiverem sido carregados.

Returns:

a lista de arquivos deste diretório, ou null se os filhos ainda não foram obtidos do servidor

getChildren

public ClientProjectFile[] getChildren()
                                throws RemoteException

Retorna a lista de arquivos deste diretório.

Specified by:

getChildren in interface ClientFile

Returns:

A lista de arquivos deste diretório.

Throws:

RemoteException

getChildren

public ClientProjectFile[] getChildren(boolean discardLocal,
                                       boolean recursive)
                                throws RemoteException

Obtém os filhos do diretório corrente, opcionalmente descartando o cache local e obtendo toda a subárvore recursivamente.

Parameters:

discardLocal - true se o cache local deve ser descartado

recursive - true se a subárvore deve ser obtida recursivamente

Returns:

array com os filhos deste diretório

Throws:

RemoteException - se houver falha de RMI

getChildren

public ClientProjectFile[] getChildren(String fileType)
                                throws RemoteException

Retorna a lista de arquivos deste diretório do tipo especificado.

Parameters:

fileType - Tipo dos arquivos que devem ser retornados.

Returns:

A lista de arquivos deste diretório.

Throws:

RemoteException - Erro na comunicação com o servidor.

setChildren

public void setChildren(boolean clientSide,
                        boolean fixParentsRecursively,
                        ClientProjectFile[] newChildren)

Redefine a lista de filhos deste diretório.

Parameters:

clientSide - true se o arquivo está sendo inserido no cliente. Se este parâmetro for false o parâmetro fixParentsRecursively será ignorado.

fixParentsRecursively - true se as referências para os pais devem ser corrigidas recursivamente. Neste caso, os novos filhos apontarão para seu novo pai, e este processo se repetirá recursivamente.
ATENÇÃO: as correções afetam apenas os novos filhos, os filhos já existentes não são alterados. Se este parâmetro for false, apenas as referências dos novos filhos diretos serão corrigidas.

newChildren - a nova lista de filhos

getChild

public ClientProjectFile getChild(String childName)
                           throws RemoteException

Obtém um arquivo deste diretório ou null caso ele não seja encontrado ou este arquivo não represente um diretório.

Parameters:

childName - - path para o filho, a partir deste diretório

Returns:

o filho deste diretório ou null caso ele não seja encontrado ou este arquivo não represente um diretório.

Throws:

RemoteException - se houver falha de RMI

See Also:

getChild(java.lang.String)

addChild

public void addChild(boolean clientSide,
                     boolean fixParentsRecursively,
                     ClientProjectFile newChild)
              throws RemoteException

Adiciona um novo arquivo neste diretório se ele ainda não existir. Após a inclusão, os arquivos deste diretório são ordenados por nome.

Parameters:

clientSide - true se o arquivo está sendo inserido no cliente. Se este parâmetro for false o parâmetro fixParentsRecursively será ignorado.

fixParentsRecursively - true se as referências para os pais devem ser corrigidas recursivamente. Neste caso, os novos filhos apontarão para seu novo pai, e este processo se repetirá recursivamente.
ATENÇÃO: as correções afetam apenas os novos filhos, os filhos já existentes não são alterados. Se este parâmetro for false, apenas as referências dos novos filhos diretos serão corrigidas.

newChild - O arquivo (ou diretório) a ser incluído

Throws:

RemoteException - se houver falha de RMI

getChildIndex

public int getChildIndex(ClientProjectFile child)
                  throws RemoteException

Obtém o índice de um arquivo dentro de um diretório

Parameters:

child - O arquivo (ou diretório) do qual deseja-se o índice

Returns:

O índice do arquivo ou -1 caso o arquivo não esteja presente na lista de filhos.

Throws:

RemoteException - se houver falha de RMI

removeChild

public int removeChild(ClientProjectFile child)
                throws RemoteException

Remove um arquivo deste diretório. Após a inclusão, os arquivos deste diretório são ordenados por nome.

Parameters:

child - O arquivo (ou diretório) a ser removido

Returns:

O índice do arquivo removido ou -1 caso ocorra algum problema ao remover.

Throws:

RemoteException - se houver falha de RMI

createFile

public void createFile(String fileName,
                       String fileType)
                throws RemoteException

Cria um arquivo dentro deste diretório.

Parameters:

fileName - Nome do arquivo a ser criado.

fileType - Tipo do arquivo a ser criado.

Throws:

RemoteException - falha de rmi

createFiles

public void createFiles(List<ProjectFileInfo> fileInfoList)
                 throws RemoteException

Cria vários arquivos simultaneamente dentro deste diretório.

Parameters:

fileInfoList - lista de dados dos arquivos a serem criados.

Throws:

RemoteException - falha de rmi

rename

public void rename(String fileName)
            throws RemoteException

Troca o nome deste arquivo.

Parameters:

fileName - Novo nome do arquivo.

Throws:

RemoteException - falha de rmi

copy

public void copy(ClientProjectFile directory)
          throws RemoteException

Copia este arquivo para outro diretório.

Parameters:

directory - Diretório destino.

Throws:

RemoteException - Falha de rmi

move

public void move(ClientProjectFile directory)
          throws RemoteException

Move este arquivo para outro diretório.

Parameters:

directory - Diretório destino.

Throws:

RemoteException - erro no acesso ao servidor

remove

public void remove()
            throws RemoteException

Remove este arquivo. Após chamado este método, o objeto que representa o arquivo não poderá mais ser utilizado.

Throws:

RemoteException - falha de comunicação com o servidor

updateInfo

public void updateInfo()
                throws RemoteException

Atualiza as informações desse arquivo buscando os dados reais no servidor.

Throws:

RemoteException - Falha de rmi

isDirectory

public boolean isDirectory()

Indica se este arquivo é um diretório.

Specified by:

isDirectory in interface ClientFile

Returns:

Verdadeiro caso seja um diretório e falso caso contrário.

hasChildren

public boolean hasChildren()

Verifica se o nó possui filhos. Se o ClientProjectFile foi criado pelo servidor a partir de um diretório que contém filhos, este método pode retornar true mesmo que a lista de filhos não tenha sido obtida ainda do servidor. Esta informação é tipicamente usada pela árvore do projeto para indicar se um nó é folha.

Returns:

true se o nó possui filhos

setHasChildren

public void setHasChildren(boolean hasChildren)

Define se o nó possui filhos.

Parameters:

hasChildren - flag indicando se o nó possui filhos

isUnderConstruction

public boolean isUnderConstruction()

Indica se este arquivo é um arquivo em construção.

Returns:

Verdadeiro caso seja um arquivo em construção e falso caso contrário.

setUnderConstruction

public void setUnderConstruction(boolean isUnderConstruction)

Muda o estado "em construção" do arquivo.

Parameters:

isUnderConstruction - true se o arquivo estiver em construção.

setLocked

public void setLocked(boolean isLocked)

Muda o estado do arquivo para bloqueado ou desbloqueado

Parameters:

isLocked - true se o arquivo estiver bloqueado

getDescription

public String getDescription()
                      throws RemoteException

Obtém a descrição atual deste arquivo.

Returns:

O texto com a descrição do arquivo.

Throws:

RemoteException - falha de rmi

setDescription

public void setDescription(String text)
                    throws RemoteException

Muda a descrição atual deste arquivo.

Parameters:

text - novo texto da descrição do arquivo.

Throws:

RemoteException - falha de rmi

appendDescription

public void appendDescription(String text)
                       throws RemoteException

Anexa um texto à descrição atual deste arquivo. Permite a geração de históricos de modificação.

Parameters:

text - texto a ser anexado.

Throws:

RemoteException - falha de rmi

size

public long size()

Informa o tamanho corrente deste arquivo. Reflete o número corrente de bytes do arquivo.

Specified by:

size in interface ClientFile

Returns:

Tamanho corrente do arquivo.

getTotalSize

public long getTotalSize(ProjectFileFilter filter)
                  throws RemoteException

Calcula o tamanho total de um arquivo. Se o arquivo é um diretório, todos os filhos (diretos e indiretos) são carregados do servidor para se calcular o tamanho total do diretório (a soma do tamanho do próprio diretório mais a soma do tamanho de todos os filhos). Se um fitro é passado, o tamanho de um diretório é calculado considerando-se apenas os arquivos filhos aceitos pelo filtro. Se o arquivo não é um diretório, esse método é igual a size() e o filtro é desconsiderado.

Parameters:

filter - Define que arquivos são usados para calcular o tamanho total de um diretório.

Returns:

O tamanho total do arquivo.

Throws:

RemoteException - Quando não consegue carregar a subárvore de um diretório do servidor.

getLocalTotalSize

public long getLocalTotalSize(ProjectFileFilter filter)

Calcula o tamanho total de um arquivo. Se o arquivo é um diretório, o tamanho do diretório é somado ao tamanho de todos os filhos (diretos e indiretos) para se calcular o tamanho total do diretório. Esse método não carrega os filhos do servidor se eles não tiverem sido carregados ainda. Se um fitro é passado, o tamanho de um diretório é calculado considerando-se apenas os arquivos filhos aceitos pelo filtro. Se o arquivo não é um diretório, esse método é igual a size() e o filtro é desconsiderado.

Parameters:

filter - Define que arquivos são usados para calcular o tamanho total de um diretório.

Returns:

O tamanho da transferência.

getModificationDate

public long getModificationDate()

Informa a data da última modificação deste arquivo (formato numérico).

Specified by:

getModificationDate in interface ClientFile

Returns:

data da última modificação deste arquivo (formato numérico)

isUpdated

public boolean isUpdated()

Indica se o arquivo está atualizado em relação ao servidor.

Returns:

true se está atualizado

setUpdated

public void setUpdated(boolean updated)

Informa se o arquivo está atualizado em relação ao servidor.

Parameters:

updated - true se está atualizado.

getChild

public ClientProjectFile getChild(String[] path)
                           throws RemoteException

Obtém o nó filho indicado pelo caminho fornecido.

Parameters:

path - Array de Strings com o caminho para o arquivo, não incluindo o nome do diretório corrente.

Returns:

O nó filho pedido, ou null caso este não exista.

Throws:

RemoteException - se houver falha de RMI

getChild

public ClientProjectFile getChild(ProjectFileInfo prjFileInfo)
                           throws RemoteException

Obtém o filho do diretório corrente a partir do ProjectFileInfo que o representa.

Parameters:

prjFileInfo - - propriedades do arquivo a ser obtido

Returns:

o arquivo solicitado ou null caso não exista ou se o arquivo corrente não é um diretório

Throws:

RemoteException - Se houver falha de comunicação.

exists

public boolean exists()
               throws RemoteException

Verifica se o arquivo existe no servidor.

Specified by:

exists in interface ClientFile

Returns:

true se o arquivo existe no servidor.

Throws:

RemoteException - se houver falha de RMI

existsFile

public static boolean existsFile(Object projectId,
                                 String[] path)
                          throws RemoteException

Verifica se o arquivo existe no servidor.

Parameters:

projectId - id do projeto

path - o path do arquivo.

Returns:

true se o arquivo existe no servidor.

Throws:

RemoteException - se houver falha de RMI

splitPath

public static String[] splitPath(String path)

Método interno para decomposição de um caminho de arquivo (path) em um array de strings; onde cada elemento é montado no separador "/".

Parameters:

path - o caminho lógico do arquivo.

Returns:

o array.

truncate

public void truncate(long newSize)
              throws IOException

Ajusta o tamanho corrente deste arquivo.

Parameters:

newSize - o novo tamanho a ser ajustado.

Throws:

IOException - Em caso de erro.

open

public void open(boolean readOnly)
          throws RemoteException

Abre o arquivo para leitura ou para leitura e escrita.

Specified by:

open in interface ClientFile

Parameters:

readOnly - Boolean indicando se o arquivo deve ser aberto para leitura ou para leitura e escrita.

Throws:

RemoteException

acquireExclusiveLock

public Object acquireExclusiveLock()
                            throws RemoteException

Tenta obter lock exclusivo de escrita para o arquivo no servidor. Ver ProjectService#acquireExclusiveLock(Object, String[]).

Returns:

identificador do lock se o lock foi obtido, ou null caso contrário

Throws:

RemoteException - falha de rmi

acquireExclusiveLock

public Object acquireExclusiveLock(ClientFileLockListener listener,
                                   long timeout)
                            throws RemoteException

Tenta obter um lock de escrita exclusivo para o arquivo. Locks exclusivos são obtidos apenas uma vez. Este método cadastra uma solicitação de lock numa fila priorizada pela ordem de chegada dos pedidos de lock e espera pela notificação de que o lock foi obtido ou seu timeout foi atingido. Quando o lock é obtido, o método FileLockListenerInterface.fileLocked é chamado. Quando o tempo máximo de espera do lock é atingido e o lock não foi obtido o método FileLockListenerInterface.fileLockExpired é chamado.

Parameters:

listener - observador do lock cadastrado no servidor

timeout - tempo máximo de espera pelo lock em milisegundos. A constante ProjectServiceInterface.INFINITE_TIMOUT foi criada para timeout infinito.

Returns:

identificador do lock se o lock foi obtido, ou null caso contrário

Throws:

RemoteException - falha de rmi

acquireSharedLock

public Object acquireSharedLock()
                         throws RemoteException

Tenta obter lock compartilhado de escrita para o arquivo no servidor. Ver ProjectService#acquireExclusiveLock(Object, String[]).

Returns:

identificador do lock se o lock foi obtido, ou null caso contrário

Throws:

RemoteException - falha de rmi

acquireSharedLock

public Object acquireSharedLock(ClientFileLockListener listener,
                                long timeout)
                         throws RemoteException

Tenta obter lock compartilhado para o arquivo. Locks compartilhados podem ser obtidos múltiplas vezes. Este método cadastra uma solicitação de lock compartilhado em uma fila priorizada pela ordem de chegada dos pedidos de lock e espera pela notificação de que o lock foi obtido ou seu timeout foi atingido. Quando o lock é obtido, o método FileLockListenerInterface.fileLocked é chamado. Quando o tempo máximo de espera do lock é atingido e o lock não foi obtido o método FileLockListenerInterface.fileLockExpired é chamado.

Parameters:

listener - observador do lock cadastrado no servidor

timeout - tempo máximo de espera pelo lock em milisegundos. A constante ProjectServiceInterface.INFINITE_TIMOUT foi criada para timout infinito.

Returns:

o identificador do lock se o lock foi obtido com sucesso, ou null caso contrário

Throws:

RemoteException - falha de rmi

releaseLock

public int releaseLock(Object lockId)
                throws RemoteException

Libera o lock para o arquivo no servidor. Ver ProjectService#releaseLock(Object, String[], Object).

Parameters:

lockId - identificador do lock

Returns:

contador de locks ainda ativos sobre o arquivo. Para locks exclusivos, este contador tem que ser zero se a operação foi bem sucedida. Para locks compartilhados, pode ainda haver outros locks ativos.

Throws:

RemoteException - falha de rmi

isLocked

public boolean isLocked()

Retorna boolean indicando se este arquivo está bloqueado.

Returns:

Boolean indicando se este arquivo está bloqueado.

userOwnsLock

public boolean userOwnsLock()
                     throws RemoteException

Verifica se o usuário corrente é o dono do lock do arquivo.

Returns:

true se o usuário corrente é o dono do lock

Throws:

RemoteException - em caso de erro de comunicação.

isOpen

public boolean isOpen()

Indica se este arquivo está aberto, ou seja, se já foi criado um canal para acesso ao seu conteúdo.

Returns:

Verdadeiro caso este arquivo esteja aberto, falso caso contrário.

position

public long position()

Informa a posição corrente deste arquivo. Reflete o número de bytes a partir do início do arquivo até a posição corrente.

Specified by:

position in interface ClientFile

Returns:

Posição corrente do arquivo.

position

public void position(long newPosition)
              throws IOException

Altera a posição corrente deste arquivo. Reflete o número de bytes a partir do início do arquivo até a posição corrente.

Specified by:

position in interface ClientFile

Parameters:

newPosition - Nova posição corrente do arquivo.

Throws:

IOException - Em caso de erro.

read

public int read(byte[] dst,
                long position)
         throws IOException

Lê uma sequência de bytes do arquivo. Esse método tenta fazer leituras consecutivas até conseguir a quantidade de bytes solicitada, ou atingir o final do arquivo. Caso não consiga recuperar a quantidade solicitada sem ter atingido o final do arquivo (isto é, por problemas de comunicação ou outros), o método lança uma exceção.

Specified by:

read in interface ClientFile

Parameters:

dst - O array a ser preenchido.

position - A posição do arquivo a partir da qual a leitura deve ser iniciada.

Returns:

A quantidade de bytes lidos. Se for menor que o número de bytes solicitados, o final do arquivo foi atingido.

Throws:

IOException - Caso ocorra alguma falha no procedimento.

read

public int read(byte[] target,
                int offset,
                int length,
                long position)
         throws IOException

Lê uma sequência de bytes do arquivo. Esse método tenta fazer leituras consecutivas até conseguir a quantidade de bytes solicitada, ou atingir o final do arquivo. Caso não consiga recuperar a quantidade solicitada sem ter atingido o final do arquivo (isto é, por problemas de comunicação ou outros), o método lança uma exceção.

Specified by:

read in interface ClientFile

Parameters:

target - O array a ser preenchido.

offset - O deslocamento no array a partir do qual os bytes serão armazenados.

length - A quantidade de bytes a serem lidos do arquivo.

position - A posição do arquivo a partir da qual a leitura deve ser iniciada.

Returns:

A quantidade de bytes lidos. Se for menor que o número de bytes solicitados, o final do arquivo foi atingido.

Throws:

IOException - Caso ocorra alguma falha no procedimento.

write

public void write(byte[] src,
                  long position)
           throws IOException,
                  FileLockedException

Escreve uma sequência de bytes do arquivo. Esse método tenta fazer escritas consecutivas até conseguir enviar a quantidade de bytes solicitada. Caso não consiga, o método lança uma exceção.

Specified by:

write in interface ClientFile

Parameters:

src - O array contendo os bytes a serem escritos no arquivo.

position - A posição do arquivo a partir da qual a escrita deve ser iniciada.

Throws:

IOException - Em caso de erro.

FileLockedException - caso o arquivo esteja bloqueado para escrita por outra sessão de usuário

write

public void write(byte[] src,
                  int off,
                  int len,
                  long position)
           throws IOException,
                  FileLockedException

Escreve uma sequência de bytes do arquivo. Esse método tenta fazer escritas consecutivas até conseguir enviar a quantidade de bytes solicitada. Caso não consiga, o método lança uma exceção.

Specified by:

write in interface ClientFile

Parameters:

src - O array contendo os bytes a serem escritos no arquivo.

off - O deslocamento no array a partir do qual os bytes serão lidos.

len - A quantidade de bytes a serem escritos do arquivo.

position - A posição do arquivo a partir da qual a escrita deve ser iniciada.

Throws:

IOException - Em caso de erro.

FileLockedException - caso o arquivo esteja bloqueado para escrita por outra sessão de usuário

upload

public void upload(InputStream in,
                   long chunkSize,
                   ProjectFileChannelLoadListener listener)
            throws IOException,
                   FileLockedException

Envia o conteúdo de um stream de entrada para o arquivo do projeto. Qualquer conteúdo que o arquivo do projeto possua será substituído pelo conteúdo sendo enviado. O arquivo do projeto não precisa ser aberto para que este método seja chamado.

Parameters:

in - O stream de entrada que definirá o conteúdo do arquivo do projeto.

chunkSize - O tamanho do buffer intermediário usado na transferência.

listener - O listener que será chamado para acompanhar a transferência. Esse listener será chamado, no máximo, a cada buffer completo que seja transferido. Pode ser nulo.

Throws:

IOException - Se houver falha de I/O.

FileLockedException - Caso o arquivo do projeto esteja bloqueado para escrita.

download

public void download(OutputStream out,
                     long chunkSize,
                     ProjectFileChannelLoadListener listener)
              throws IOException

Recupera o conteúdo completo de um arquivo projeto para um stream de saída. O arquivo do projeto não precisa ser aberto para que este método seja chamado.

Parameters:

out - O stream de saída que receberá o conteúdo do arquivo do projeto.

chunkSize - O tamanho do buffer intermediário usado na transferência.

listener - O listener que será chamado para acompanhar a transferência. Esse listener será chamado, no máximo, a cada buffer completo que seja transferido. Pode ser nulo.

Throws:

IOException - Se houver falha de I/O.

close

public void close(boolean force)
           throws RemoteException,
                  IOException

Fecha este arquivo. Após chamado este método, o objeto que representa o arquivo não poderá mais ser utilizado para leitura e/ou escrita.

Specified by:

close in interface ClientFile

Parameters:

force - Indica que o arquivo deve ser considerado fechado mesmo em caso de erro.

Throws:

IOException - se houver falha no acesso ao arquivo.

RemoteException

toString

public String toString()

Retorna um texto descritivo do arquivo.

Overrides:

toString in class Object

Returns:

.

setType

public void setType(String newType)

Muda o tipo do arquivo localmente.

Parameters:

newType - O novo tipo do arquivo.

changeType

public void changeType(String newType)
                throws RemoteException

Solicita ao servidor para modificar o tipo do arquivo

Parameters:

newType - O novo tipo do arquivo.

Throws:

RemoteException - falha de rmi

equals

public boolean equals(Object o)

Testa a igualdade de dois arquivos. Dois ClientProjectFile são considerados iguais se seus paths absolutos forem os mesmos.

Overrides:

equals in class Object

Parameters:

o - Objeto a ser comparado com o atual

Returns:

true se ambos os objetos forem considerados iguais

hashCode

public int hashCode()

Redefine a chave pela qual o arquivo deve ser buscado/inserido em hashtables.

Overrides:

hashCode in class Object

Returns:

chave para inserção/busca em hashtables.

compareTo

public int compareTo(ClientProjectFile other)

Specified by:

compareTo in interface Comparable<ClientProjectFile>

setMoving

public void setMoving(boolean isMoving)

Indica se este arquivo/diretório está sendo movido de lugar. Esta informação será utilizada para definir o ícone do arquivo/diretório.

Parameters:

isMoving - indicativo

isMoving

public boolean isMoving()

Returns:

true se este arquivo/diretório e/ou seu diretório pai estiver sendo movido. Esta informação será utilizada para definir o ícone do arquivo/diretório.

hasDirectories

public static boolean hasDirectories(ClientProjectFile[] projectFiles)

Verifica se algum arquivo de projeto é diretório.

Parameters:

projectFiles - Os arquivos que se deseja verificar.

Returns:

true, caso algum dos arquivos de projeto seja diretório, ou false, caso contrário.

hasFileUnderConstruction

public static boolean hasFileUnderConstruction(ClientProjectFile[] projectFiles)

Verifica se algum arquivo de projeto está em construção.

Parameters:

projectFiles - Os arquivos que se deseja verificar.

Returns:

true, caso algum dos arquivos de projeto esteja em construção, ou false, caso contrário.

isUpdatable

public boolean isUpdatable()

Verifica se o arquivo é atualizável.

Returns:

true caso o arquivo seja atualizável, ou false, caso contrário.

getUpdateUserLogin

public String getUpdateUserLogin()

Obtém o nome do usuário que agendou a a atualização do arquivo.

Returns:

O nome do usuário que agendou a a atualização do arquivo.

getUpdateInterval

public long getUpdateInterval()

Obtém o intervalo pelo qual o arquivo (somentes os atualizáveis) está sendo atualizado.

Returns:

O intervalo pelo qual o arquivo está sendo atulizado. Caso o arquivo não esteja sendo atualizado ou não seja atualizável, retorna 0 (zero).

setUpdateInfo

public void setUpdateInfo(String updateUserLogin,
                          long updateInterval)

Define informações sobre o agendamento da atualizado de um arquivo.

Parameters:

updateUserLogin - O login do usuário que agendou a atualização.

updateInterval - O intervalo pelo qual o arquivo está sendo atulizado. Caso o arquivo não esteja sendo atulizado ou não seja atualizável, o valor deve ser 0 (zero).

isRoot

public boolean isRoot()

Indica se este arquivo é o root da arvore.

Returns:

Retorna boolean indicando se este arquivo é o root da arvore.

getInputStream

public InputStream getInputStream()
                           throws IOException

Obtém um fluxo de entrada para leitura do arquivo.

Specified by:

getInputStream in interface ClientFile

Returns:

Fluxo de entrada para leitura do arquivo.

Throws:

IOException - Caso ocorra algum erro de IO durante o procedimento.

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Obtém um fluxo de saída para escrita no arquivo.

Specified by:

getOutputStream in interface ClientFile

Returns:

Fluxo de saída para escrita no arquivo.

Throws:

IOException - Caso ocorra algum erro de IO durante o procedimento.

getClientFileType

public ClientFileType getClientFileType()

Retorna item de enumeração que identifica o tipo do arquivo quanto ao local onde o arquivo está armazenado.

Specified by:

getClientFileType in interface ClientFile

Returns:

Item de enumeração que identifica o tipo do arquivo quanto ao local onde o arquivo está armazenado.

canExecute

public boolean canExecute()

Retorna true se o arquivo pode ser executado, false caso contrário.

Specified by:

canExecute in interface ClientFile

Returns:

true se o arquivo pode ser executado, false caso contrário.

canRead

public boolean canRead()

Retorna true se o arquivo pode ser lido, false caso contrário.

Specified by:

canRead in interface ClientFile

Returns:

true se o arquivo pode ser lido, false caso contrário.

canWrite

public boolean canWrite()

Retorna true se o arquivo pode ser escrito, false caso contrário.

Specified by:

canWrite in interface ClientFile

Returns:

- true se o arquivo pode ser escrito, false caso contrário.