csbase.server.services.commandpersistenceservice

Class CommandPersistenceService

java.lang.Object

csbase.remote.RemoteObjectObservable

csbase.server.ServerRemoteObjectObservable

csbase.server.Service

csbase.server.services.commandpersistenceservice.CommandPersistenceService

All Implemented Interfaces:

csbase.remote.CommandPersistenceServiceInterface, csbase.remote.RemoteObservable, csbase.remote.RemoteObserverNotifierInterface, csbase.remote.ServiceInterface, Remote

public final class CommandPersistenceService
extends Service
implements csbase.remote.CommandPersistenceServiceInterface

Serviço de persistência de comandos.

Author:

TecGraf/PUC-Rio

See Also:

CommandPersistenceServiceInterface

Nested Class Summary

Nested classes/interfaces inherited from interface csbase.remote.CommandPersistenceServiceInterface

csbase.remote.CommandPersistenceServiceInterface.CommandInfosRetrived

Field Summary

Fields inherited from class csbase.remote.RemoteObjectObservable

observerManager

Fields inherited from interface csbase.remote.CommandPersistenceServiceInterface

SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
void	addCommandStatusListener(CommandStatusListener listener) Adiciona um listener para executar alguma ação na mudança de status de um comando.
void	addICommandStatusListener(csbase.server.plugin.service.commandpersistenceservice.ICommandStatusListener listener) Adiciona um listener para executar alguma ação na mudança de status de um comando.
void	appendToFile(csbase.logic.CommandInfo cmd, String filename, String chunk) Insere no final do um arquivo no diretório LOGS_DIRECTORY_NAME.
static void	createService() Constrói a instância do serviço de escalonamento.
void	createUniqueCommandDirectory(Object projectId, String commandId) O método createUniqueCommandDirectory deve garantir que o identificador do comando seja único.
String[]	getCommandDirectory(String commandId) Obtém o diretório aonde foram/serão salvos os dados do comando.
csbase.logic.CommandInfo	getCommandInfo(Object projectId, String commandId)
Set<csbase.logic.CommandInfo>	getCommandInfos(Object projectId)
String[][]	getCommandScripts(String commandId, Object projectId) Obtém o conjunto de scripts de um comando específico.
String	getCommandsDirectoryName() Obtém o nome do diretório de persistência dos arquivos associados às execuções dos comandos (default = .cmds).
protected Service[]	getInitializationDependencies() Obtém todos os serviços dos quais este serviço depende para a sua inicialização.
static CommandPersistenceService	getInstance() Retorno da instância do serviço.
String[]	getLogDirectory(String commandId) Obtém o caminho do diretório onde devem ser gerados os arquivos de log.
Set<csbase.logic.CommandInfo>	getStatusCommandInfos(Object projectId, List<csbase.logic.CommandStatus> statusFilter, boolean include)
protected boolean	has2Update(Object arg, Object event)
void	initService() Inicialização do serviço
void	notifyUsers(Collection<Object> allUsers, csbase.logic.algorithms.commands.CommandPersistenceNotification notification) Notifica usuários sobre eventos ocorridos com comandos.
csbase.logic.algorithms.AlgorithmConfigurator	readAlgorithmConfigurator(Object projectId, String commandId)
void	removeAllCommandStatusListener() Remove todos os listeners que executam alguma ação na mudança de status de um comando.
void	removeAllICommandStatusListener() Remove todos os listeners que executam alguma ação na mudança de status de um comando.
boolean	removeCommandInfo(Object projectId, String commandId)
boolean[]	removeCommandInfos(List<Object> projectIds, List<String> commandIds)
long	requestCommandInfos(Object projectId, long desiredResponseTime)
void	saveCommandInfo(csbase.logic.CommandInfo command) Salva o comando informado.
void	saveCommandScript(String fileName, String commandId, Object projectId, String commandLine) Persiste a linha de comando em um arquivo de script.
void	shutdownService() Método invocado no término do serviço.
void	updateCommandDescription(Object projectId, String commandId, String description)
void	updateCommandInfo(csbase.logic.CommandInfo command) Atualiza as informações do comando.
void	updateCommandStatus(csbase.logic.CommandInfo command) Atualiza o status do comando.

Methods inherited from class csbase.server.Service

getBooleanProperty, getDefaultLocale, getDoubleProperty, getExternalPropertyFile, getFormattedString, getFormattedString, getInstance, getIntProperty, getKey, getLongProperty, getName, getOptionalString, getOptionalString, getOSPropertyPath, getSenderName, getServices, getString, getString, getStringListProperty, getStringProperty, getSystemId, getThreadLocale, getUser, getUserPermission, hasProperty, incrCounter, isActive, isEnabled, isInternalServerRequest, isLoggingNotifications, isPropertyNull, logNotification, setEnabled, setKey, setSystemId, setUserId, setUserLocale

Methods inherited from class csbase.server.ServerRemoteObjectObservable

handleException, handleFatalError

Methods inherited from class csbase.remote.RemoteObjectObservable

addObserver, countObservers, deleteObserver, deleteObserver, deleteObservers, has2update, notifyObservers

Methods inherited from class java.lang.Object

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

Methods inherited from interface csbase.remote.ServiceInterface

getName, isActive

Method Detail

createService

public static void createService()
                          throws ServerException

Constrói a instância do serviço de escalonamento.

Throws:

ServerException - se houver erro na inicialização.

getInstance

public static CommandPersistenceService getInstance()

Retorno da instância do serviço.

Returns:

o serviço.

getCommandDirectory

public String[] getCommandDirectory(String commandId)

Obtém o diretório aonde foram/serão salvos os dados do comando.

Parameters:

commandId - Identificador do comando.

Returns:

O diretório do comando ou null se o comando não existir.

getLogDirectory

public String[] getLogDirectory(String commandId)

Obtém o caminho do diretório onde devem ser gerados os arquivos de log. Este caminho é dado a partir do diretório do projeto (não incluído).

Parameters:

commandId - Identificador do comando.

Returns:

O caminho do diretório.

getCommandInfo

public csbase.logic.CommandInfo getCommandInfo(Object projectId,
                                               String commandId)

Specified by:

getCommandInfo in interface csbase.remote.CommandPersistenceServiceInterface

getCommandInfos

public Set<csbase.logic.CommandInfo> getCommandInfos(Object projectId)

Specified by:

getCommandInfos in interface csbase.remote.CommandPersistenceServiceInterface

getStatusCommandInfos

public Set<csbase.logic.CommandInfo> getStatusCommandInfos(Object projectId,
                                                           List<csbase.logic.CommandStatus> statusFilter,
                                                           boolean include)

Specified by:

getStatusCommandInfos in interface csbase.remote.CommandPersistenceServiceInterface

requestCommandInfos

public long requestCommandInfos(Object projectId,
                                long desiredResponseTime)

Specified by:

requestCommandInfos in interface csbase.remote.CommandPersistenceServiceInterface

has2Update

protected boolean has2Update(Object arg,
                             Object event)

Specified by:

has2Update in class csbase.remote.RemoteObjectObservable

initService

public void initService()
                 throws ServerException

Inicialização do serviço

Specified by:

initService in class Service

Throws:

ServerException - Caso ocorra erro na inicialização do serviço.

notifyUsers

public void notifyUsers(Collection<Object> allUsers,
                        csbase.logic.algorithms.commands.CommandPersistenceNotification notification)

Notifica usuários sobre eventos ocorridos com comandos.

Parameters:

allUsers - Usuários a serem notificados além do admin.

notification - Notificação a ser enviada indicando se um comando foi salvo, removido ou atualizado na persistência.

readAlgorithmConfigurator

public csbase.logic.algorithms.AlgorithmConfigurator readAlgorithmConfigurator(Object projectId,
                                                                               String commandId)

Specified by:

readAlgorithmConfigurator in interface csbase.remote.CommandPersistenceServiceInterface

removeCommandInfo

public boolean removeCommandInfo(Object projectId,
                                 String commandId)

Specified by:

removeCommandInfo in interface csbase.remote.CommandPersistenceServiceInterface

removeCommandInfos

public boolean[] removeCommandInfos(List<Object> projectIds,
                                    List<String> commandIds)

Specified by:

removeCommandInfos in interface csbase.remote.CommandPersistenceServiceInterface

saveCommandInfo

public void saveCommandInfo(csbase.logic.CommandInfo command)
                     throws csbase.exception.OperationFailureException

Salva o comando informado. Caso o comando tenha sido salvo com sucesso, gera uma notificação CommandPersistenceNotification do tipo CommandPersistenceNotification.Type.SAVED.

Parameters:

command - O comando a ser salvo.

Throws:

csbase.exception.OperationFailureException - Se houver uma falha ao salvar o comando.

shutdownService

public void shutdownService()

Método invocado no término do serviço.

Specified by:

shutdownService in class Service

updateCommandDescription

public void updateCommandDescription(Object projectId,
                                     String commandId,
                                     String description)

Specified by:

updateCommandDescription in interface csbase.remote.CommandPersistenceServiceInterface

addICommandStatusListener

public void addICommandStatusListener(csbase.server.plugin.service.commandpersistenceservice.ICommandStatusListener listener)

Adiciona um listener para executar alguma ação na mudança de status de um comando. Este método somente deve ser utilizado pelos plugins do csbase.

Parameters:

listener - o listener de mudança de status de um comando

removeAllICommandStatusListener

public void removeAllICommandStatusListener()

Remove todos os listeners que executam alguma ação na mudança de status de um comando. Este método somente de ser utilizado pelos plugins do csbase.

addCommandStatusListener

public void addCommandStatusListener(CommandStatusListener listener)

Adiciona um listener para executar alguma ação na mudança de status de um comando.

Parameters:

listener - o listener de mudança de status de um comando

removeAllCommandStatusListener

public void removeAllCommandStatusListener()

Remove todos os listeners que executam alguma ação na mudança de status de um comando.

updateCommandInfo

public void updateCommandInfo(csbase.logic.CommandInfo command)

Atualiza as informações do comando.

Parameters:

command - comando a ser atualizado.

updateCommandStatus

public void updateCommandStatus(csbase.logic.CommandInfo command)

Atualiza o status do comando.

Parameters:

command - comando cujo status foi atualizado.

getCommandScripts

public String[][] getCommandScripts(String commandId,
                                    Object projectId)
                             throws csbase.exception.OperationFailureException

Obtém o conjunto de scripts de um comando específico.

Parameters:

commandId - Identificador do comando.

projectId - Identificador do projeto.

Returns:

Os caminhos para cada script do comando.

Throws:

csbase.exception.OperationFailureException - se não for possível encontrar o diretório onde se encontram os scripts.

saveCommandScript

public void saveCommandScript(String fileName,
                              String commandId,
                              Object projectId,
                              String commandLine)
                       throws csbase.exception.OperationFailureException

Persiste a linha de comando em um arquivo de script.

Parameters:

fileName - o nome do arquivo de script.

commandId - o identificador do comando.

projectId - o identificador do projeto.

commandLine - a linha de comando.

Throws:

csbase.exception.OperationFailureException - Se a linha de comando não puder ser persistida.

createUniqueCommandDirectory

public void createUniqueCommandDirectory(Object projectId,
                                         String commandId)

O método createUniqueCommandDirectory deve garantir que o identificador do comando seja único. Estamos considerando o caso em que 2 ou mais servidores podem escrever na mesma área de projetos. Por isso, o método verifica a existência do diretório que representa o comando. Caso ele exista, o método lançará uma exceção, indicando que já existe outro comando com este identificador. Caso o diretório não exista, ele é criado e o identificador é considerado único. É importante que a criação do diretório seja uma operação atômica, de modo a evitar possíveis erros de concorrência. Preferimos lançar a exceção ao invés de retornar um boolean, pois não podemos garantir que o diretório não tenha sido criado por causa da existência de um diretório com mesmo nome. Desta forma, a exceção conterá a razão do erro que poderá ser logado no servidor.

Parameters:

projectId - Indentificador do projeto

commandId - Indentificador de um comando

getCommandsDirectoryName

public String getCommandsDirectoryName()

Obtém o nome do diretório de persistência dos arquivos associados às execuções dos comandos (default = .cmds).

Returns:

nome do diretório de persistência dos arquivos associados às execuções dos comandos

getInitializationDependencies

protected Service[] getInitializationDependencies()

Obtém todos os serviços dos quais este serviço depende para a sua inicialização.

Overrides:

getInitializationDependencies in class Service

Returns:

Os serviços dos quais este serviço depende.

appendToFile

public void appendToFile(csbase.logic.CommandInfo cmd,
                         String filename,
                         String chunk)

Insere no final do um arquivo no diretório LOGS_DIRECTORY_NAME.

Parameters:

cmd - commando

filename - o nome do arquivo

chunk - chunk que será inserido ao final do arquivo