csbase.server.services.sgaservice

Class SGAService

java.lang.Object

csbase.remote.RemoteObjectObservable

csbase.server.ServerRemoteObjectObservable

csbase.server.Service

csbase.server.services.sgaservice.SGAService

All Implemented Interfaces:

csbase.remote.RemoteObservable, csbase.remote.RemoteObserverNotifierInterface, csbase.remote.ServiceInterface, csbase.remote.SGAServiceInterface, csbase.server.plugin.service.IService, csbase.server.plugin.service.sgaservice.ISGAService, Remote

public class SGAService
extends Service
implements csbase.remote.SGAServiceInterface, csbase.server.plugin.service.sgaservice.ISGAService

A classe SGAService implementa o serviço de gerência de SGAs.

Author:

Tecgraf/PUC-Rio

See Also:

SGA, SGAServiceInterface

Field Summary

Fields

Modifier and Type	Field and Description
static String	SGA_GROUPS_SUBDIR_NAME Nome do subdiretório (dentro da persistência) que vai armazenar os grupos dos usuários.
static String	SGA_TRANSFER_MECHANISM_KEY Chave da propriedade que define o mecanismo de transferência

Fields inherited from class csbase.remote.RemoteObjectObservable

observerManager

Fields inherited from interface csbase.remote.SGAServiceInterface

SERVICE_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SGAService() Construtor.

Method Summary

Modifier and Type	Method and Description
void	checkExecutionPermission(String sgaName) Verifica se o usuário pode executar comandos neste SGA.
boolean	commandCompleted(String sgaName, sgaidl.SGACommandOperations cmdReference, String cmdId, sgaidl.CompletedCommandInfo cmdInfo) Notificação de término de um comando.
boolean	commandLost(String sgaName, String cmdId) Notificação de comando não recuperado.
boolean	commandRetrieved(String sgaName, sgaidl.RetrievedInfo[] cmds) Registra comandos recuperados em um SGA.
static void	createService() Constrói a instância do serviço de gerência de SGAs
void	executeCommand(csbase.logic.CommandInfo command) Execução remota de um comando para um SGA.
csbase.logic.SGAInfo[]	getAllInfo(String sgaName) Otenção das informações de um SGA.
Vector<csbase.logic.CommandInfo>	getAllSGACommands() Retorna uma Vector (de CommandInfo) com informações de todos os comandos do em execução.
Vector<String>	getAllSGANames() Retorno de todos os sgas cadastrados no SSI (SGA-Service)
List<csbase.logic.ClientSGAFile>	getChildren(String sgaName, String path)
String	getCommandsPersistencyDirectoryName() Retorna o nome do diretório de persistência para comandos.
int	getCommandsUpdateInterval() Retorna o intervalo de atualização das informações dos comandos.
Map<csbase.logic.CommandFinalizationType,Integer>	getExeResultsStats(boolean flowResults)
csbase.logic.ClientSGAFile	getFile(String sgaName, String path)
csbase.logic.SGAInfo	getInfo(String sgaName, int index) Consulta das informações de um nó do SGA.
static SGAService	getInstance() Retorno da instância do serviço.
csbase.logic.ServerGroupInfo[]	getServerGroups() Obtém os grupos de servidores definidos por um usuário.
csbase.logic.CommandInfo	getSGACommand(String sgaName, String cmdId) Retorna as informações de um comando em execução.
Set<csbase.logic.CommandInfo>	getSGACommands(String sgaName)
csbase.logic.SGASet	getSGASet(String sgaName) Obtenção de um SGA.
Map<String,Integer>	getSGAsStats()
int	getUpdateInterval() Retorna o intervalo de atualização das informações dos SGAs
protected boolean	has2Update(Object arg, Object event) Retorna sempre verdadeiro.
void	initService() Inicialização do serviço de gerência de SGAs.
boolean	isRegistered(sgaidl.SGADaemonOperations sgaReference, String sgaName) SGA verifica se o SSI está acessível e se seu registro está válido.
boolean	isSGAAuthorized(String sgaName) Verifica se o SGA está autorizado a registrar-se.
boolean	killCommand(String cmdId) Envio de notificação para cancelar a execução de um comando específico
boolean	killCommand(String sgaName, String cmdId) Envio de notificação para cancelar a execução de um comando específico
void	killCommandAnyway(String sgaName, String cmdId) Finalização de comando pelo administrador (kill).
String[]	mandatorySGANodeProperties()
String[]	mandatorySGAProperties()
boolean	registerSGA(sgaidl.SGADaemonOperations sgaReference, String sgaName, sgaidl.SGAProperties sgaProperties, IntHolder updateInterval) Registro de um SGA.
Collection<String>	restartAllSGAs() Pedido de reinício para todos os SGAs.
boolean	restartSGA(String sgaName) Pedido para reiniciar o SGA especificado.
boolean	setServerGroups(csbase.logic.ServerGroupInfo[] groups) Atualiza os grupos de servidores definidos por um usuário.
Collection<String>	shutdownAllSGAs() Envio de notificação de shutdown para todos os SGAs.
void	shutdownService() Término do serviço de gerência de SGAs.
boolean	shutdownSGA(String sgaName) Envio de notificação de shutdown para um SGA específico.
void	unregisterSGA(sgaidl.SGADaemonOperations sgaReference, String sgaName) Solicitação de de-registro de um SGA.
boolean	updateCommandDescription(String commandId, String description)
boolean	updateSGAInfo(sgaidl.SGADaemonOperations sgaReference, String sgaName, sgaidl.SGAProperties sgaProperties) SGA atualiza seus dados dinâmicos.
void	uploadScripts(Command command) Copia os scripts do comando para o ambiente de execução.

Methods inherited from class csbase.server.Service

getBooleanProperty, getDefaultLocale, getDoubleProperty, getExternalPropertyFile, getFormattedString, getFormattedString, getInitializationDependencies, 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

Methods inherited from interface csbase.remote.RemoteObservable

addObserver, countObservers, deleteObserver, deleteObservers, notifyObservers

Field Detail

SGA_GROUPS_SUBDIR_NAME

public static final String SGA_GROUPS_SUBDIR_NAME

Nome do subdiretório (dentro da persistência) que vai armazenar os grupos dos usuários.

See Also:

Constant Field Values

SGA_TRANSFER_MECHANISM_KEY

public static final String SGA_TRANSFER_MECHANISM_KEY

Chave da propriedade que define o mecanismo de transferência

See Also:

Constant Field Values

Constructor Detail

SGAService

protected SGAService()
              throws ServerException

Construtor.

Throws:

ServerException - se houver erro na instanciação.

Method Detail

getInstance

public static final SGAService getInstance()

Retorno da instância do serviço.

Returns:

o serviço.

getAllSGANames

public final Vector<String> getAllSGANames()

Retorno de todos os sgas cadastrados no SSI (SGA-Service)

Specified by:

getAllSGANames in interface csbase.remote.SGAServiceInterface

Returns:

um vetor ordenado alfabeticamente com os nomes dos servidores

getAllInfo

public final csbase.logic.SGAInfo[] getAllInfo(String sgaName)

Otenção das informações de um SGA.

Specified by:

getAllInfo in interface csbase.remote.SGAServiceInterface

Parameters:

sgaName - o nome do SGA.

Returns:

um vetor com as informações.

getSGACommand

public final csbase.logic.CommandInfo getSGACommand(String sgaName,
                                                    String cmdId)

Retorna as informações de um comando em execução.

Specified by:

getSGACommand in interface csbase.remote.SGAServiceInterface

Parameters:

sgaName - Nome do SGA

cmdId - Identificador do comando.

Returns:

As informações do comando.

getSGACommands

public Set<csbase.logic.CommandInfo> getSGACommands(String sgaName)

Specified by:

getSGACommands in interface csbase.remote.SGAServiceInterface

getAllSGACommands

public final Vector<csbase.logic.CommandInfo> getAllSGACommands()

Retorna uma Vector (de CommandInfo) com informações de todos os comandos do em execução. Se o usuário for um administrador, o método retornará os comandos de todos os usuários sendo executados nos diveros SGAs. Caso contrário, somente os comandos do usuário logado serão retornados.

Specified by:

getAllSGACommands in interface csbase.remote.SGAServiceInterface

Returns:

Vector de comandos sendo executados.

getInfo

public final csbase.logic.SGAInfo getInfo(String sgaName,
                                          int index)

Consulta das informações de um nó do SGA.

Specified by:

getInfo in interface csbase.remote.SGAServiceInterface

Parameters:

sgaName - nome do servidor SGA.

index - índice relativo dentro do servidor SGA.

Returns:

um vetor com as informações.

getChildren

public List<csbase.logic.ClientSGAFile> getChildren(String sgaName,
                                                    String path)

Specified by:

getChildren in interface csbase.remote.SGAServiceInterface

getFile

public csbase.logic.ClientSGAFile getFile(String sgaName,
                                          String path)

Specified by:

getFile in interface csbase.remote.SGAServiceInterface

updateSGAInfo

public final boolean updateSGAInfo(sgaidl.SGADaemonOperations sgaReference,
                                   String sgaName,
                                   sgaidl.SGAProperties sgaProperties)
                            throws sgaidl.InvalidParameterException,
                                   sgaidl.NoPermissionException,
                                   sgaidl.SGANotRegisteredException

SGA atualiza seus dados dinâmicos.

Specified by:

updateSGAInfo in interface csbase.server.plugin.service.sgaservice.ISGAService

Parameters:

sgaReference - referência para o SGA

sgaName - nome da máquina hospedeira do SGA

sgaProperties - informações dinâmicas do SGA

Returns:

true se conseguiu atualizar seus dados ou false caso contrário.

Throws:

sgaidl.InvalidParameterException

sgaidl.NoPermissionException

sgaidl.SGANotRegisteredException

isRegistered

public final boolean isRegistered(sgaidl.SGADaemonOperations sgaReference,
                                  String sgaName)
                           throws sgaidl.InvalidSGAException,
                                  sgaidl.NoPermissionException

SGA verifica se o SSI está acessível e se seu registro está válido.

Specified by:

isRegistered in interface csbase.server.plugin.service.sgaservice.ISGAService

Parameters:

sgaReference - referência para o SGA

sgaName - nome da máquina hospedeira do SGA

Returns:

true se o o registro do SGA estiver válido, false caso contrário. Um retorno "false" é uma indicação de que o SSI esteve fora do ar, o que exige um novo registro do SGA junto ao mesmo.

Throws:

sgaidl.InvalidSGAException

sgaidl.NoPermissionException

getSGASet

public final csbase.logic.SGASet getSGASet(String sgaName)

Obtenção de um SGA.

Specified by:

getSGASet in interface csbase.remote.SGAServiceInterface

Parameters:

sgaName - o nome do SGA.

Returns:

o conjunto representativo do SGA.

setServerGroups

public final boolean setServerGroups(csbase.logic.ServerGroupInfo[] groups)

Atualiza os grupos de servidores definidos por um usuário.

Specified by:

setServerGroups in interface csbase.remote.SGAServiceInterface

Parameters:

groups - array com as informações dos grupos

Returns:

true se a operação foi bem sucedida, false em caso de erro

updateCommandDescription

public boolean updateCommandDescription(String commandId,
                                        String description)

Specified by:

updateCommandDescription in interface csbase.remote.SGAServiceInterface

getServerGroups

public final csbase.logic.ServerGroupInfo[] getServerGroups()

Obtém os grupos de servidores definidos por um usuário.

Specified by:

getServerGroups in interface csbase.remote.SGAServiceInterface

Returns:

um array com as informações dos grupos ou null em caso de erro

getUpdateInterval

public final int getUpdateInterval()

Retorna o intervalo de atualização das informações dos SGAs

Specified by:

getUpdateInterval in interface csbase.remote.SGAServiceInterface

Returns:

intervalo de atualização em segundos

getCommandsUpdateInterval

public final int getCommandsUpdateInterval()

Retorna o intervalo de atualização das informações dos comandos.

Specified by:

getCommandsUpdateInterval in interface csbase.remote.SGAServiceInterface

Returns:

intervalo de atualização em segundos

commandCompleted

public final boolean commandCompleted(String sgaName,
                                      sgaidl.SGACommandOperations cmdReference,
                                      String cmdId,
                                      sgaidl.CompletedCommandInfo cmdInfo)
                               throws sgaidl.InvalidSGAException,
                                      sgaidl.NoPermissionException,
                                      sgaidl.InvalidCommandException

Notificação de término de um comando.

Specified by:

commandCompleted in interface csbase.server.plugin.service.sgaservice.ISGAService

Parameters:

sgaName - nome do SGA.

cmdReference - referência para o comando concluído.

cmdId - identificador do comando no SGA.

cmdInfo - informações sobre o comando.

Returns:

true se notificação aceita, false se o SSI desconhece o SGA

Throws:

sgaidl.InvalidSGAException

sgaidl.InvalidCommandException

sgaidl.NoPermissionException

commandLost

public final boolean commandLost(String sgaName,
                                 String cmdId)
                          throws sgaidl.InvalidSGAException,
                                 sgaidl.InvalidCommandException

Notificação de comando não recuperado.

Specified by:

commandLost in interface csbase.server.plugin.service.sgaservice.ISGAService

Parameters:

sgaName - nome do SGA.

cmdId - identificador do comando no SGA.

Returns:

true se notificação aceita, false se o SSI desconhece o SGA

Throws:

sgaidl.InvalidSGAException

sgaidl.InvalidCommandException

executeCommand

public final void executeCommand(csbase.logic.CommandInfo command)
                          throws csbase.exception.PermissionException,
                                 SGANotAvailableException,
                                 ProjectNotFoundException

Execução remota de um comando para um SGA.

Parameters:

command - informações sobre o comando a ser executado.

Throws:

csbase.exception.PermissionException - Se o usuário não tiver permissão para executar o comando.

SGANotAvailableException - Em caso de falha na submissão do comando devido ao SGA selecionado não estar disponível.

ProjectNotFoundException - Em caso de falha na submissão do comando devido ao projeto não estar disponível.

initService

public final void initService()
                       throws ServerException

Inicialização do serviço de gerência de SGAs.

Specified by:

initService in class Service

Throws:

ServerException - se ocorrer um erro na inicialização

isSGAAuthorized

public boolean isSGAAuthorized(String sgaName)

Verifica se o SGA está autorizado a registrar-se.

Parameters:

sgaName - o nome do SGA

Returns:

true se está autorizado e false caso contrário

killCommand

public boolean killCommand(String cmdId)

Envio de notificação para cancelar a execução de um comando específico

Specified by:

killCommand in interface csbase.remote.SGAServiceInterface

Parameters:

cmdId - identificador do comando.

Returns:

true se conseguiu cancelar o comando ou false se houver falha na comunicação.

killCommand

public boolean killCommand(String sgaName,
                           String cmdId)

Envio de notificação para cancelar a execução de um comando específico

Specified by:

killCommand in interface csbase.remote.SGAServiceInterface

Parameters:

sgaName - nome do SGA.

cmdId - identificador do comando.

Returns:

true se conseguiu cancelar o comando ou false se houver falha na comunicação.

killCommandAnyway

public void killCommandAnyway(String sgaName,
                              String cmdId)
                       throws csbase.exception.PermissionException

Finalização de comando pelo administrador (kill). Remove o objeto do comando mesmo que tenha ocorrido erro. Deve ser usado no caso em que não há mais possibilidade do comando estar executando. Por exemplo, ocorreu problema de hardware na máquina.

Specified by:

killCommandAnyway in interface csbase.remote.SGAServiceInterface

Parameters:

sgaName - nome do SGA.

cmdId - identificador do comando.

Throws:

csbase.exception.PermissionException - se o usuário não for administrador.

registerSGA

public boolean registerSGA(sgaidl.SGADaemonOperations sgaReference,
                           String sgaName,
                           sgaidl.SGAProperties sgaProperties,
                           IntHolder updateInterval)
                    throws sgaidl.InvalidParameterException,
                           sgaidl.NoPermissionException,
                           sgaidl.SGAAlreadyRegisteredException

Registro de um SGA.

Specified by:

registerSGA in interface csbase.server.plugin.service.sgaservice.ISGAService

Parameters:

sgaReference - referência para o sga

sgaName - nome do SGA

sgaProperties - propriedades do SGA

updateInterval - informa de quanto em quanto tempo o SGA deve dizer que está vivo.

Returns:

true se o o registro do SGA for aceito, false caso o registro não possa ser aceito

Throws:

sgaidl.NoPermissionException - Se o SGA não estiver autorizado a se registrar

sgaidl.InvalidParameterException

sgaidl.SGAAlreadyRegisteredException

shutdownAllSGAs

public Collection<String> shutdownAllSGAs()
                                   throws csbase.exception.PermissionException

Envio de notificação de shutdown para todos os SGAs.

Specified by:

shutdownAllSGAs in interface csbase.remote.SGAServiceInterface

Returns:

coleção de SGAs que não puderam ser desativados. Se tudo correr bem, a lista estará vazia.

Throws:

csbase.exception.PermissionException - se o usuário não tiver permissão para desativar os SGAs.

restartAllSGAs

public Collection<String> restartAllSGAs()
                                  throws csbase.exception.PermissionException

Pedido de reinício para todos os SGAs.

Specified by:

restartAllSGAs in interface csbase.remote.SGAServiceInterface

Returns:

coleção de SGAs que não puderam ser reiniciados. Se tudo correr bem, a lista estará vazia.

Throws:

csbase.exception.PermissionException - se o usuário não tiver permissão para reiniciar os SGAs.

shutdownSGA

public boolean shutdownSGA(String sgaName)
                    throws csbase.exception.PermissionException

Envio de notificação de shutdown para um SGA específico.

Specified by:

shutdownSGA in interface csbase.remote.SGAServiceInterface

Parameters:

sgaName - nome do SGA.

Returns:

true se o SGA tiver sido desativado com sucesso.

Throws:

csbase.exception.PermissionException - se o usuário não tiver permissão para desativar o SGA.

restartSGA

public boolean restartSGA(String sgaName)
                   throws csbase.exception.PermissionException

Pedido para reiniciar o SGA especificado.

Specified by:

restartSGA in interface csbase.remote.SGAServiceInterface

Parameters:

sgaName - nome do SGA a ser reiniciado.

Returns:

true se o SGA for reiniciado com sucesso.

Throws:

csbase.exception.PermissionException - se o usuário não tiver permissão para reiniciar este SGA.

commandRetrieved

public boolean commandRetrieved(String sgaName,
                                sgaidl.RetrievedInfo[] cmds)
                         throws sgaidl.InvalidSGAException,
                                sgaidl.NoPermissionException,
                                sgaidl.InvalidCommandException

Registra comandos recuperados em um SGA. Os demais comandos em execução no SGA (não-recuperados) são marcados como perdidos.

Specified by:

commandRetrieved in interface csbase.server.plugin.service.sgaservice.ISGAService

Parameters:

sgaName - nome que identifica o sga.

cmds - informações sobre os comandos recuperados

Returns:

true se existe um SGA com o nome especificado, false caso contrário

Throws:

sgaidl.InvalidSGAException

sgaidl.NoPermissionException

sgaidl.InvalidCommandException

shutdownService

public void shutdownService()
                     throws ServerException

Término do serviço de gerência de SGAs. Destrói o servant que implementa a interface de comunicação com os SGAs, e desativa o servidor CORBA correspondente.

Specified by:

shutdownService in class Service

Throws:

ServerException - caso não consiga desativar o servant.

unregisterSGA

public void unregisterSGA(sgaidl.SGADaemonOperations sgaReference,
                          String sgaName)
                   throws sgaidl.NoPermissionException,
                          sgaidl.SGANotRegisteredException

Solicitação de de-registro de um SGA.

Specified by:

unregisterSGA in interface csbase.server.plugin.service.sgaservice.ISGAService

Parameters:

sgaReference - referência para o sga

sgaName - nome do SGA

Throws:

sgaidl.NoPermissionException

sgaidl.SGANotRegisteredException

checkExecutionPermission

public void checkExecutionPermission(String sgaName)
                              throws csbase.exception.PermissionException

Verifica se o usuário pode executar comandos neste SGA.

Parameters:

sgaName - nome do SGA.

Throws:

csbase.exception.PermissionException - se houver falha de permissão para acesso.

has2Update

protected boolean has2Update(Object arg,
                             Object event)

Retorna sempre verdadeiro.

Specified by:

has2Update in class csbase.remote.RemoteObjectObservable

See Also:

RemoteObjectObservable.has2Update(Object,Object)

uploadScripts

public void uploadScripts(Command command)
                   throws csbase.exception.OperationFailureException,
                          ServerException

Copia os scripts do comando para o ambiente de execução.

Parameters:

command - O comando

Throws:

csbase.exception.OperationFailureException - Se não for possível obter os scripts do comando.

ServerException - Se houver algum problema no upload dos arquivos via CSFS.

getCommandsPersistencyDirectoryName

public String getCommandsPersistencyDirectoryName()
                                           throws csbase.exception.OperationFailureException

Retorna o nome do diretório de persistência para comandos.

Returns:

nome do diretório de persistência para comandos.

Throws:

csbase.exception.OperationFailureException - em caso de erro na validação do diretório no sistema de arquivos.

createService

public static void createService()
                          throws ServerException

Constrói a instância do serviço de gerência de SGAs

Throws:

ServerException - se houver erro na instanciação.

getExeResultsStats

public Map<csbase.logic.CommandFinalizationType,Integer> getExeResultsStats(boolean flowResults)
                                                                     throws RemoteException

Specified by:

getExeResultsStats in interface csbase.remote.SGAServiceInterface

Throws:

RemoteException

getSGAsStats

public Map<String,Integer> getSGAsStats()
                                 throws RemoteException

Specified by:

getSGAsStats in interface csbase.remote.SGAServiceInterface

Throws:

RemoteException

mandatorySGAProperties

public String[] mandatorySGAProperties()

Specified by:

mandatorySGAProperties in interface csbase.server.plugin.service.sgaservice.ISGAService

mandatorySGANodeProperties

public String[] mandatorySGANodeProperties()

Specified by:

mandatorySGANodeProperties in interface csbase.server.plugin.service.sgaservice.ISGAService