csbase.console

Class AbstractConsoleApp

java.lang.Object

csbase.console.AbstractConsoleApp

Direct Known Subclasses:

Admin, CheckBundlesApp, Diagnostics, ImportAlgoPack, ImportAlgoVersion, Statistics

public abstract class AbstractConsoleApp
extends Object

Superclasse para os clientes console.

Author:

Tecgraf

Field Summary

Fields

Modifier and Type	Field and Description
protected ClientRemoteMonitor	clientMonitor Monitor da conexão com o servidor.
protected static String	IDENT Identação para a saída.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractConsoleApp(String[] args) Construtor.
protected	AbstractConsoleApp(String _serverURI, int _port, String _password) Construtor.

Method Summary

Modifier and Type	Method and Description
protected String	ask(String prompt, Object... params) Exibe um prompt e aguarda entrada do usuário.
protected boolean	confirm(String prompt, Object... params) Exibe um prompt para obter uma confirmação.
protected void	createClientMonitor() Cria o monitor da comunicação com o servidor.
protected abstract BasicParams	createParams() Cria o objeto que será usado para processar a linha de comando.
protected Console	getConsole() Obtém um console para interação com o usuário.
protected String	getCurrentDir() Retorna o diretório corrente.
csbase.logic.diagnosticservice.DeploymentInfo	getDeploymentInfo() Obtém informações sobre o ambiente de instalação do servidor.
abstract String	getLogin() Obtém o login do usuário.
protected BasicParams	getParams() Obtém os parâmetros já processados.
String	getPassword() Obtém a senha fornecida pelo usuário.
int	getPort() Obtém a porta para comunicação com o servidor.
Map<String,String>	getRuntimeProperties() Obtém um mapa com as propriedades runtime do servidor.
String	getServerURI() Obtém a URI do servidor.
String	getSystemVersion() Retorna o identificador da versão do sistema.
protected boolean	isAdmin(boolean verbose) Verifica se o usuário é o administrador.
protected boolean	login() Autentica o usuário no servidor.
protected void	logout() Encerra a conexão com o servidor.
protected void	postLoginInit() Inicializações feitas após um login bem-sucedido.
protected boolean	preLogout() Ações realizadas imediatamente antes do logout.
protected void	print(String msg) Exibe uma mensagem, sem terminador de linha.
protected void	printError(String msg, Object... params) Exibe uma mensagem de erro.
protected void	printf(String format, Object... args) Exibe uma mensagem formatada.
protected void	printInfo(String msg, Object... params) Exibe uma mensagem de informação.
protected void	println() Exibe uma linha em branco.
protected void	println(String msg, Object... params) Exibe uma mensagem.
protected void	printStackTrace(Exception e) Exibe o stacktrace de uma exceção.
protected void	printWarning(String msg, Object... params) Exibe uma mensagem de alerta.
protected void	processBasicParams() Processa os parâmetros básicos (URI, porta, senha).
protected void	processExtraParams() Processa os parâmetros adicionais.
protected String	readLine(String format, Object... args) Lê uma linha interativamente.
protected String	readPassword() Obtém a senha interativamente.
protected AbstractConsoleApp	setPassword(String password) Define a senha.
AbstractConsoleApp	setPort(int port) Define a porta para comunicação com o servidor.
AbstractConsoleApp	setServerURI(String serverURI) Define a URI do sistema.
protected void	showBasicInfo() Exibe informações básicas sobre o sistema (versão, nome, hora de início).
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

IDENT

protected static final String IDENT

Identação para a saída.

See Also:

Constant Field Values

clientMonitor

protected ClientRemoteMonitor clientMonitor

Monitor da conexão com o servidor.

Constructor Detail

AbstractConsoleApp

protected AbstractConsoleApp(String _serverURI,
                             int _port,
                             String _password)

Construtor.

Parameters:

_serverURI - URI do servidor

_port - porta do servidor (-1 para obter da linha de comando)

_password - senha

AbstractConsoleApp

protected AbstractConsoleApp(String[] args)

Construtor.

Parameters:

args - parâmetros recebidos pela linha de comando

Method Detail

processBasicParams

protected void processBasicParams()

Processa os parâmetros básicos (URI, porta, senha).

readPassword

protected String readPassword()

Obtém a senha interativamente.

Returns:

senha digitada pelo usuário

ask

protected String ask(String prompt,
                     Object... params)

Exibe um prompt e aguarda entrada do usuário.

Parameters:

prompt - prompt

params - parâmetros para o prompt

Returns:

entrada do usuário, sem espaços antes ou depois

confirm

protected boolean confirm(String prompt,
                          Object... params)

Exibe um prompt para obter uma confirmação. Acrescenta "[s\n]?" ao prompt.

Parameters:

prompt - prompt

params - parâmetros para o prompt

Returns:

true apenas se o usuário confirmou a operação (i.e. digitou "s" ou "S")

getConsole

protected Console getConsole()

Obtém um console para interação com o usuário. Lança AssertionError se o console não for interativo.

Returns:

console

createParams

protected abstract BasicParams createParams()

Cria o objeto que será usado para processar a linha de comando.

Returns:

objeto que será usado para processar a linha de comando

processExtraParams

protected void processExtraParams()

Processa os parâmetros adicionais.

createClientMonitor

protected void createClientMonitor()

Cria o monitor da comunicação com o servidor.

login

protected boolean login()
                 throws RemoteException

Autentica o usuário no servidor.

Returns:

true se a autenticação foi bem-sucedida.

Throws:

RemoteException - erro na comunicação RMI

postLoginInit

protected void postLoginInit()
                      throws RemoteException

Inicializações feitas após um login bem-sucedido.

Throws:

RemoteException - erro na comunicação RMI

logout

protected void logout()

Encerra a conexão com o servidor.

preLogout

protected boolean preLogout()

Ações realizadas imediatamente antes do logout. Indica se o logout pode ser efetuado.

Returns:

true se o logout deve ser efetuado

toString

public String toString()

Overrides:

toString in class Object

isAdmin

protected final boolean isAdmin(boolean verbose)

Verifica se o usuário é o administrador.

Parameters:

verbose - se igual a true, exibe mensagem de erro se o usuário não é o admin

Returns:

true se o usuário é o administrador

getParams

protected BasicParams getParams()

Obtém os parâmetros já processados.

Returns:

parâmetros já processados

getRuntimeProperties

public Map<String,String> getRuntimeProperties()
                                        throws RemoteException

Obtém um mapa com as propriedades runtime do servidor.

Returns:

mapa com as propriedades runtime do servidor

Throws:

RemoteException - erro na comunicação RMI

getSystemVersion

public String getSystemVersion()
                        throws RemoteException

Retorna o identificador da versão do sistema.

Returns:

identificador da versão do sistema

Throws:

RemoteException - erro na comunicação RMI

getDeploymentInfo

public csbase.logic.diagnosticservice.DeploymentInfo getDeploymentInfo()
                                                                throws RemoteException

Obtém informações sobre o ambiente de instalação do servidor.

Returns:

informações sobre o ambiente de instalação do servidor

Throws:

RemoteException - erro na comunicação RMI

setServerURI

public AbstractConsoleApp setServerURI(String serverURI)

Define a URI do sistema.

Parameters:

serverURI - URI

Returns:

o próprio objeto, para encadeamento

getServerURI

public String getServerURI()

Obtém a URI do servidor.

Returns:

URI do servidor

setPort

public AbstractConsoleApp setPort(int port)

Define a porta para comunicação com o servidor.

Parameters:

port - porta

Returns:

o próprio objeto, para encadeamento

getPort

public int getPort()

Obtém a porta para comunicação com o servidor.

Returns:

porta para comunicação com o servidor

getLogin

public abstract String getLogin()

Obtém o login do usuário.

Returns:

login do usuário

setPassword

protected AbstractConsoleApp setPassword(String password)

Define a senha.

Parameters:

password - senha

Returns:

o próprio objeto, para encadeamento

getPassword

public String getPassword()

Obtém a senha fornecida pelo usuário.

Returns:

senha fornecida pelo usuário

printError

protected final void printError(String msg,
                                Object... params)

Exibe uma mensagem de erro. Erros sempre são exibidos (também) em System.err, mesmo que a saída tenha sido redirecionada.

Parameters:

msg - mensagem

params - parâmetros para a mensagem

printInfo

protected final void printInfo(String msg,
                               Object... params)

Exibe uma mensagem de informação.

Parameters:

msg - mensagem

params - parâmetros para a mensagem

printWarning

protected final void printWarning(String msg,
                                  Object... params)

Exibe uma mensagem de alerta.

Parameters:

msg - mensagem

params - parâmetros para a mensagem

println

protected final void println()

Exibe uma linha em branco.

println

protected final void println(String msg,
                             Object... params)

Exibe uma mensagem. Se não foi fornecido nenhum parâmetro, exibe a mensagem como uma string "simples", sem interpretar parâmetros de formatação ('%s', '%d' etc. são exibidos literalmente).

Parameters:

msg - a mensagem

params - parâmetros para a mensagem

printf

protected final void printf(String format,
                            Object... args)

Exibe uma mensagem formatada. Não acrescenta o terminador automaticamente.

Parameters:

format - formato da mensagem

args - parâmetros para a mensagem

See Also:

PrintStream.printf(String, Object...)

print

protected void print(String msg)

Exibe uma mensagem, sem terminador de linha.

Parameters:

msg - a mensagem

readLine

protected String readLine(String format,
                          Object... args)

Lê uma linha interativamente.

Parameters:

format - formato da mensagem

args - parâmetros para a mensagem

Returns:

linha fornecida pelo usuário

See Also:

PrintStream.printf(String, Object...)

printStackTrace

protected void printStackTrace(Exception e)

Exibe o stacktrace de uma exceção. O stacktrace sempre é exibido (também) em System.err , mesmo que a saída tenha sido redirecionada.

Parameters:

e - exceção

showBasicInfo

protected void showBasicInfo()
                      throws RemoteException

Exibe informações básicas sobre o sistema (versão, nome, hora de início).

Throws:

RemoteException - erro na comunicação RMI

getCurrentDir

protected String getCurrentDir()

Retorna o diretório corrente.

Returns:

diretório corrente