tecgraf.ftc_1_4.client

Class RemoteDataChannel

java.lang.Object

tecgraf.ftc_1_4.client.RemoteDataChannel

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, IRemoteDataChannel, IDataChannel

public final class RemoteDataChannel
extends Object
implements IRemoteDataChannel

Representa uma implementação de um canal de arquivo remoto.

Author:

Tecgraf/PUC-Rio

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_IDENTIFIER_SIZE Tamanho maximo do identificador
static int	MAX_KEY_SIZE Tamanho maximo da chave
static int	MIN_BUFFER_SIZE Tamanho minimo para o buffer.

Fields inherited from interface tecgraf.ftc_1_4.common.IDataChannel

OP_GET_POSITION, OP_GET_SIZE, OP_READ, OP_SET_POSITION, OP_SET_SIZE, OP_TRANSFER_FROM, OP_TRANSFER_TO, OP_WRITE

Constructor Summary

Constructors

Constructor and Description
RemoteDataChannel(boolean writable, String host, int port, byte[] key) Cria um canal de dados remoto.

Method Summary

Modifier and Type	Method and Description
void	close() Solicita o fechamento do canal.
int	getBufferSize()
ResultMessage	getLastResultMessage()
long	getPosition() Obtém a posição atual do canal.
long	getSize() Obtém a quantidade de bytes no canal a partir da posição inicial.
boolean	isOpen() Verifica se o canal está aberto.
void	keepAlive() Operação que faz um poll no servidor com o intuito de manter a conexao ativa
void	open() Solicita a abertura do arquivo.
int	read(ByteBuffer dest) Lê uma sequência de bytes do arquivo.
int	read(ByteBuffer dest, long remotePosition) Lê uma sequência de bytes do arquivo.
long	remaining() Retorna a quantidade de bytes no canal a partir da posição atual.
void	setBufferSize(int bufferSize)
void	setPosition(long position) Define a nova posição do arquivo.
void	setSize(long size) Define a quantidade de bytes para o canal.
long	skip(long bytes) Metodo que pula/ignora uma quantidade de bytes a partir da posicao atual.
short	supportedOperations() Retornas os metodos/operações suportados pela implementação do canal de dados.
long	transferFrom(ReadableByteChannel source, long remotePosition, long count) Transfere os dados de um fluxo de entrada para o arquivo.
long	transferTo(long remotePosition, long count, WritableByteChannel dest) Transfere os dados do arquivo para um fluxo de saída.
int	write(ByteBuffer source) Escreve uma sequência de bytes no arquivo.
int	write(ByteBuffer source, long remotePosition) Escreve uma sequência de bytes no arquivo.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAX_IDENTIFIER_SIZE

public static final int MAX_IDENTIFIER_SIZE

Tamanho maximo do identificador

See Also:

Constant Field Values

MAX_KEY_SIZE

public static final int MAX_KEY_SIZE

Tamanho maximo da chave

See Also:

Constant Field Values

MIN_BUFFER_SIZE

public static final int MIN_BUFFER_SIZE

Tamanho minimo para o buffer. Baseado no maior pacote de dados possivel no protocolo

See Also:

Constant Field Values

Constructor Detail

RemoteDataChannel

public RemoteDataChannel(boolean writable,
                         String host,
                         int port,
                         byte[] key)

Cria um canal de dados remoto. O canal so é efetivamente aberto após a chamada do metodo open.

Parameters:

writable - Indica se a escrita é permitida no arquivo.

host - A máquina do servidor de arquivos.

port - A porta do servidor de arquivos.

key - A chave de acesso ao arquivo com tamanho máximo padrão MAX_KEY_SIZE.

Method Detail

open

public void open()
          throws PermissionException,
                 FileNotFoundException,
                 FailureException,
                 MaxClientsReachedException,
                 InvalidProtocolVersionException

Solicita a abertura do arquivo.

Specified by:

open in interface IRemoteDataChannel

Throws:

PermissionException - Caso o usuário não tenha permissão para realizar o modo de abertura solicitado.

FileNotFoundException - Caso o arquivo não exista.

FailureException - Caso ocorra alguma falha no procedimento.

MaxClientsReachedException - Caso o servidor não possa mais receber clientes.

InvalidProtocolVersionException - Caso o servidor não suporte a versão do protocolo utilizada pelo cliente.

isOpen

public boolean isOpen()

Verifica se o canal está aberto. Implementação obrigatoria.

Specified by:

isOpen in interface Channel

Specified by:

isOpen in interface IDataChannel

Returns:

true caso o canal esteja aberto, ou false, caso contrário.

close

public void close()
           throws IOException

Solicita o fechamento do canal. Implementação obrigatoria.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface IDataChannel

Throws:

IOException - Caso ocorra alguma falha no procedimento.

setSize

public void setSize(long size)
             throws PermissionException,
                    FailureException

Define a quantidade de bytes para o canal. Implementação opcional. No caso da operação não ser suportada deve ser lançada UnsupportedOperationException.

Specified by:

setSize in interface IDataChannel

Parameters:

size - O novo tamanho.

Throws:

PermissionException

FailureException

getPosition

public long getPosition()
                 throws FailureException

Obtém a posição atual do canal. Implementação opcional. No caso da operação não ser suportada deve ser lançada UnsupportedOperationException.

Specified by:

getPosition in interface IDataChannel

Returns:

A posição atual do arquivo ou -1, caso ocorra algum erro.

Throws:

FailureException

setPosition

public void setPosition(long position)
                 throws FailureException

Define a nova posição do arquivo. Implementação opcional. No caso da operação não ser suportada deve ser lançada UnsupportedOperationException.

Specified by:

setPosition in interface IDataChannel

Parameters:

position - A nova posição.

Throws:

FailureException

getSize

public long getSize()
             throws FailureException

Obtém a quantidade de bytes no canal a partir da posição inicial. Implementação opcional. No caso da operação de não ser suportada deve ser lançada UnsupportedOperationException.

Specified by:

getSize in interface IDataChannel

Returns:

O tamanho do arquivo ou -1, caso ocorra algum erro.

Throws:

FailureException

read

public int read(ByteBuffer dest)
         throws FailureException

Lê uma sequência de bytes do arquivo. Implementação opcional. No caso da operação não ser suportada deve ser lançada UnsupportedOperationException.

Specified by:

read in interface IDataChannel

Parameters:

dest - O buffer.

Returns:

A quantidade de bytes lidos.

Throws:

FailureException

read

public int read(ByteBuffer dest,
                long remotePosition)
         throws FailureException

Lê uma sequência de bytes do arquivo. Implementação opcional. No caso da operação não ser suportada deve ser lançada UnsupportedOperationException.

Specified by:

read in interface IDataChannel

Parameters:

dest - O buffer.

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

Returns:

A quantidade de bytes lidos.

Throws:

FailureException

write

public int write(ByteBuffer source)
          throws PermissionException,
                 FailureException,
                 FileLockedException

Escreve uma sequência de bytes no arquivo. Implementação opcional. No caso da operação não ser suportada deve ser lançada UnsupportedOperationException.

Specified by:

write in interface IDataChannel

Parameters:

source - O buffer.

Returns:

A quantidade de bytes escritos.

Throws:

PermissionException

FailureException

FileLockedException

write

public int write(ByteBuffer source,
                 long remotePosition)
          throws PermissionException,
                 FailureException,
                 FileLockedException

Escreve uma sequência de bytes no arquivo. Implementação opcional. No caso da operação não ser suportada deve ser lançada UnsupportedOperationException.

Specified by:

write in interface IDataChannel

Parameters:

source - O buffer.

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

Returns:

A quantidade de bytes escritos.

Throws:

PermissionException

FailureException

FileLockedException

transferTo

public long transferTo(long remotePosition,
                       long count,
                       WritableByteChannel dest)
                throws FailureException,
                       IOException

Transfere os dados do arquivo para um fluxo de saída. Implementação opcional. No caso da operação não ser suportada deve ser lançada UnsupportedOperationException.

Specified by:

transferTo in interface IDataChannel

Parameters:

remotePosition - A posição inicial a partir daqual o arquivo será lido.

count - A quantidade de bytes que serão transferidos.

dest - O fluxo de saída que receberá os dados do arquivo.

Returns:

A quantidade de bytes efetivamente transferidos.

Throws:

IOException

FailureException

transferFrom

public long transferFrom(ReadableByteChannel source,
                         long remotePosition,
                         long count)
                  throws IOException,
                         DataChannelException

Transfere os dados de um fluxo de entrada para o arquivo. Implementação opcional. No caso da operação não ser suportada deve ser lançada UnsupportedOperationException.

Specified by:

transferFrom in interface IDataChannel

Parameters:

source - O fluxo de entrada.

remotePosition - A posição inicial a partir daqual o arquivo será escrito.

count - A quantidade de bytes que serão transferidos.

Returns:

A quantidade de bytes efetivamente transferidos.

Throws:

IOException

DataChannelException - Caso ocorra alguma situação excepcional no canal.

keepAlive

public void keepAlive()
               throws FailureException

Operação que faz um poll no servidor com o intuito de manter a conexao ativa

Specified by:

keepAlive in interface IRemoteDataChannel

Throws:

FailureException

setBufferSize

public void setBufferSize(int bufferSize)

Parameters:

bufferSize - O tamanho do buffer em bytes.

getBufferSize

public int getBufferSize()

Returns:

O tamanho do ByteBuffer Utilizado

supportedOperations

public short supportedOperations()

Description copied from interface: IDataChannel

Retornas os metodos/operações suportados pela implementação do canal de dados. Todas as implementações devem definir as operações suportadas. Se as operações não forem conhecidas, a constante ALL_OPS deve ser utilizada. Implementação obrigatoria.

Specified by:

supportedOperations in interface IDataChannel

Returns:

operacoes suportadas

remaining

public long remaining()
               throws IOException,
                      DataChannelException

Description copied from interface: IDataChannel

Retorna a quantidade de bytes no canal a partir da posição atual. O valor -1 significa end-of-stream. O valor 0 significa que atualmente não há dados, mas pode vir a ter. Utilizado em live-streams Implementação obrigatoria.

Specified by:

remaining in interface IDataChannel

Returns:

quantidades de bytes existentes no canal.

Throws:

IOException - Caso ocorra alguma falha no procedimento.

DataChannelException - Caso ocorra alguma situação excepcional no canal.

skip

public long skip(long bytes)
          throws IOException,
                 DataChannelException

Description copied from interface: IDataChannel

Metodo que pula/ignora uma quantidade de bytes a partir da posicao atual. Implementação obrigatoria.

Specified by:

skip in interface IDataChannel

Parameters:

bytes - quantidade de bytes a serem pulados. Quantidade de bytes a serem pulados deve ser maior ou igual a zero.

Returns:

Quantidade de bytes pulados

Throws:

IOException - Caso ocorra alguma falha no procedimento.

DataChannelException - Caso ocorra alguma situação excepcional no canal.

getLastResultMessage

public ResultMessage getLastResultMessage()