csbase.server

Class Server

java.lang.Object

csbase.server.Server

public abstract class Server
extends java.lang.Object

Classe que representa um servidor genérico.

Author:

Tecgraf/PUC-Rio

Field Summary

Fields

Modifier and Type	Field and Description
protected java.rmi.registry.Registry	registry Interface remota do servidor.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Server(java.lang.String[] args) Ponto de entrada da aplicação que inicia o servidor do sistema.

Method Summary

Methods

Modifier and Type	Method and Description
static void	checkDirectory(java.lang.String dirPath) Método para checagem e criação de diretórios (se necessário).
protected csbase.remote.ServerEntryPoint	createServerEntryPoint() Cria a porta de entrada para acesso as funcionalidade do servidor, o ServerEntryPointImpl.
abstract void	createServices() Método responsável para criação dos serviços.
static java.lang.String	generateDirectoryFileName(java.lang.String pattern) Baseado em java.util.logging.FileHandler.generate.
java.lang.String	getAdminPassword() Retorna a senha do administrador.
protected boolean	getBooleanProperty(java.lang.String key) Recupera uma propriedade da aplicação (boolean)
java.lang.String	getCentralServerName() Obtém o nome do servidor central.
java.util.Locale	getDefaultLocale() Retorna o Locale default configurado na instalação do servidor CSBase.
protected double	getDoubleProperty(java.lang.String key) Recupera uma propriedade da aplicação (double)
csbase.remote.ServerEntryPoint	getEntryPoint() Obtém o ponto de entrada do servidor.
java.lang.String	getFormattedString(java.lang.String key, java.lang.Object... objects) Traduz uma determinada chave na sua string formatada inferindo o locale do usuário (thread) que originou a chamada (será usado um locale padrão se houver falha nesta identificação).
protected java.lang.String	getGreetingMessage() Retorna a mensagem de "boas-vindas" do sistema (exibida quando a inicialização foi bem-sucedida).
java.lang.String	getHostAddr() Retorna o endereço IP do servidor, definido pela propriedade .
java.lang.String	getHostName() Retorna o nome do servidor, definido pela propriedade .
static Server	getInstance() Retorna a instância do servidor.
int	getIntProperty(java.lang.String key) Recupera uma propriedade da aplicação (int)
long	getLongProperty(java.lang.String key) Recupera uma propriedade da aplicação (long)
csbase.util.messages.MessageBroker	getMessageBroker() Obtém o broker de mensagens.
java.lang.String	getPersistencyRootDirectoryName() Método de consulta ao nome do diretório-raiz de dados persistidos.
java.lang.String	getPrivateKeyPassword() Obtém a senha da chave privada do servidor.
java.util.Map<java.lang.String,csbase.logic.diagnosticservice.PropertyInfo>	getPropertiesInfo()
static java.lang.String	getPropertiesRootDirectoryName() Método de consulta ao nome do diretório-raiz de propriedades.
int	getRegistryPort() Retorna a porta na qual o registry RMI devem ser encontrado.
int	getRMIExportPort() Retorna a porta na qual os objetos RMI devem ser exportados.
java.lang.String	getRunningDirectoryName() Método de consulta ao nome do diretório de execução do servidor.
java.util.Map<java.lang.String,java.lang.String>	getRuntimeProperties() Obtém um mapa com as propriedades runtime do servidor.
protected java.lang.String	getServerConfig() Obtém as informações de configuração do servidor.
java.nio.charset.Charset	getServerHostCharset() Retorna o charset default da máquina do servidor:
java.lang.String	getServerHostCharsetName() Retorna o nome charset da máquina do servidor: serverHostCharset.
java.lang.String[]	getServerLibs() Obtém as bibliotecas utilizadas pelo servidor
long	getStartupTime() Obtém o timestamp da inicialização do servidor.
java.lang.String	getString(java.lang.String key) Traduz uma determinada chave na sua string correspondente com o locale padrão.
java.lang.String	getString(java.lang.String key, java.util.Locale locale) Traduz uma determinada chave na sua string correspondente de acordo com o locale desejado.
protected java.util.List<java.lang.String>	getStringListProperty(java.lang.String key) Recupera uma propriedade da aplicação (lista)
protected java.lang.String	getStringProperty(java.lang.String key) Recupera uma propriedade da aplicação (string)
java.nio.charset.Charset	getSystemDefaultCharset() Retorna o charset default do sistema conforme definido pela propriedade indicadas por: PROP_DEFAULT_CHARSET.
java.lang.String	getSystemDefaultCharsetName() Retorna o nome charset default do sistema: systemDefaultCharset.
java.lang.String	getSystemName() Nome do sistema.
java.lang.String	getSystemURL() Pega a URL para execução do cliente applet do sistema.
java.lang.String	getVersion() Obtém a versão do servidor.
boolean	isCentralServer() Verifica se o servidor é servidor central.
protected boolean	isPropertyNull(java.lang.String key) Verifica a nulidade de uma propriedade
java.lang.String	listRuntimeProperties() Obtém todas as propriedades runtime como uma string.
static void	logFineMessage(java.lang.String msg) Gera uma mensagem de log de nível FINE.
static void	logInfoMessage(java.lang.String msg) Gera uma mensagem de log de nível INFO.
static void	logSevereMessage(java.lang.String msg) Gera uma mensagem de log de nível SEVERE.
static void	logSevereMessage(java.lang.String msg, java.lang.Throwable t) Gera uma mensagem de log de nível SEVERE.
static void	logWarningMessage(java.lang.String msg) Gera uma mensagem de log de nível WARNING.
protected boolean	overridesServiceProperty(java.lang.String prefixedKey) Indica se o servidor faz override da propriedade de um serviço
abstract void	postInitialization() Método chamado após a inicialização dos serviços.
void	shutdown() Finaliza o ambiente de execução no servidor.
boolean	start() Inicia o servidor, inicializando todos os serviços locais.
abstract void	startCentralServerMonitor() Inicia a classe que será usada pelo servidor local para monitorar o estado da conexão com um servidor central.

Methods inherited from class java.lang.Object

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

Field Detail

registry

protected java.rmi.registry.Registry registry

Interface remota do servidor.

Constructor Detail

Server

protected Server(java.lang.String[] args)
          throws ServerException

Ponto de entrada da aplicação que inicia o servidor do sistema. Instala um SecurityManager e configura o provedor de objetos para atender ao servidor.

Parameters:

args - argumentos da linha de comando do servidor.

Throws:

ServerException - em caso de falha.

Method Detail

checkDirectory

public static void checkDirectory(java.lang.String dirPath)
                           throws ServerException

Método para checagem e criação de diretórios (se necessário).

Parameters:

dirPath - o caminho relativo para verificação.

Throws:

ServerException - 1) se o caminho existir e não representar um diretório; ou 2) se o caminho não existir e não for possível criar um novo diretório no mesmo.

createServerEntryPoint

protected csbase.remote.ServerEntryPoint createServerEntryPoint()

Cria a porta de entrada para acesso as funcionalidade do servidor, o ServerEntryPointImpl.

Returns:

o ServerEntryPointImpl que é a porta de entrada para acesso as funcionalidade do servido

createServices

public abstract void createServices()
                             throws ServerException

Método responsável para criação dos serviços. A partir deste método, deve ser chamado o método createService de cada serviço.

Throws:

ServerException - caso ocorra falha na criação do serviço.

getAdminPassword

public java.lang.String getAdminPassword()

Retorna a senha do administrador.

Returns:

string a senha.

getCentralServerName

public java.lang.String getCentralServerName()

Obtém o nome do servidor central.

Returns:

o nome do servidor central

getDefaultLocale

public java.util.Locale getDefaultLocale()

Retorna o Locale default configurado na instalação do servidor CSBase.

Returns:

O Locale ou null caso não haja um configurado.

getEntryPoint

public final csbase.remote.ServerEntryPoint getEntryPoint()

Obtém o ponto de entrada do servidor.

Returns:

o ponto de entrada.

getGreetingMessage

protected java.lang.String getGreetingMessage()

Retorna a mensagem de "boas-vindas" do sistema (exibida quando a inicialização foi bem-sucedida). Pode ser redefinido por subclasses que precisem ou queiram exibir outras informações.

Returns:

mensagem de boas-vindas do sistema

getHostName

public java.lang.String getHostName()

Retorna o nome do servidor, definido pela propriedade .

Returns:

nome do servidor

See Also:

getHostAddr()

getHostAddr

public java.lang.String getHostAddr()

Retorna o endereço IP do servidor, definido pela propriedade .

Returns:

endereço IP do servidor

See Also:

getHostName()

getSystemDefaultCharset

public final java.nio.charset.Charset getSystemDefaultCharset()

Retorna o charset default do sistema conforme definido pela propriedade indicadas por: PROP_DEFAULT_CHARSET.

Returns:

o charset

getSystemDefaultCharsetName

public final java.lang.String getSystemDefaultCharsetName()

Retorna o nome charset default do sistema: systemDefaultCharset.

Returns:

o nome

getServerHostCharset

public final java.nio.charset.Charset getServerHostCharset()

Retorna o charset default da máquina do servidor:

Returns:

o charset

getServerHostCharsetName

public final java.lang.String getServerHostCharsetName()

Retorna o nome charset da máquina do servidor: serverHostCharset.

Returns:

o nome

getRegistryPort

public int getRegistryPort()

Retorna a porta na qual o registry RMI devem ser encontrado.

Returns:

porta na qual executa o registry RMI.

getRMIExportPort

public int getRMIExportPort()

Retorna a porta na qual os objetos RMI devem ser exportados.

Returns:

porta na qual os objetos RMI devem ser exportados.

getPrivateKeyPassword

public java.lang.String getPrivateKeyPassword()

Obtém a senha da chave privada do servidor. Só existirá quando o servidor for servidor local.

Returns:

A senha da chave privada ou null, caso o servidor não seja servidor local ou se a senha não foi informada.

overridesServiceProperty

protected final boolean overridesServiceProperty(java.lang.String prefixedKey)

Indica se o servidor faz override da propriedade de um serviço

Parameters:

prefixedKey - a chave (já prefixada pelo serviço)

Returns:

indicativo.

getStringProperty

protected final java.lang.String getStringProperty(java.lang.String key)

Recupera uma propriedade da aplicação (string)

Parameters:

key - a identificação da propriedade

Returns:

o valor da propriedade.

Throws:

java.lang.IllegalStateException - se a propriedade não estiver setada.

See Also:

ServerSideProperties.getStringProperty(String)

getDoubleProperty

protected final double getDoubleProperty(java.lang.String key)

Recupera uma propriedade da aplicação (double)

Parameters:

key - a chave

Returns:

o valor

Throws:

java.lang.IllegalStateException - se a propriedade não estiver setada.

getIntProperty

public final int getIntProperty(java.lang.String key)

Recupera uma propriedade da aplicação (int)

Parameters:

key - a chave

Returns:

o valor

Throws:

java.lang.IllegalStateException - se a propriedade não estiver setada.

getLongProperty

public final long getLongProperty(java.lang.String key)

Recupera uma propriedade da aplicação (long)

Parameters:

key - a chave

Returns:

o valor

Throws:

java.lang.IllegalStateException - se a propriedade não estiver setada.

getBooleanProperty

protected final boolean getBooleanProperty(java.lang.String key)

Recupera uma propriedade da aplicação (boolean)

Parameters:

key - a chave

Returns:

o valor

Throws:

java.lang.IllegalStateException - se a propriedade não estiver setada.

getStringListProperty

protected final java.util.List<java.lang.String> getStringListProperty(java.lang.String key)

Recupera uma propriedade da aplicação (lista)

Parameters:

key - a chave (prefixo)

Returns:

o valor

Throws:

java.lang.IllegalStateException - se a propriedade não estiver setada.

isPropertyNull

protected final boolean isPropertyNull(java.lang.String key)

Verifica a nulidade de uma propriedade

Parameters:

key - a identificação da propriedade

Returns:

indicativo

getSystemName

public java.lang.String getSystemName()

Nome do sistema. Por exemplo: InfoGrid, WebSintesi, MARLIM.

Returns:

O nome do sistema

getVersion

public java.lang.String getVersion()

Obtém a versão do servidor.

Returns:

a versão.

getSystemURL

public java.lang.String getSystemURL()

Pega a URL para execução do cliente applet do sistema.

Returns:

A URL.

generateDirectoryFileName

public static java.lang.String generateDirectoryFileName(java.lang.String pattern)

Baseado em java.util.logging.FileHandler.generate. Porém, apenas gera o nome do diretório aplicando o pattern fornecido.

Parameters:

pattern - a identificação da propriedade A pattern consists of a string that includes the following special components that will be replaced at runtime:

• "/" the local pathname separator
• "%t" the system temporary directory
• "%h" the value of the "user.home" system property
• "%%" translates to a single percent sign "%"

Não vamos dar suporte em nome de diretório a:

• "%g" the generation number to distinguish rotated logs
• "%u" a unique number to resolve conflicts

Returns:

indicativo

isCentralServer

public boolean isCentralServer()

Verifica se o servidor é servidor central.

Returns:

true, caso seja um servidor central, ou false, caso contrário.

getString

public java.lang.String getString(java.lang.String key)

Traduz uma determinada chave na sua string correspondente com o locale padrão.

Parameters:

key - chave do bundle.

Returns:

String com o texto respectivo a chave.

getString

public java.lang.String getString(java.lang.String key,
                         java.util.Locale locale)

Traduz uma determinada chave na sua string correspondente de acordo com o locale desejado.

Parameters:

key - chave do bundle.

locale - o locale desejado para internacionalização.

Returns:

String com o texto respectivo a chave.

getFormattedString

public java.lang.String getFormattedString(java.lang.String key,
                                  java.lang.Object... objects)

Traduz uma determinada chave na sua string formatada inferindo o locale do usuário (thread) que originou a chamada (será usado um locale padrão se houver falha nesta identificação).

Parameters:

key - chave do bundle.

objects - array de objetos de formatação.

Returns:

string com o texto respectivo a chave.

logSevereMessage

public static void logSevereMessage(java.lang.String msg,
                    java.lang.Throwable t)

Gera uma mensagem de log de nível SEVERE.

Parameters:

msg - A mensagem de log.

t - A pilha correspondente. Pode ser null.

logSevereMessage

public static void logSevereMessage(java.lang.String msg)

Gera uma mensagem de log de nível SEVERE.

Parameters:

msg - A mensagem de log.

logWarningMessage

public static void logWarningMessage(java.lang.String msg)

Gera uma mensagem de log de nível WARNING.

Parameters:

msg - A mensagem de log.

logInfoMessage

public static void logInfoMessage(java.lang.String msg)

Gera uma mensagem de log de nível INFO.

Parameters:

msg - A mensagem de log.

logFineMessage

public static void logFineMessage(java.lang.String msg)

Gera uma mensagem de log de nível FINE. Esse nível deve ser usado para mensagens de depuração.

Parameters:

msg - A mensagem de log.

shutdown

public void shutdown()

Finaliza o ambiente de execução no servidor.

start

public boolean start()

Inicia o servidor, inicializando todos os serviços locais. Caso esteja definido um servidor central, é feito o o login nele como admin. Note que a conexão ao servidor central só pode ser feita após a inicialização dos serviços locais pois é necessária a senha de admin para efetuar o login. Por outro lado, o monitor tem que exitir antes que os serviços sejam inicializados para que os observadores possam ser colocados.

Returns:

indicativo.

listRuntimeProperties

public java.lang.String listRuntimeProperties()

Obtém todas as propriedades runtime como uma string.

Returns:

string com todas as propriedades

getRuntimeProperties

public java.util.Map<java.lang.String,java.lang.String> getRuntimeProperties()

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

Returns:

mapa com as propriedades runtime do servidor

getPropertiesInfo

public java.util.Map<java.lang.String,csbase.logic.diagnosticservice.PropertyInfo> getPropertiesInfo()

getServerConfig

protected java.lang.String getServerConfig()

Obtém as informações de configuração do servidor. Por default mostra o IP (Server.hostAddr), nome (Server.hostName) e portas RMI (Server.registryPort e Server.rmiExportPort), mas os sistemas podem redefinir este método para mostrar mais (ou menos) informações.

Returns:

informações de configuração do servidor

getServerLibs

public java.lang.String[] getServerLibs()

Obtém as bibliotecas utilizadas pelo servidor

Returns:

as bibliotecas carregadas pelo class loader

startCentralServerMonitor

public abstract void startCentralServerMonitor()

Inicia a classe que será usada pelo servidor local para monitorar o estado da conexão com um servidor central.

getInstance

public static Server getInstance()

Retorna a instância do servidor.

Returns:

a instância

getPersistencyRootDirectoryName

public java.lang.String getPersistencyRootDirectoryName()

Método de consulta ao nome do diretório-raiz de dados persistidos.

Returns:

uma string com o nome do diretório-raiz.

getRunningDirectoryName

public java.lang.String getRunningDirectoryName()

Método de consulta ao nome do diretório de execução do servidor.

Returns:

uma string com o nome do diretório de execução do servidor.

getPropertiesRootDirectoryName

public static java.lang.String getPropertiesRootDirectoryName()

Método de consulta ao nome do diretório-raiz de propriedades.

Returns:

uma string com o nome do diretório-raiz.

postInitialization

public abstract void postInitialization()
                                 throws csbase.exception.InitFailureException

Método chamado após a inicialização dos serviços.

Throws:

csbase.exception.InitFailureException - caso ocorra alguma falha na pós inicialização

getStartupTime

public long getStartupTime()

Obtém o timestamp da inicialização do servidor.

Returns:

timestamp da inicialização do servidor

getMessageBroker

public csbase.util.messages.MessageBroker getMessageBroker()

Obtém o broker de mensagens.

Returns:

o broker de mensagens.