csbase.remote

Interface SGAServiceInterface

All Superinterfaces:

Remote, RemoteObservable, ServiceInterface

public interface SGAServiceInterface
extends ServiceInterface, RemoteObservable

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

Author:

Ane Lúcia de Moura, André Clinio e Cristina Ururahy

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and Description
SGAInfo[]	getAllInfo(String sgaName) Obtém as informações de todos os nós de um SGA.
Vector<CommandInfo>	getAllSGACommands() Retorna um Vector com informações da monitoração de todos os comandos em execução nos diversos SGAs.
Vector<String>	getAllSGANames() Retorno de todos os nomes de servidores cadastrados no SSI (SGA-Service)
List<ClientSGAFile>	getChildren(String sgaName, String path) Retorna lista com os arquivos filhos dado um SGA e um path.
int	getCommandsUpdateInterval() Retorna o intervalo de atualização das informações dos comandos.
Map<CommandFinalizationType,Integer>	getExeResultsStats(boolean flowResults) Obtém um mapa com as estatísticas de tipos de término de execução.
ClientSGAFile	getFile(String sgaName, String path) Retorna ClientSGAFile equivalente ao dado path.
SGAInfo	getInfo(String sgaName, int index) Obtém as informações de um determinado nó de um SGA.
ServerGroupInfo[]	getServerGroups() Obtém os grupos de servidores definidos por um usuário.
CommandInfo	getSGACommand(String sgaName, String cmdId) Retorna as informações da monitoração de um comando em execução.
Set<CommandInfo>	getSGACommands(String sgaName) Retorna um conjunto com informações da monitoração de todos os comandos em execução em um SGA.
SGASet	getSGASet(String sgaName) Obtém um SGA.
Map<String,Integer>	getSGAsStats() Obtém um mapa com as estatísticas de execuções por máquina (nós SGA).
int	getUpdateInterval() Retorna o intervalo de atualização das informações dos SGAs
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).
Collection<String>	restartAllSGAs() Solicita o relançamento de todos os SGAs.
boolean	restartSGA(String sgaName) Solicita o relançamento de um SGA específico
boolean	setServerGroups(ServerGroupInfo[] groups) Atualiza os grupos de servidores definidos por um usuário.
Collection<String>	shutdownAllSGAs() Solicita o shutdown de todos os SGAs.
boolean	shutdownSGA(String sgaName) Solicita o shutdown de um SGA específico.
boolean	updateCommandDescription(String commandId, String description) Atualiza a descrição do comando.

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

getAllSGANames

Vector<String> getAllSGANames()
                              throws RemoteException

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

Returns:

um vetor de strings com os nomes dos servidores.

Throws:

RemoteException - se houver falha na chamada remota ao servidor.

getSGASet

SGASet getSGASet(String sgaName)
                 throws RemoteException

Obtém um SGA.

Parameters:

sgaName - nome do SGA

Returns:

as informações do SGA.

Throws:

RemoteException - se houver falha na chamada remota ao servidor.

getAllInfo

SGAInfo[] getAllInfo(String sgaName)
                     throws RemoteException

Obtém as informações de todos os nós de um SGA.

Parameters:

sgaName - nome do SGA

Returns:

array contendo as informações dos nós do SGA.

Throws:

RemoteException - se houver falha na chamada remota ao servidor.

getInfo

SGAInfo getInfo(String sgaName,
              int index)
                throws RemoteException

Obtém as informações de um determinado nó de um SGA.

Parameters:

sgaName - nome do SGA

index - índice do nó

Returns:

as informações do nó especificado

Throws:

RemoteException - se houver falha na chamada remota ao servidor.

getChildren

List<ClientSGAFile> getChildren(String sgaName,
                              String path)
                                throws RemoteException

Retorna lista com os arquivos filhos dado um SGA e um path.

Parameters:

sgaName - nome do SGA.

path - path pai.

Returns:

lista com arquivos filhos.

Throws:

RemoteException - se houver falha na chamada remota ao servidor.

getFile

ClientSGAFile getFile(String sgaName,
                    String path)
                      throws RemoteException

Retorna ClientSGAFile equivalente ao dado path.

Parameters:

sgaName - nome do SGA.

path - path do arquivo ou diretório.

Returns:

ClientSGAFile equivalente ao dado path.

Throws:

RemoteException - se houver falha na chamada remota ao servidor.

getUpdateInterval

int getUpdateInterval()
                      throws RemoteException

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

Returns:

intervalo de atualização em segundos

Throws:

RemoteException - se houver falha na chamada remota ao servidor.

getCommandsUpdateInterval

int getCommandsUpdateInterval()
                              throws RemoteException

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

Returns:

intervalo de atualização em segundos

Throws:

RemoteException - se houver falha na chamada remota ao servidor.

getServerGroups

ServerGroupInfo[] getServerGroups()
                                  throws RemoteException

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

Returns:

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

Throws:

RemoteException - se houver falha na chamada remota ao servidor.

setServerGroups

boolean setServerGroups(ServerGroupInfo[] groups)
                        throws RemoteException

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

Parameters:

groups - array com as informações dos grupos

Returns:

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

Throws:

RemoteException - se houver falha na chamada remota ao servidor.

updateCommandDescription

boolean updateCommandDescription(String commandId,
                               String description)
                                 throws RemoteException

Atualiza a descrição do comando.

Parameters:

commandId - identificador do comando a ser atualizado.

description - nova descrição do comando.

Returns:

true se o comando foi atualizado com sucesso

Throws:

RemoteException - se houver falha na chamada remota ao servidor.

shutdownSGA

boolean shutdownSGA(String sgaName)
                    throws RemoteException

Solicita o shutdown de um SGA específico.

Parameters:

sgaName - o nome do SGA.

Returns:

true se o SGA tiver sido desativado com sucesso.

Throws:

RemoteException - se houver falha na chamada remota ao servidor.

restartSGA

boolean restartSGA(String sgaName)
                   throws RemoteException

Solicita o relançamento de um SGA específico

Parameters:

sgaName - o nome do SGA.

Returns:

true se o SGA for reiniciado com sucesso.

Throws:

RemoteException - se houver falha na chamada remota ao servidor.

shutdownAllSGAs

Collection<String> shutdownAllSGAs()
                                   throws RemoteException

Solicita o shutdown de todos os SGAs.

Returns:

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

Throws:

RemoteException - se houver falha na chamada remota ao servidor.

restartAllSGAs

Collection<String> restartAllSGAs()
                                  throws RemoteException

Solicita o relançamento de todos os SGAs.

Returns:

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

Throws:

RemoteException - se houver falha na chamada remota ao servidor.

getSGACommand

CommandInfo getSGACommand(String sgaName,
                        String cmdId)
                          throws RemoteException

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

Parameters:

sgaName - O nome do sga.

cmdId - O identificador do comando.

Returns:

.

Throws:

RemoteException - se houver falha na chamada remota ao servidor.

getAllSGACommands

Vector<CommandInfo> getAllSGACommands()
                                      throws RemoteException

Retorna um Vector com informações da monitoração de todos os comandos em execução nos diversos SGAs.

Returns:

.

Throws:

RemoteException - se houver falha na chamada remota ao servidor.

getSGACommands

Set<CommandInfo> getSGACommands(String sgaName)
                                throws RemoteException

Retorna um conjunto com informações da monitoração de todos os comandos em execução em um SGA.

Parameters:

sgaName - O nome do SGA.

Returns:

O conjunto de CommandInfo ou null caso não seja possível acessar o SGA.

Throws:

RemoteException - se houver falha na chamada remota ao servidor.

killCommand

boolean killCommand(String cmdId)
                    throws RemoteException

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

Parameters:

cmdId - identificador do comando

Returns:

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

Throws:

RemoteException - se houver falha na chamada remota ao servidor.

killCommand

boolean killCommand(String sgaName,
                  String cmdId)
                    throws RemoteException

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

Parameters:

sgaName - nome do SGA

cmdId - identificador do comando

Returns:

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

Throws:

RemoteException - se houver falha na chamada remota ao servidor.

killCommandAnyway

void killCommandAnyway(String sgaName,
                     String cmdId)
                       throws RemoteException

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.

Parameters:

sgaName - nome do SGA.

cmdId - identificador do comando.

Throws:

RemoteException - se houver falha na chamada remota ao servidor.

getExeResultsStats

Map<CommandFinalizationType,Integer> getExeResultsStats(boolean flowResults)
                                                        throws RemoteException

Obtém um mapa com as estatísticas de tipos de término de execução.

Parameters:

flowResults - true para obter estatísticas de fluxos, false para obter das execuções simples

Returns:

mapa (não-modificável) com as estatísticas de tipos de término de execução

Throws:

RemoteException

getSGAsStats

Map<String,Integer> getSGAsStats()
                                 throws RemoteException

Obtém um mapa com as estatísticas de execuções por máquina (nós SGA).

Returns:

mapa (não-modificável) com as estatísticas de execuções por máquina

Throws:

RemoteException