Client (csbase-client BRS-4.0.0 API)

java.lang.Object
- csbase.client.Client

public abstract class Client
extends Object

Representa um cliente.

Author:: Tecgraf/PUC-Rio

Field Summary

Fields
Modifier and Type Field and Description

protected static String DEFAULT_LOCALE_PROPERTY
O nome da propriedade que define a locale default na falta de uma ser informada.

Fields
Modifier and Type	Field and Description
`protected static String`	`DEFAULT_LOCALE_PROPERTY` O nome da propriedade que define a locale default na falta de uma ser informada.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Client(String systemName, Map<String,String> parameterMap)
Cria um cliente, definindo a sua instância única.

Constructors
Modifier	Constructor and Description
`protected`	`Client(String systemName, Map<String,String> parameterMap)` Cria um cliente, definindo a sua instância única.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`createClientRemoteMonitor()` Cria o monitorador do servidor.
`protected CSDKContextFactory`	`createCSDKContextFactory()` Cria a fábrica de contextos do CSDK.
`protected InitialContext`	`createInitialContext(Locale locale)` Cria o contexto inicial de execução do cliente.
`protected AbstractLoginUI`	`createLoginDialog()` Cria o diálogo de login.
`protected ClientUI`	`createUI(Class<ClientUI> uiClass)` Cria a interface de usuário.
`protected boolean`	`doesLoggedUserHavePermission()` Verifica se o usuário logado tem permissão para executar o cliente.
`boolean`	`execute()` Executa o cliente.
`protected boolean`	`executeClientUI(InitialContext initialContext)` Carrega o cliente após o login do usuário no sistema.
`protected InitialContext`	`executeDefaultLogin(Locale defaultLocale)` Executa o cliente solicitando login e senha ao usuário.
`String`	`generateNewSonId()` Gera um novo id para um cliente-filho.
`String`	`getAppAddress()` Obtém o endereço web da aplicação no servidor.
`String`	`getClientAddress()` Retorna o nome da máquina cliente
`Charset`	`getClientHostCharset()` Retorna o charset default da máquina do cliente.
`String`	`getClientHostCharsetName()` Retorna o nome charset default da máquina do cliente, conforme `getClientHostCharset()`.
`String`	`getClientInstanceId()` Retorna o identificador da instância do cliente com base no login feito.
`String`	`getClientName()` Retorna o endereço IP do cliente.
`protected Class<? extends csbase.remote.ClientRemoteLocator>`	`getClientRemoteLocatorClass()` A classe do localizador de serviços remotos.
`protected Class<? extends csbase.logic.ServerManager>`	`getClientRemoteMonitorClass()` A classe de monitoração do servidor.
`static String`	`getCodeBaseStr()` Retorna a URL que representa o codebase da aplicação ou, se não for possível obter os recursos externos, retorna o path absoluto corrente.
`protected tecgraf.javautils.configurationmanager.Configuration`	`getConfiguration()` Obtém a configuração da classe.
`CSDKContextFactory`	`getCSDKContextFactory()` Obtém a fábrica de contextos do CSDK.
`Locale`	`getDefaultLocale()` Retorna o locale default configurado como parâmetro no arquivo JNLP do cliente.
`String`	`getFatherClientInstanceId()` Retorna o identificador da instância do cliente que originou a execução deste cliente; a informação é obtida com base no login feito.
`String`	`getHostAddress()` Obtém o endereço da máquina onde o cliente está rodando.
`static Client`	`getInstance()` Obtém a instância única do cliente.
`LoginInterface`	`getLoginObject()` Consulta o objeto de login utilizada pelo cliente.
`String`	`getParameter(String parameterName)` Obtém um parâmetro do cliente.
`ParameterViewFactory`	`getParameterViewFactory()` Obtém a fábrica de visão de parâmetros dos algoritmos.
`int`	`getRMIExportPort()` Obtém a porta na qual os objetos RMI devem ser exportados.
`String`	`getServerAddress()` Obtém o ip do servidor.
`String`	`getServerName()` Obtém o nome do servidor, sem a porta, ao qual o cliente está conectado.
`String`	`getStartApplicationId()` Retorna indicativo se dekstop deve iniciar visível.
`Charset`	`getSystemDefaultCharset()` Retorna o charset default do sistema, conforme configurado pelo servidor.
`String`	`getSystemDefaultCharsetName()` Retorna o nome charset default do sistema, conforme definição de `getSystemDefaultCharset()`.
`String`	`getSystemName()` Retorna o nome da instância do Client.
`String`	`getTextNotFoundInAnyIdiom()` Obtém as chaves de idioma não encontradas em todos os bundles carregados.
`String`	`getTextNotFoundInSelectedIdiom()` Obtém as chaves de idioma não encontradas no idioma selecionado pelo usuário.
`protected Class<ClientUI>`	`getUIClass(String uiClassProperty)` Obtem a classe de Interface de usuário definida pela propriedade respectiva
`abstract String`	`getVersion()` Obtém a versão do cliente.
`JFrame`	`getView()` Obtém o componente gráfico concreto que representa a interface de usuário.
`boolean`	`isOpenBusNeeded()` Verifica se o acesso ao OpenBus está habilitado.
`protected boolean`	`loadExternalLanguageFiles(Locale locale)` Carrega os arquivos de idioma que são externos.
`void`	`loadLanguageFiles(Locale locale)` Carrega os arquivos de idioma.
`protected LoginInterface`	`loadLoginObject(Locale initLocale)` Carrega objeto de login.
`protected void`	`postInitialization(InitialContext initialContext)` Esse método é chamado após o usuário ter feito o login.
`protected void`	`setLoginObject(LoginInterface loginObject)` Ajuste o objeto de login utilizada pelo cliente.
`protected void`	`setParameterViewFactory(ParameterViewFactory parameterViewFactory)` Atribui a fábrica de visão de parâmetros dos algoritmos.
`void`	`setServerName(String serverName)` Configura o nome do servidor ao qual o usuário acabou de se conectar.
`boolean`	`shouldDesktopStartVisible()` Retorna indicativo se dekstop deve iniciar visível.
`boolean`	`showServerName()` Indica se o nome do servidor deve ser exibido no título das janelas primárias.
`void`	`shutdown()` Finalização do cliente.
`Object`	`startProjectId()` Indica se este cliente deve tentar abrir abrir um projeto.
`boolean`	`useClientOptimizationMode()` Indica se este cliente pode ou não utilizar algum modo de otimização de acesso à área de projetos.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_LOCALE_PROPERTY
```
protected static final String DEFAULT_LOCALE_PROPERTY
```
    O nome da propriedade que define a locale default na falta de uma ser informada.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - Client
```
protected Client(String systemName,
      Map<String,String> parameterMap)
```
    Cria um cliente, definindo a sua instância única.
    
    Parameters:
    systemName - .
    parameterMap - A URL para conexão com o servidor.
    
    Throws:
    
    IllegalStateException - Caso já exista um cliente criado.
    
    csbase.exception.ConfigurationException - Caso não seja possível obter a configuração da classe.
- Method Detail
  - getSystemDefaultCharset
```
public final Charset getSystemDefaultCharset()
```
    Retorna o charset default do sistema, conforme configurado pelo servidor.
    
    Returns:
    o valor
  - getClientHostCharset
```
public final Charset getClientHostCharset()
```
    Retorna o charset default da máquina do cliente.
    
    Returns:
    o valor
  - getSystemDefaultCharsetName
```
public final String getSystemDefaultCharsetName()
```
    Retorna o nome charset default do sistema, conforme definição de getSystemDefaultCharset().
    
    Returns:
    o nome
  - getClientHostCharsetName
```
public final String getClientHostCharsetName()
```
    Retorna o nome charset default da máquina do cliente, conforme getClientHostCharset().
    
    Returns:
    o nome
  - createCSDKContextFactory
```
protected CSDKContextFactory createCSDKContextFactory()
```
    Cria a fábrica de contextos do CSDK.
    
    Returns:
    a fábrica de contextos.
  - getSystemName
```
public String getSystemName()
```
    Retorna o nome da instância do Client.
    
    Returns:
    Retorna o nome da instância do Client.
  - showServerName
```
public boolean showServerName()
```
    Indica se o nome do servidor deve ser exibido no título das janelas primárias.
    
    Returns:
    true se o nome do servidor deve ser exibido no título das janelas primárias
  - execute
```
public boolean execute()
```
    Executa o cliente.
    
    Returns:
    true, caso o cliente tenha sido executado com sucesso, ou false, caso contrário.
  - loadLoginObject
```
protected LoginInterface loadLoginObject(Locale initLocale)
```
    Carrega objeto de login.
    
    Parameters:
    initLocale - locale inicial
    
    Returns:
    objeto LoginInterface.
  - getClientInstanceId
```
public final String getClientInstanceId()
```
    Retorna o identificador da instância do cliente com base no login feito.
    
    Returns:
    o id.
  - getFatherClientInstanceId
```
public final String getFatherClientInstanceId()
```
    Retorna o identificador da instância do cliente que originou a execução deste cliente; a informação é obtida com base no login feito.
    
    Returns:
    o id.
  - executeDefaultLogin
```
protected InitialContext executeDefaultLogin(Locale defaultLocale)
```
    Executa o cliente solicitando login e senha ao usuário.
    
    Parameters:
    defaultLocale - O locale default configurado na instalação do servidor.
    
    Returns:
    true, caso a execução do cliente ocorra sem problemas, ou false, caso contrário.
  - getUIClass
```
protected Class<ClientUI> getUIClass(String uiClassProperty)
```
    Obtem a classe de Interface de usuário definida pela propriedade respectiva
    
    Parameters:
    uiClassProperty - .
    
    Returns:
    A classe de interface de usuário.
    
    Throws:
    
    csbase.exception.ConfigurationException - Caso a propriedade informando a interface de usuário não seja encontrada ou a classe informada não exista.
  - executeClientUI
```
protected boolean executeClientUI(InitialContext initialContext)
```
    Carrega o cliente após o login do usuário no sistema.
    
    Parameters:
    initialContext - Informações de login.
    
    Returns:
    true, caso a carga do cliente ocorra sem problemas, ou false, caso contrário.
  - doesLoggedUserHavePermission
```
protected boolean doesLoggedUserHavePermission()
```
    Verifica se o usuário logado tem permissão para executar o cliente.
    
    Returns:
    true, se o usuário pode executar o cliente, ou false, caso contrário.
    
    Throws:
    
    csbase.exception.ConfigurationException - Caso a classe da permissão não seja encontrada.
  - loadLanguageFiles
```
public void loadLanguageFiles(Locale locale)
```
    Carrega os arquivos de idioma.
    
    Parameters:
    locale - O locale do usuário logado.
    
    Throws:
    
    csbase.exception.ConfigurationException - Caso não tenham sido definidos arquivos de idiomas ou não tenha sido definida alguma propriedade obrigatória.
  - loadExternalLanguageFiles
```
protected boolean loadExternalLanguageFiles(Locale locale)
```
    Carrega os arquivos de idioma que são externos. Os arquivos externos definidos serão inseridos no fim da hierarquia de bundles.
    
    Parameters:
    locale - O locale do usuário logado.
    
    Returns:
    true, se todos os bundles externos foram carregados com sucesso
  - getCodeBaseStr
```
public static String getCodeBaseStr()
```
    Retorna a URL que representa o codebase da aplicação ou, se não for possível obter os recursos externos, retorna o path absoluto corrente.
    
    Returns:
    prefixo de uma url, incluindo protocolo (http://, file:// etc)
  - createClientRemoteMonitor
```
protected void createClientRemoteMonitor()
```
    Cria o monitorador do servidor.
  - getClientRemoteLocatorClass
```
protected Class<? extends csbase.remote.ClientRemoteLocator> getClientRemoteLocatorClass()
```
    A classe do localizador de serviços remotos.
    
    Returns:
    O localizador de serviços remotos.
    
    Throws:
    
    csbase.exception.ConfigurationException - Caso a classe informada não exista.
  - getClientRemoteMonitorClass
```
protected Class<? extends csbase.logic.ServerManager> getClientRemoteMonitorClass()
```
    A classe de monitoração do servidor.
    
    Returns:
    O monitorador do servidor.
    
    Throws:
    
    csbase.exception.ConfigurationException - Caso a classe informada não exista.
  - postInitialization
```
protected void postInitialization(InitialContext initialContext)
```
    Esse método é chamado após o usuário ter feito o login.
    
    OBS: Nesse momento, as configurações de idioma e os campos do locator para acesso aos serviços já estão definidos.
    
    Parameters:
    initialContext - O contexto inicial de execução do cliente.
  - createUI
```
protected ClientUI createUI(Class<ClientUI> uiClass)
                     throws ClientException
```
    Cria a interface de usuário.
    
    Parameters:
    uiClass - Classe da interface de usuário
    
    Returns:
    A interface de usuário.
    
    Throws:
    
    ClientException - Caso ocorra algum problema ao iniciar a interface de usuário.
    
    csbase.exception.ConfigurationException - Caso ocorra algum problema durante a construção da interface de usuário
  - createLoginDialog
```
protected AbstractLoginUI createLoginDialog()
```
    Cria o diálogo de login.
    
    Returns:
    O diálogo de login.
    
    Throws:
    
    csbase.exception.ConfigurationException - Caso ocorra algum erro na criação do diálogo de login ou a classe informada como classe de login não exista.
  - getInstance
```
public static Client getInstance()
```
    Obtém a instância única do cliente.
    
    Returns:
    A instância única do cliente.
    
    Throws:
    
    IllegalArgumentException - Caso a instância ainda não tenha sido criada.
  - getParameter
```
public final String getParameter(String parameterName)
```
    Obtém um parâmetro do cliente.
    
    Parameters:
    parameterName - O nome do parâmetro que se deseja.
    
    Returns:
    O parâmetro, ou null, caso não exista.
  - getServerName
```
public final String getServerName()
```
    Obtém o nome do servidor, sem a porta, ao qual o cliente está conectado. O endereço do servidor com a porta também é um parâmetro do cliente que pode ser obtido através do método getParameter(Client.SERVER_URL_PARAMETER).
    
    Returns:
    O nome do servidor
  - getClientAddress
```
public final String getClientAddress()
```
    Retorna o nome da máquina cliente
    
    Returns:
    nome
  - getClientName
```
public final String getClientName()
```
    Retorna o endereço IP do cliente.
    
    Returns:
    endereço
  - getServerAddress
```
public String getServerAddress()
                        throws csbase.exception.ConfigurationException
```
    Obtém o ip do servidor.
    
    Returns:
    o ip do servidor.
    
    Throws:
    
    csbase.exception.ConfigurationException - se não foi possível obter o ip, se um ou se um scope_id foi especificado para um endereço IPv6 global ou se existe um gerente de segurança e seu método checkConnect não permite a operação.
  - createInitialContext
```
protected InitialContext createInitialContext(Locale locale)
```
    Cria o contexto inicial de execução do cliente.
    
    Parameters:
    locale - O idioma selecionado pelo usuário.
    
    Returns:
    O contexto inicial de execução do cliente.
    
    Throws:
    
    csbase.exception.ConfigurationException - Caso ocorra algum erro na criação do contexto inicial.
  - getHostAddress
```
public final String getHostAddress()
```
    Obtém o endereço da máquina onde o cliente está rodando.
    
    Returns:
    O endereço da máquina onde o cliente está rodando.
  - getAppAddress
```
public final String getAppAddress()
```
    Obtém o endereço web da aplicação no servidor.
    
    Returns:
    o endereço web da aplicação no servidor.
  - getDefaultLocale
```
public final Locale getDefaultLocale()
```
    Retorna o locale default configurado como parâmetro no arquivo JNLP do cliente.
    
    Returns:
    O locale configurado no JNLP do cliente ou null se o parâmetro não foi encontrado.
  - shouldDesktopStartVisible
```
public final boolean shouldDesktopStartVisible()
```
    Retorna indicativo se dekstop deve iniciar visível.
    
    Returns:
    indicativo.
  - getStartApplicationId
```
public final String getStartApplicationId()
```
    Retorna indicativo se dekstop deve iniciar visível.
    
    Returns:
    indicativo.
  - getConfiguration
```
protected tecgraf.javautils.configurationmanager.Configuration getConfiguration()
```
    Obtém a configuração da classe.
    
    Returns:
    A configuração do usuário
  - getView
```
public final JFrame getView()
```
    Obtém o componente gráfico concreto que representa a interface de usuário.
    
    Returns:
    O componente gráfico concreto.
  - getParameterViewFactory
```
public ParameterViewFactory getParameterViewFactory()
```
    Obtém a fábrica de visão de parâmetros dos algoritmos.
    
    Returns:
    A fábrica.
  - setParameterViewFactory
```
protected void setParameterViewFactory(ParameterViewFactory parameterViewFactory)
```
    Atribui a fábrica de visão de parâmetros dos algoritmos.
    
    Parameters:
    parameterViewFactory - A fábrica.
  - isOpenBusNeeded
```
public boolean isOpenBusNeeded()
```
    Verifica se o acesso ao OpenBus está habilitado.
    
    Returns:
    true, caso o acesso esteja habilitado, ou false, caso contrário.
  - setLoginObject
```
protected final void setLoginObject(LoginInterface loginObject)
```
    Ajuste o objeto de login utilizada pelo cliente.
    
    Parameters:
    loginObject - o objeto.
  - getLoginObject
```
public final LoginInterface getLoginObject()
```
    Consulta o objeto de login utilizada pelo cliente.
    
    Returns:
    o objeto.
  - getTextNotFoundInAnyIdiom
```
public String getTextNotFoundInAnyIdiom()
```
    Obtém as chaves de idioma não encontradas em todos os bundles carregados.
    
    Returns:
    um texto com as chaves não encontradas
  - getTextNotFoundInSelectedIdiom
```
public String getTextNotFoundInSelectedIdiom()
```
    Obtém as chaves de idioma não encontradas no idioma selecionado pelo usuário. As chaves vem acompanhadas com o texto usado no idioma nativo.
    
    Returns:
    um texto com as chaves não traduzidas
  - shutdown
```
public void shutdown()
```
    Finalização do cliente.
  - generateNewSonId
```
public final String generateNewSonId()
```
    Gera um novo id para um cliente-filho.
    
    Returns:
    o id
  - setServerName
```
public final void setServerName(String serverName)
```
    Configura o nome do servidor ao qual o usuário acabou de se conectar. O ip do servidor é setado para null, forçando que o mesmo seja recalculado sob demanda.
    
    Parameters:
    serverName - o nome.
  - getRMIExportPort
```
public int getRMIExportPort()
```
    Obtém a porta na qual os objetos RMI devem ser exportados.
    
    Um valor menor ou igual a zero indica que objetos não devem ser exportados.
    
    Returns:
    porta na qual os objetos RMI devem ser exportados.
  - getCSDKContextFactory
```
public CSDKContextFactory getCSDKContextFactory()
```
    Obtém a fábrica de contextos do CSDK.
    
    Returns:
    a fábrica.
  - getVersion
```
public abstract String getVersion()
```
    Obtém a versão do cliente.
    
    Returns:
    a versão.
  - useClientOptimizationMode
```
public boolean useClientOptimizationMode()
```
    Indica se este cliente pode ou não utilizar algum modo de otimização de acesso à área de projetos. O padrão é usar sempre a otimização.
    
    Returns:
    true, caso possa usar; false, caso contrário.
  - startProjectId
```
public Object startProjectId()
```
    Indica se este cliente deve tentar abrir abrir um projeto.
    
    Returns:
    o projeto indicado ou null.

Class Client

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_LOCALE_PROPERTY

Constructor Detail

Client

Method Detail

getSystemDefaultCharset

getClientHostCharset

getSystemDefaultCharsetName

getClientHostCharsetName

createCSDKContextFactory

getSystemName

showServerName

execute

loadLoginObject

getClientInstanceId

getFatherClientInstanceId

executeDefaultLogin

getUIClass

executeClientUI

doesLoggedUserHavePermission

loadLanguageFiles

loadExternalLanguageFiles

getCodeBaseStr

createClientRemoteMonitor

getClientRemoteLocatorClass

getClientRemoteMonitorClass

postInitialization

createUI

createLoginDialog

getInstance

getParameter

getServerName

getClientAddress

getClientName

getServerAddress

createInitialContext

getHostAddress

getAppAddress

getDefaultLocale

shouldDesktopStartVisible

getStartApplicationId

getConfiguration

getView

getParameterViewFactory

setParameterViewFactory

isOpenBusNeeded

setLoginObject

getLoginObject

getTextNotFoundInAnyIdiom

getTextNotFoundInSelectedIdiom

shutdown

generateNewSonId

setServerName

getRMIExportPort

getCSDKContextFactory

getVersion

useClientOptimizationMode

startProjectId