csbase.remote

Interface AlgorithmServiceInterface

All Superinterfaces:

Remote, RemoteObservable, ServiceInterface, TransactionInterface

public interface AlgorithmServiceInterface
extends TransactionInterface, ServiceInterface, RemoteObservable

Interface remota para acesso ao Serviço de Gerência de Algoritmos

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME Nome do serviço para o ServiceManager

Method Summary

Modifier and Type	Method and Description
CategorySet	bindAlgorithmsToCategories(List<Object> algoIds, List<String> categoryIds) Associa um conjunto de algoritmos a um conjunto de categorias.
AlgorithmInfo	changeAlgorithmProperties(String name, Hashtable<String,String> newValues) Altera as propriedades de um algoritmo.
AlgorithmInfo	changeVersionProperties(String name, AlgorithmVersionId versionId, Hashtable<String,String> newValues) Altera as propriedades de uma versão de um algoritmo.
boolean	configFileExists(Object algoId, Object versionId, String fileName) Verifica se um determinado arquivo de configuração existe no servidor.
void	copyFiles(AlgorithmVersionInfo sourceVersion, List<FileInfo> files, IPathFactory sourcePathFactory, AlgorithmVersionInfo targetVersion, FileInfo targetDir, IPathFactory targetPathFactory, boolean setExecutables) Copia arquivos de uma pasta para a outra com a possibilidade de dar permissão de execução às cópias.
AlgorithmInfo	createAlgorithm(String name, String id, Hashtable<String,String> properties) Cria um algoritmo a partir do nome, do identificador e das propriedades informadas.
AlgorithmConfigurator	createAlgorithmConfigurator(String algorithmName, AlgorithmVersionId algorithmVersionId) Cria um configurador para uma versão específica de um algoritmo.
Category	createCategory(String parentCategoryId, String name) Cria uma categoria de algoritmos como filha de uma categoria ou do primeiro nível.
AlgorithmInfo	createVersion(Object algoId, int major, int minor, int patch, Hashtable<String,String> properties) Cria no repositório a estrutura para uma nova versão de algoritmo.
boolean	docFileExists(Object algoId, Object versionId, String fileName) Verifica se um determinado arquivo de documentação existe no servidor.
void	duplicateVersion(Object algoId, Object versionIdFrom, int majorTo, int minorTo, int patchTo) Cria uma nova versão do algoritmo com o mesmos dados que a versão dada.
boolean	execFileExists(Object algoId, Object versionId, String platformName, String fileName) Verifica se um determinado arquivo executável existe no servidor.
void	finishImportAlgorithmsPack(String importDataToken) Finaliza o processo de importação do Pacote de Algoritmos identificado pelo token, removendo os diretórios e arquivos criados temporariamente.
List<AlgorithmProperty>	getAlgorithmProperties() Obtém a Retorna a lista de Property dos algoritmos.
AlgorithmsPack	getAlgorithmsPackInfo(String importDataToken) Obtém os algoritmos que fazem parte do Pacote de Algoritmos, sem ainda terem passado por uma validação.
CategorySet	getAllCategories() Obtém o conjunto de categorias disponíveis no servidor.
Object[]	getAllIds() Retorna de todos os identificadores dos algoritmos cadastrados.
AlgorithmInfo[]	getAllInfo() Retorna todos os dados de todos os algoritmos cadastrados.
AlgorithmOutline[]	getAllOutlines() Retorna todos os resumos dos algoritmos cadastrados.
Category	getCategory(String id) Obtém uma categoria que possui o identificador especificado.
AlgorithmInfo	getInfo(Object id) Retorna informações de um algoritmo.
AlgorithmInfo	getInfo(String name) Retorna informações de um algoritmo a partir do nome
Map<String,ParameterFactory>	getParameterFactories() Retorna as fábricas dos parâmetros disponíveis no sistema.
List<AlgorithmProperty>	getVersionProperties() Obtém a Retorna a lista de Property dos algoritmos.
boolean	importAlgorithmsPack(String importDataToken, PAImportOperation... operations) Realiza a importação do Pacote de Algoritmos, de acordo com as operações especificadas.
AlgorithmInfo	includePlatform(Object algoId, Object versionId, String platform) Inclui uma plataforma para uma versão de algoritmo.
tecgraf.ftc.common.logic.RemoteFileChannelInfo	prepareDownloadConfigFile(Object algoId, Object versionId, String fileName) Prepara o download de um arquivo de configuração, pertencente ao algoritmo especificado.
tecgraf.ftc.common.logic.RemoteFileChannelInfo	prepareDownloadDocFile(Object algoId, Object versionId, String fileName) Prepara o download de um arquivo de documentação, pertencente ao algoritmo especificado.
tecgraf.ftc.common.logic.RemoteFileChannelInfo	prepareDownloadExecFile(Object algoId, Object versionId, String platformName, String fileName) Prepara o download de um arquivo binário, pertencente ao algoritmo especificado.
tecgraf.ftc.common.logic.RemoteFileChannelInfo	prepareDownloadNotesFile(Object algoId, Object versionId, String fileName) Prepara o download de um arquivo de release notes, pertencente ao algoritmo especificado.
tecgraf.ftc.common.logic.RemoteFileChannelInfo	prepareDownloadVersionPackFile(Object algoId, AlgorithmVersionId versionId, String versionPackFileName) Prepara o download de um arquivo de pacote de versão, pertencente ao algoritmo especificado.
ImportAlgorithmsPackTransferInfo	prepareImportAlgorithmsPack() Prepara o upload de um pacote de algoritmos (arquivo zip), dentro do repositório de algoritmos.
tecgraf.ftc.common.logic.RemoteFileChannelInfo	prepareUploadConfigFile(Object algoId, Object versionId, String fileName, boolean expandIfZip) Prepara o upload de um arquivo de configuração, dentro do algoritmo especificado.
tecgraf.ftc.common.logic.RemoteFileChannelInfo	prepareUploadDocFile(Object algoId, Object versionId, String fileName, boolean expandIfZip) Prepara o upload de um arquivo de documentação, dentro do algoritmo especificado.
tecgraf.ftc.common.logic.RemoteFileChannelInfo	prepareUploadExecFile(Object algoId, Object versionId, String platformName, String fileName, boolean expandIfZip) Prepara o upload de um arquivo binário, dentro do algoritmo especificado.
tecgraf.ftc.common.logic.RemoteFileChannelInfo	prepareUploadReleaseNotesFile(Object algoId, Object versionId, String fileName, boolean expandIfZip) Prepara o upload de um arquivo de release notes, dentro do algoritmo especificado.
tecgraf.ftc.common.logic.RemoteFileChannelInfo	prepareUploadVersionPack(Object algoId, String fileName) Prepara o upload de um pacote de versão (arquivo zip), dentro do algoritmo especificado.
boolean	releaseNotesFileExists(Object algoId, Object versionId, String fileName) Verifica se um determinado arquivo de release notes existe no servidor.
boolean	reloadAlgorithms() Pedido de recarga dos algoritmos.
boolean	removeAlgorithm(Object id) Remove um algoritmo do repositório.
Category	removeCategory(String id) Remove uma categoria de algoritmos, a partir do seu identificador único.
void	removeConfigurationFiles(AlgorithmVersionInfo version, FileInfo[] files) Remove arquivos de configuração de uma versão de algoritmo.
void	removeDocumentationFiles(AlgorithmVersionInfo version, FileInfo[] files) Remove arquivos de documentação de uma versão de algoritmo.
void	removeExecutableFiles(AlgorithmVersionInfo version, String platform, FileInfo[] files) Remove arquivos executáveis de uma versão de algoritmo.
AlgorithmInfo	removePlatform(Object algoId, Object versionId, String platform) Remove uma plataforma de uma versão de algoritmo.
void	removeReleaseNotesFiles(AlgorithmVersionInfo version, FileInfo[] files) Remove arquivos de release notes de uma versão de algoritmo.
AlgorithmInfo	removeVersion(Object algoId, Object versionId) Remove uma versão de algoritmo do repositório.
AlgorithmInfo	renameAlgorithm(Object id, String name) Renomeia o algoritmo.
String	retrieveConfigUploadURL(Object algoId, Object versionId) Obtém a URL para upload de um configurador.
String	retrieveDocUploadURL(Object algoId, Object versionId) Obtém uma URL para permitir o upload de um arquivo de documentação, a partir do disco rígido do usuário para o servidor.
String	retrieveDownloadURL(Object algoId, String[] filePath) Obtem a url para a visualização de um arquivo do algoritmo.
String	retrieveExecUploadURL(Object algoId, Object versionId, String platform) Obtém a URL para upload de um executável.
List<HistoryRecord>	retrieveHistory(String[] path) Recupera o histórico do caminho especificado.
String	retrieveReleaseNotesUploadURL(Object algoId, Object versionId) Obtém uma URL para permitir o upload de um arquivo de release notes, a partir do disco rígido do usuário para o servidor.
String	retrieveVersionUploadURL(Object algoId) Obtém a URL para upload de pacote de versão.
CategorySet	setAlgorithmsToCategories(List<Object> algoIds, List<String> categoryIds) Atribui um conjunto de algoritmos de um conjunto de categorias, substituindo o conjunto anterior.
CategorySet	unbindAlgorithmsFromCategories(List<Object> algoIds, List<String> categoryIds) Desassocia um conjunto de algoritmos de um conjunto de categorias.
String	validateAlgorithmsPack(String importDataToken) Valida o pacote de algoritmos identificado pelo token antes da sua importação.

Methods inherited from interface csbase.remote.TransactionInterface

isLocked, lock, unlock

Methods inherited from interface csbase.remote.ServiceInterface

getName, isActive

Methods inherited from interface csbase.remote.RemoteObservable

addObserver, countObservers, deleteObserver, deleteObservers, notifyObservers

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

Nome do serviço para o ServiceManager

See Also:

Constant Field Values

Method Detail

changeAlgorithmProperties

AlgorithmInfo changeAlgorithmProperties(String name,
                                        Hashtable<String,String> newValues)
                                 throws RemoteException,
                                        AlgorithmNotFoundException

Altera as propriedades de um algoritmo.

Parameters:

name - Nome do algoritmo

newValues - Mapa das propriedades

Returns:

As informações alteradas do algoritmo

Throws:

RemoteException - Erro de RMI.

AlgorithmNotFoundException - caso o algoritmo não seja encontrado

changeVersionProperties

AlgorithmInfo changeVersionProperties(String name,
                                      AlgorithmVersionId versionId,
                                      Hashtable<String,String> newValues)
                               throws RemoteException,
                                      AlgorithmNotFoundException

Altera as propriedades de uma versão de um algoritmo.

Parameters:

name - Nome do algoritmo.

versionId - Identificador da versão

newValues - Mapa das propriedades

Returns:

As informações alteradas do algoritmo

Throws:

RemoteException - Erro de RMI.

AlgorithmNotFoundException - caso o algoritmo ou não seja encontrado

copyFiles

void copyFiles(AlgorithmVersionInfo sourceVersion,
               List<FileInfo> files,
               IPathFactory sourcePathFactory,
               AlgorithmVersionInfo targetVersion,
               FileInfo targetDir,
               IPathFactory targetPathFactory,
               boolean setExecutables)
        throws RemoteException

Copia arquivos de uma pasta para a outra com a possibilidade de dar permissão de execução às cópias.

Parameters:

sourceVersion - Informações da versão de origem.

files - Arquivos a serem transferidos.

sourcePathFactory - Fábrica para criar o caminho dos arquivos a serem transferidos.

targetVersion - Informações da versão de destino.

targetDir - diretório de destino.

targetPathFactory - Fábrica para criar o caminho dos arquivos de destino. Este caminho é relativo ao valor do parâmetro targetDir.

setExecutables - true se as cópias deverão ter permissão de execução ou não.

Throws:

RemoteException - Erro de RMI.

createCategory

Category createCategory(String parentCategoryId,
                        String name)
                 throws RemoteException,
                        CategoriesFileNotSavedException

Cria uma categoria de algoritmos como filha de uma categoria ou do primeiro nível. Nesse caso, deve-se passar null para o identificador da categoria pai.

Parameters:

parentCategoryId - identificador da categoria pai. Se for null, então a categoria será criada na raiz, caso contrário, como sub-categoria

name - nome da categoria

Returns:

retorna a categoria criada, ou null, caso a categoria não tenha sido encontrada

Throws:

RemoteException - erro de RMI

CategoriesFileNotSavedException - erro ao tentar gravar o xml de categorias

removeCategory

Category removeCategory(String id)
                 throws RemoteException,
                        CategoriesFileNotSavedException

Remove uma categoria de algoritmos, a partir do seu identificador único. A categoria a ser removida pode estar na raiz de categorias ou ser uma sub-categoria.

Parameters:

id - identificador da categoria a ser removida

Returns:

retorna a categoria removida, ou null, caso a categoria não tenha sido encontrada

Throws:

RemoteException - erro de RMI

CategoriesFileNotSavedException - erro ao tentar gravar o xml de categorias

bindAlgorithmsToCategories

CategorySet bindAlgorithmsToCategories(List<Object> algoIds,
                                       List<String> categoryIds)
                                throws RemoteException,
                                       CategoriesFileNotSavedException

Associa um conjunto de algoritmos a um conjunto de categorias. Nesse caso, para cada categoria da lista de categorias serão adicionados todos os algoritmos da lista de algoritmos. Essa informação será persistida em xml.

Parameters:

categoryIds - lista de identificadores das categorias

algoIds - lista de identificadores dos algoritmos

Returns:

retorna o conjunto de categorias modificadas

Throws:

RemoteException - erro de RMI

CategoriesFileNotSavedException - erro ao tentar gravar o xml de categorias

unbindAlgorithmsFromCategories

CategorySet unbindAlgorithmsFromCategories(List<Object> algoIds,
                                           List<String> categoryIds)
                                    throws RemoteException,
                                           CategoriesFileNotSavedException

Desassocia um conjunto de algoritmos de um conjunto de categorias. Nesse caso, para cada categoria da lista de categorias serão removidos todos os algoritmos da lista de algoritmos. Essa informação será persistida em xml.

Parameters:

categoryIds - lista de identificadores das categorias

algoIds - lista de identificadores dos algoritmos

Returns:

retorna o conjunto de categorias modificadas

Throws:

RemoteException - erro de RMI

CategoriesFileNotSavedException - erro ao tentar gravar o xml de categorias

setAlgorithmsToCategories

CategorySet setAlgorithmsToCategories(List<Object> algoIds,
                                      List<String> categoryIds)
                               throws RemoteException,
                                      CategoriesFileNotSavedException

Atribui um conjunto de algoritmos de um conjunto de categorias, substituindo o conjunto anterior.

Parameters:

categoryIds - lista de identificadores das categorias

algoIds - lista de identificadores dos algoritmos

Returns:

retorna o conjunto de categorias modificadas

Throws:

RemoteException - erro de RMI

CategoriesFileNotSavedException - erro ao tentar gravar o xml de categorias

createAlgorithm

AlgorithmInfo createAlgorithm(String name,
                              String id,
                              Hashtable<String,String> properties)
                       throws RemoteException

Cria um algoritmo a partir do nome, do identificador e das propriedades informadas.

Parameters:

name - Nome do algoritmo

id - Identificador do algoritmo

properties - Propriedades do algoritmo

Returns:

As informações do algoritmo criado

Throws:

RemoteException - Erro de RMI.

renameAlgorithm

AlgorithmInfo renameAlgorithm(Object id,
                              String name)
                       throws RemoteException

Renomeia o algoritmo.

Parameters:

id - Identificador do algoritmo

name - novo nome do algoritmo

Returns:

As informações do algoritmo atualizadas

Throws:

RemoteException - Erro de RMI.

createAlgorithmConfigurator

AlgorithmConfigurator createAlgorithmConfigurator(String algorithmName,
                                                  AlgorithmVersionId algorithmVersionId)
                                           throws RemoteException,
                                                  AlgorithmNotFoundException

Cria um configurador para uma versão específica de um algoritmo.

Parameters:

algorithmName - .

algorithmVersionId - .

Returns:

o configurador ou null caso o algoritmo ou versão não estejam cadastrados

Throws:

RemoteException - Erro de RMI.

AlgorithmNotFoundException - quando o algoritmo ou versão não são encontrados

createVersion

AlgorithmInfo createVersion(Object algoId,
                            int major,
                            int minor,
                            int patch,
                            Hashtable<String,String> properties)
                     throws RemoteException

Cria no repositório a estrutura para uma nova versão de algoritmo.

Parameters:

algoId - identificador do algoritmo

major - numero da versão

minor - numero da revisão

patch - numero da correção

properties - Mapa com as propriedades da versão.

Returns:

informações atualizadas do algoritmo

Throws:

PermissionException - caso o usuário não tenha permissão para acessar o serviço de algoritmos.

RemoteException - Erro de RMI.

duplicateVersion

void duplicateVersion(Object algoId,
                      Object versionIdFrom,
                      int majorTo,
                      int minorTo,
                      int patchTo)
               throws RemoteException

Cria uma nova versão do algoritmo com o mesmos dados que a versão dada. Ou seja, cria a versão, copia os arquivos de documentação e configuração, insere as plataformas e copia os executáveis.

Parameters:

algoId - id do algoritmo

versionIdFrom - id da versão de origem

majorTo - número da versão

minorTo - número da revisão

patchTo - número da correção

Throws:

RemoteException - Erro de RMI.

getAlgorithmProperties

List<AlgorithmProperty> getAlgorithmProperties()
                                        throws RemoteException

Obtém a Retorna a lista de Property dos algoritmos. Cada Property mapeia a chave da propriedade ao Label (String de apresentação).

Returns:

Lista com as propriedades dos algoritmos. Caso não haja propriedades, retorna uma lista vazia.

Throws:

RemoteException - Erro de RMI.

getAllIds

Object[] getAllIds()
            throws RemoteException

Retorna de todos os identificadores dos algoritmos cadastrados.

Returns:

um array de strings com os identificadores.

Throws:

RemoteException - Erro de RMI.

getAllInfo

AlgorithmInfo[] getAllInfo()
                    throws RemoteException

Retorna todos os dados de todos os algoritmos cadastrados.

Returns:

um array com as informações de todos os algoritmos cadastrados

Throws:

RemoteException - Erro de RMI.

getAllOutlines

AlgorithmOutline[] getAllOutlines()
                           throws RemoteException

Retorna todos os resumos dos algoritmos cadastrados.

Returns:

um array com os resumos ou null se não houver algoritmos instalados.

Throws:

RemoteException - Erro de RMI.

getParameterFactories

Map<String,ParameterFactory> getParameterFactories()
                                            throws RemoteException

Retorna as fábricas dos parâmetros disponíveis no sistema.

Returns:

um mapa de fábricas de parâmetros indexado pela tag xml correspondente.

Throws:

RemoteException - Erro de RMI.

getInfo

AlgorithmInfo getInfo(Object id)
               throws RemoteException

Retorna informações de um algoritmo.

Parameters:

id - identificador do algoritmo

Returns:

as informações solicitadas

Throws:

RemoteException - Erro de RMI.

getInfo

AlgorithmInfo getInfo(String name)
               throws RemoteException

Retorna informações de um algoritmo a partir do nome

Parameters:

name - O nome do algoritmo

Returns:

as informações solicitadas

Throws:

RemoteException - Erro de RMI.

getAllCategories

CategorySet getAllCategories()
                      throws RemoteException

Obtém o conjunto de categorias disponíveis no servidor.

Returns:

o conjunto de categorias

Throws:

RemoteException - Erro de RMI.

getCategory

Category getCategory(String id)
              throws RemoteException

Obtém uma categoria que possui o identificador especificado.

Parameters:

id - identificador da categoria

Returns:

a categoria encontrada, caso contrário, retorna null

Throws:

RemoteException - erro de rmi

getVersionProperties

List<AlgorithmProperty> getVersionProperties()
                                      throws RemoteException

Obtém a Retorna a lista de Property dos algoritmos. Cada Property mapeia a chave da propriedade ao Label (String de apresentação).

Returns:

Lista com as propriedades das versões dos algoritmos. Caso não haja propriedades, retorna uma lista vazia.

Throws:

RemoteException - Erro de RMI.

includePlatform

AlgorithmInfo includePlatform(Object algoId,
                              Object versionId,
                              String platform)
                       throws RemoteException

Inclui uma plataforma para uma versão de algoritmo.

Parameters:

algoId - identificador do algoritmo

versionId - identificador da versão

platform - plataforma a incluir

Returns:

informações atualizadas do algoritmo

Throws:

PermissionException - caso o usuário não tenha permissão para acessar o serviço de algoritmos.

RemoteException - Erro de RMI.

reloadAlgorithms

boolean reloadAlgorithms()
                  throws RemoteException

Pedido de recarga dos algoritmos.

Returns:

true caso a recarga tenha sido efetuada com sucesso.

Throws:

RemoteException - Erro de RMI.

removeAlgorithm

boolean removeAlgorithm(Object id)
                 throws RemoteException

Remove um algoritmo do repositório.

Parameters:

id - identificador do algoritmo a ser removido

Returns:

true se a remoção teve sucesso, false caso contrário

Throws:

PermissionException - caso o usuário não tenha permissão para acessar o serviço de algoritmos.

RemoteException - Erro de RMI.

removeExecutableFiles

void removeExecutableFiles(AlgorithmVersionInfo version,
                           String platform,
                           FileInfo[] files)
                    throws RemoteException

Remove arquivos executáveis de uma versão de algoritmo.

Parameters:

version - Versão que detém os arquivos.

platform - Plataforma que detém os arquivos.

files - Representação dos arquivos a serem removidos.

Throws:

RemoteException - Erro de RMI

removeConfigurationFiles

void removeConfigurationFiles(AlgorithmVersionInfo version,
                              FileInfo[] files)
                       throws RemoteException

Remove arquivos de configuração de uma versão de algoritmo.

Parameters:

version - Versão que detém os arquivos.

files - Representação dos arquivos a serem removidos.

Throws:

RemoteException - Erro de RMI

removeDocumentationFiles

void removeDocumentationFiles(AlgorithmVersionInfo version,
                              FileInfo[] files)
                       throws RemoteException

Remove arquivos de documentação de uma versão de algoritmo.

Parameters:

version - Versão que detém os arquivos.

files - Representação dos arquivos a serem removidos.

Throws:

RemoteException - Erro de RMI

removeReleaseNotesFiles

void removeReleaseNotesFiles(AlgorithmVersionInfo version,
                             FileInfo[] files)
                      throws RemoteException

Remove arquivos de release notes de uma versão de algoritmo.

Parameters:

version - Versão que detém os arquivos.

files - Representação dos arquivos a serem removidos.

Throws:

RemoteException - Erro de RMI

removePlatform

AlgorithmInfo removePlatform(Object algoId,
                             Object versionId,
                             String platform)
                      throws RemoteException

Remove uma plataforma de uma versão de algoritmo.

Parameters:

algoId - identificador do algoritmo

versionId - identificador da versão

platform - plataforma a remover

Returns:

informações atualizadas do algoritmo

Throws:

PermissionException - caso o usuário não tenha permissão para acessar o serviço de algoritmos.

RemoteException - Erro de RMI.

removeVersion

AlgorithmInfo removeVersion(Object algoId,
                            Object versionId)
                     throws RemoteException

Remove uma versão de algoritmo do repositório.

Parameters:

algoId - identificador do algoritmo

versionId - identificador da versão

Returns:

informações atualizadas do algoritmo

Throws:

PermissionException - caso o usuário não tenha permissão para acessar o serviço de algoritmos.

RemoteException - Erro de RMI.

retrieveConfigUploadURL

String retrieveConfigUploadURL(Object algoId,
                               Object versionId)
                        throws RemoteException

Obtém a URL para upload de um configurador.

Parameters:

algoId - identificador do algoritmo

versionId - Identificador da versão do algoritmo

Returns:

url para upload

Throws:

RemoteException - Erro de RMI.

retrieveDocUploadURL

String retrieveDocUploadURL(Object algoId,
                            Object versionId)
                     throws RemoteException

Obtém uma URL para permitir o upload de um arquivo de documentação, a partir do disco rígido do usuário para o servidor.

Parameters:

algoId - identificador do algoritmo que irá receber o arquivo.

versionId - identificador da versão que irá receber o arquivo.

Returns:

URL para upload de arquivo de documentação.

Throws:

RemoteException - Erro de RMI.

retrieveReleaseNotesUploadURL

String retrieveReleaseNotesUploadURL(Object algoId,
                                     Object versionId)
                              throws RemoteException

Obtém uma URL para permitir o upload de um arquivo de release notes, a partir do disco rígido do usuário para o servidor.

Parameters:

algoId - identificador do algoritmo que irá receber o arquivo.

versionId - identificador da versão que irá receber o arquivo.

Returns:

URL para upload de arquivo de release notes.

Throws:

RemoteException - Erro de RMI.

retrieveDownloadURL

String retrieveDownloadURL(Object algoId,
                           String[] filePath)
                    throws RemoteException

Obtem a url para a visualização de um arquivo do algoritmo.

Parameters:

algoId - identificador do algoritmo ao qual o arquivo pertence.

filePath - caminho para o arquivo a partir da raiz do algoritmo.

Returns:

url para visualização de um arquivo do algoritmo em um navegador.

Throws:

RemoteException - Erro de RMI.

retrieveExecUploadURL

String retrieveExecUploadURL(Object algoId,
                             Object versionId,
                             String platform)
                      throws RemoteException

Obtém a URL para upload de um executável.

Parameters:

algoId - identificador do algoritmo

versionId - Identificador da versão do algoritmo

platform - Plataforma do algoritmo

Returns:

url para upload

Throws:

RemoteException - Erro de RMI.

retrieveVersionUploadURL

String retrieveVersionUploadURL(Object algoId)
                         throws RemoteException

Obtém a URL para upload de pacote de versão.

Parameters:

algoId - identificador do algoritmo

Returns:

url para upload

Throws:

RemoteException - Erro de RMI.

retrieveHistory

List<HistoryRecord> retrieveHistory(String[] path)
                             throws RemoteException

Recupera o histórico do caminho especificado.

Parameters:

path - identificador do caminho interno à versão.

Returns:

List contendo instâncias de HistoryRecord , representando o histórico do caminho especificado ou null se não for possível recuperar o histórico.

Throws:

RemoteException - Erro de RMI.

prepareUploadExecFile

tecgraf.ftc.common.logic.RemoteFileChannelInfo prepareUploadExecFile(Object algoId,
                                                                     Object versionId,
                                                                     String platformName,
                                                                     String fileName,
                                                                     boolean expandIfZip)
                                                              throws RemoteException

Prepara o upload de um arquivo binário, dentro do algoritmo especificado.

Como o upload é feito por uma conexão entre sockets, o uso deste método preparatório é necessário para evitar que clientes não-autenticados consigam escrever no sistema de arquivos do servidor. Dessa forma, o cliente é obrigado primeiro a passar por este método, autenticar-se, obter uma chave que guarda as informações necessárias para a transferência (sem as quais não consegue transmitir), para então repassá-la via socket. De posse da chave, o servidor já sabe que o cliente está autenticado e pode então prosseguir com a transferência.

O método retorna um objeto contendo todas as informações necessárias para solicitar a transferência, a ser realizada posteriormente.

Parameters:

algoId - identificador do algoritmo.

versionId - identificador da versão.

platformName - nome da plataforma.

fileName - nome do arquivo de destino.

expandIfZip - flag indicando que ao final do upload, caso o arquivo seja um zip o servidor deve descompactar ele.

Returns:

objeto contendo as informações necessárias para a solicitar a transferência.

Throws:

RemoteException - Erro de RMI.

prepareUploadConfigFile

tecgraf.ftc.common.logic.RemoteFileChannelInfo prepareUploadConfigFile(Object algoId,
                                                                       Object versionId,
                                                                       String fileName,
                                                                       boolean expandIfZip)
                                                                throws RemoteException

Prepara o upload de um arquivo de configuração, dentro do algoritmo especificado.

Como o upload é feito por uma conexão entre sockets, o uso deste método preparatório é necessário para evitar que clientes não-autenticados consigam escrever no sistema de arquivos do servidor. Dessa forma, o cliente é obrigado primeiro a passar por este método, autenticar-se, obter uma chave que guarda as informações necessárias para a transferência (sem as quais não consegue transmitir), para então repassá-la via socket. De posse da chave, o servidor já sabe que o cliente está autenticado e pode então prosseguir com a transferência.

O método retorna um objeto contendo todas as informações necessárias para solicitar a transferência, a ser realizada posteriormente.

Parameters:

algoId - identificador do algoritmo.

versionId - identificador da versão.

fileName - nome do arquivo de destino.

expandIfZip - flag indicando que ao final do upload, caso o arquivo seja um zip o servidor deve descompactar ele.

Returns:

objeto contendo as informações necessárias para a solicitar a transferência.

Throws:

RemoteException - Erro de RMI.

prepareUploadDocFile

tecgraf.ftc.common.logic.RemoteFileChannelInfo prepareUploadDocFile(Object algoId,
                                                                    Object versionId,
                                                                    String fileName,
                                                                    boolean expandIfZip)
                                                             throws RemoteException

Prepara o upload de um arquivo de documentação, dentro do algoritmo especificado.

Como o upload é feito por uma conexão entre sockets, o uso deste método preparatório é necessário para evitar que clientes não-autenticados consigam escrever no sistema de arquivos do servidor. Dessa forma, o cliente é obrigado primeiro a passar por este método, autenticar-se, obter uma chave que guarda as informações necessárias para a transferência (sem as quais não consegue transmitir), para então repassá-la via socket. De posse da chave, o servidor já sabe que o cliente está autenticado e pode então prosseguir com a transferência.

O método retorna um objeto contendo todas as informações necessárias para solicitar a transferência, a ser realizada posteriormente.

Parameters:

algoId - identificador do algoritmo.

versionId - identificador da versão.

fileName - nome do arquivo de destino.

expandIfZip - flag indicando que ao final do upload, caso o arquivo seja um zip o servidor deve descompactar ele.

Returns:

objeto contendo as informações necessárias para a solicitar a transferência.

Throws:

RemoteException - Erro de RMI.

prepareUploadReleaseNotesFile

tecgraf.ftc.common.logic.RemoteFileChannelInfo prepareUploadReleaseNotesFile(Object algoId,
                                                                             Object versionId,
                                                                             String fileName,
                                                                             boolean expandIfZip)
                                                                      throws RemoteException

Prepara o upload de um arquivo de release notes, dentro do algoritmo especificado.

Como o upload é feito por uma conexão entre sockets, o uso deste método preparatório é necessário para evitar que clientes não-autenticados consigam escrever no sistema de arquivos do servidor. Dessa forma, o cliente é obrigado primeiro a passar por este método, autenticar-se, obter uma chave que guarda as informações necessárias para a transferência (sem as quais não consegue transmitir), para então repassá-la via socket. De posse da chave, o servidor já sabe que o cliente está autenticado e pode então prosseguir com a transferência.

O método retorna um objeto contendo todas as informações necessárias para solicitar a transferência, a ser realizada posteriormente.

Parameters:

algoId - identificador do algoritmo.

versionId - identificador da versão.

fileName - nome do arquivo de destino.

expandIfZip - flag indicando que ao final do upload, caso o arquivo seja um zip o servidor deve descompactar ele.

Returns:

objeto contendo as informações necessárias para a solicitar a transferência.

Throws:

RemoteException - Erro de RMI.

prepareDownloadExecFile

tecgraf.ftc.common.logic.RemoteFileChannelInfo prepareDownloadExecFile(Object algoId,
                                                                       Object versionId,
                                                                       String platformName,
                                                                       String fileName)
                                                                throws RemoteException

Prepara o download de um arquivo binário, pertencente ao algoritmo especificado.

Como o download é feito por uma conexão entre sockets, o uso deste método preparatório é necessário para evitar que clientes não-autenticados consigam ler no sistema de arquivos do servidor. Dessa forma, o cliente é obrigado primeiro a passar por este método, autenticar-se, obter uma chave que guarda as informações necessárias para a transferência (sem as quais não consegue transmitir), para então repassá-la via socket. De posse da chave, o servidor já sabe que o cliente está autenticado e pode então prosseguir com a transferência.

O método retorna um objeto contendo todas as informações necessárias para solicitar a transferência, a ser realizada posteriormente.

Parameters:

algoId - identificador do algoritmo.

versionId - identificador da versão.

platformName - nome da plataforma.

fileName - nome do arquivo de origem.

Returns:

objeto contendo as informações necessárias para solicitar a transferência.

Throws:

RemoteException - Erro de RMI.

prepareDownloadConfigFile

tecgraf.ftc.common.logic.RemoteFileChannelInfo prepareDownloadConfigFile(Object algoId,
                                                                         Object versionId,
                                                                         String fileName)
                                                                  throws RemoteException

Prepara o download de um arquivo de configuração, pertencente ao algoritmo especificado.

Como o download é feito por uma conexão entre sockets, o uso deste método preparatório é necessário para evitar que clientes não-autenticados consigam ler no sistema de arquivos do servidor. Dessa forma, o cliente é obrigado primeiro a passar por este método, autenticar-se, obter uma chave que guarda as informações necessárias para a transferência (sem as quais não consegue transmitir), para então repassá-la via socket. De posse da chave, o servidor já sabe que o cliente está autenticado e pode então prosseguir com a transferência.

O método retorna um objeto contendo todas as informações necessárias para solicitar a transferência, a ser realizada posteriormente.

Parameters:

algoId - identificador do algoritmo.

versionId - identificador da versão.

fileName - nome do arquivo de origem.

Returns:

objeto contendo as informações necessárias para solicitar a transferência.

Throws:

RemoteException - Erro de RMI.

prepareDownloadDocFile

tecgraf.ftc.common.logic.RemoteFileChannelInfo prepareDownloadDocFile(Object algoId,
                                                                      Object versionId,
                                                                      String fileName)
                                                               throws RemoteException

Prepara o download de um arquivo de documentação, pertencente ao algoritmo especificado.

Como o download é feito por uma conexão entre sockets, o uso deste método preparatório é necessário para evitar que clientes não-autenticados consigam ler no sistema de arquivos do servidor. Dessa forma, o cliente é obrigado primeiro a passar por este método, autenticar-se, obter uma chave que guarda as informações necessárias para a transferência (sem as quais não consegue transmitir), para então repassá-la via socket. De posse da chave, o servidor já sabe que o cliente está autenticado e pode então prosseguir com a transferência.

O método retorna um objeto contendo todas as informações necessárias para solicitar a transferência, a ser realizada posteriormente.

Parameters:

algoId - identificador do algoritmo.

versionId - identificador da versão.

fileName - nome do arquivo de origem.

Returns:

objeto contendo as informações necessárias para solicitar a transferência.

Throws:

RemoteException - Erro de RMI.

prepareDownloadNotesFile

tecgraf.ftc.common.logic.RemoteFileChannelInfo prepareDownloadNotesFile(Object algoId,
                                                                        Object versionId,
                                                                        String fileName)
                                                                 throws RemoteException

Prepara o download de um arquivo de release notes, pertencente ao algoritmo especificado.

Como o download é feito por uma conexão entre sockets, o uso deste método preparatório é necessário para evitar que clientes não-autenticados consigam ler no sistema de arquivos do servidor. Dessa forma, o cliente é obrigado primeiro a passar por este método, autenticar-se, obter uma chave que guarda as informações necessárias para a transferência (sem as quais não consegue transmitir), para então repassá-la via socket. De posse da chave, o servidor já sabe que o cliente está autenticado e pode então prosseguir com a transferência.

O método retorna um objeto contendo todas as informações necessárias para solicitar a transferência, a ser realizada posteriormente.

Parameters:

algoId - identificador do algoritmo.

versionId - identificador da versão.

fileName - nome do arquivo de origem.

Returns:

objeto contendo as informações necessárias para solicitar a transferência.

Throws:

RemoteException - Erro de RMI.

configFileExists

boolean configFileExists(Object algoId,
                         Object versionId,
                         String fileName)
                  throws RemoteException

Verifica se um determinado arquivo de configuração existe no servidor.

Parameters:

algoId - identificador do algoritmo.

versionId - identificador da versão.

fileName - nome do arquivo de configuração.

Returns:

true se o arquivo já existir no servidor.

Throws:

RemoteException - Erro de RMI.

docFileExists

boolean docFileExists(Object algoId,
                      Object versionId,
                      String fileName)
               throws RemoteException

Verifica se um determinado arquivo de documentação existe no servidor.

Parameters:

algoId - identificador do algoritmo.

versionId - identificador da versão.

fileName - nome do arquivo de documentação.

Returns:

true se o arquivo já existir no servidor.

Throws:

RemoteException - Erro de RMI.

releaseNotesFileExists

boolean releaseNotesFileExists(Object algoId,
                               Object versionId,
                               String fileName)
                        throws RemoteException

Verifica se um determinado arquivo de release notes existe no servidor.

Parameters:

algoId - identificador do algoritmo.

versionId - identificador da versão.

fileName - nome do arquivo de documentação.

Returns:

true se o arquivo já existir no servidor.

Throws:

RemoteException - Erro de RMI.

execFileExists

boolean execFileExists(Object algoId,
                       Object versionId,
                       String platformName,
                       String fileName)
                throws RemoteException

Verifica se um determinado arquivo executável existe no servidor.

Parameters:

algoId - identificador do algoritmo.

versionId - identificador da versão.

platformName - nome da plataforma.

fileName - nome do arquivo executável.

Returns:

true se o arquivo já existir no servidor.

Throws:

RemoteException - Erro de RMI.

prepareUploadVersionPack

tecgraf.ftc.common.logic.RemoteFileChannelInfo prepareUploadVersionPack(Object algoId,
                                                                        String fileName)
                                                                 throws RemoteException

Prepara o upload de um pacote de versão (arquivo zip), dentro do algoritmo especificado.

Como o upload é feito por uma conexão entre sockets, o uso deste método preparatório é necessário para evitar que clientes não-autenticados consigam escrever no sistema de arquivos do servidor. Dessa forma, o cliente é obrigado primeiro a passar por este método, autenticar-se, obter uma chave que guarda as informações necessárias para a transferência (sem as quais não consegue transmitir), para então repassá-la via socket. De posse da chave, o servidor já sabe que o cliente está autenticado e pode então prosseguir com a transferência.

O método retorna um objeto contendo todas as informações necessárias para solicitar a transferência, a ser realizada posteriormente.

Parameters:

algoId - identificador do algoritmo.

fileName - nome do arquivo de destino.

Returns:

objeto contendo as informações necessárias para a solicitar a transferência.

Throws:

RemoteException - Erro de RMI.

prepareDownloadVersionPackFile

tecgraf.ftc.common.logic.RemoteFileChannelInfo prepareDownloadVersionPackFile(Object algoId,
                                                                              AlgorithmVersionId versionId,
                                                                              String versionPackFileName)
                                                                       throws RemoteException

Prepara o download de um arquivo de pacote de versão, pertencente ao algoritmo especificado.

Como o download é feito por uma conexão entre sockets, o uso deste método preparatório é necessário para evitar que clientes não-autenticados consigam ler no sistema de arquivos do servidor. Dessa forma, o cliente é obrigado primeiro a passar por este método, autenticar-se, obter uma chave que guarda as informações necessárias para a transferência (sem as quais não consegue transmitir), para então repassá-la via socket. De posse da chave, o servidor já sabe que o cliente está autenticado e pode então prosseguir com a transferência.

O método retorna um objeto contendo todas as informações necessárias para solicitar a transferência, a ser realizada posteriormente.

Parameters:

algoId - identificador do algoritmo.

versionId - identificador da versão.

versionPackFileName - nome do arquivo de pacote de versão origem

Returns:

objeto contendo as informações necessárias para solicitar a transferência

Throws:

RemoteException - RemoteException Erro de RMI

prepareImportAlgorithmsPack

ImportAlgorithmsPackTransferInfo prepareImportAlgorithmsPack()
                                                      throws RemoteException

Prepara o upload de um pacote de algoritmos (arquivo zip), dentro do repositório de algoritmos.

Como o upload é feito por uma conexão entre sockets, o uso deste método preparatório é necessário para evitar que clientes não-autenticados consigam escrever no sistema de arquivos do servidor. Dessa forma, o cliente é obrigado primeiro a passar por este método, autenticar-se, obter uma chave que guarda as informações necessárias para a transferência (sem as quais não consegue transmitir), para então repassá-la via socket. De posse da chave, o servidor já sabe que o cliente está autenticado e pode então prosseguir com a transferência.

O método retorna um objeto contendo todas as informações necessárias para solicitar a transferência, a ser realizada posteriormente.

Returns:

objeto contendo as informações necessárias para a solicitar a transferência.

Throws:

RemoteException - Erro de RMI.

getAlgorithmsPackInfo

AlgorithmsPack getAlgorithmsPackInfo(String importDataToken)
                              throws RemoteException

Obtém os algoritmos que fazem parte do Pacote de Algoritmos, sem ainda terem passado por uma validação.

Parameters:

importDataToken - identificador único do dado (PA) a ser importado

Returns:

o pacote de algoritmos sem validação dos algoritmos

Throws:

RemoteException - erro de rmi.

PermissionException - caso o usuário que solicite a consulta não seja o mesmo que requisitou a preparação da importação.

importAlgorithmsPack

boolean importAlgorithmsPack(String importDataToken,
                             PAImportOperation... operations)
                      throws RemoteException

Realiza a importação do Pacote de Algoritmos, de acordo com as operações especificadas. Essas operações vão determinar o critério para resolução de conflitos a ser adotado, ou seja, se vai substituir ou manter um algoritmo que já exista no repositório, se vai manter uma versão específica, se uma nova categoria deve ser criada, e assim por diante.

Parameters:

importDataToken - identificador único do dado (PA) a ser importado

operations - operações a serem realizadas na importação do PA

Returns:

retorna true, se a importação foi realizada com sucesso, caso contrário, retorna false

Throws:

RemoteException - erro de rmi.

PermissionException - caso o usuário que solicite a consulta não seja o mesmo que requisitou a preparação da importação.

finishImportAlgorithmsPack

void finishImportAlgorithmsPack(String importDataToken)
                         throws RemoteException

Finaliza o processo de importação do Pacote de Algoritmos identificado pelo token, removendo os diretórios e arquivos criados temporariamente.

Parameters:

importDataToken - identificador único do dado (PA) a ser importado

Throws:

RemoteException - erro de rmi.

PermissionException - caso o usuário que solicite a consulta não seja o mesmo que requisitou a preparação da importação.

validateAlgorithmsPack

String validateAlgorithmsPack(String importDataToken)
                       throws RemoteException

Valida o pacote de algoritmos identificado pelo token antes da sua importação.

Parameters:

importDataToken - identificador único do dado (PA) a ser importado

Returns:

retorna um texto com a informação sobre os algoritmos válidos e sobre os inválidos

Throws:

RemoteException - erro de rmi.