ApplicationRegistry (csbase-common 3.4.1-RC2 API)

java.lang.Object
- csbase.logic.applicationservice.ApplicationRegistry

All Implemented Interfaces:

Serializable
```
public final class ApplicationRegistry
extends Object
implements Serializable
```
Classe que representa um registro de aplicação.

Author:

Tecgraf/PUC-Rio

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ApplicationRegistry(String id, long timestamp)
Construtor.

Constructors
Constructor and Description
`ApplicationRegistry(String id, long timestamp)` Construtor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`closeConfiguration()` Fecha as definições de um registry.
`String`	`getApplicationCommand()` Consulta ao comando da aplicação.
`String`	`getApplicationCommandDir()` Consulta ao diretório onde está o comando da aplicação.
`String`	`getApplicationDescription(Locale locale)` Consulta o nome de uma aplicação.
`FileInfo[]`	`getApplicationLibs()` Obtém as bibliotecas da aplicação.
`String`	`getApplicationName(Locale locale)` Consulta o nome de uma aplicação.
`String`	`getAuthorMail()` Consulta ao email de contato.
`String`	`getAuthorName()` Consulta ao nome do autor do programa.
`boolean`	`getBooleanSpecificProperty(String propName)` Obtém uma propriedade específica do tipo booleana.
`List<Pattern>`	`getClassLoaderBlackList()` Obtém a lista com os padrões de nome que determina que uma classe não pode ser carregada no classloader da aplicação (além das que são declaradas no classpath da aplicação).
`List<Pattern>`	`getClassLoaderWhiteList()` Obtém a lista com os padrões de nome que determina que uma classe pode ser carregada no classloader da aplicação (além das que são declaradas no classpath da aplicação).
`String`	`getClassName()` Obtém a classe da aplicação.
`List<String>`	`getClasspath()` Consulta a lista de bibliotecas do classpath da aplicação.
`String`	`getClassString(Class<?> clazz, String key)` Retorna uma string de idioma, com base em uma classe.
`String`	`getClassString(Class<?> clazz, String key, Object... args)` Retorna uma string de idioma, com base em uma classe.
`double`	`getDoubleSpecificProperty(String propName)` Obtém uma propriedade específica do tipo double.
`List<String>`	`getFileTypes()` Obtém os tipos de arquivo que abrem diretamente esta aplicação.
`byte[]`	`getIconDefinition()` Busca do ícone configurada para a aplicação.
`String`	`getId()` Obtém o id da aplicação.
`byte[]`	`getImageDefinition()` Busca da imagem configurada para a aplicação.
`int`	`getIntSpecificProperty(String propName)` Obtém uma propriedade específica do tipo inteiro.
`long`	`getLongSpecificProperty(String propName)` Obtém uma propriedade específica do tipo long.
`String`	`getObjectString(Object object, String key)` Retorna uma string de idioma, com base em um objeto.
`String`	`getObjectString(Object object, String key, Object... args)` Retorna uma string de idioma, com base em um objeto.
`AppPropertyResourceBundle`	`getResourceBundle()` Obtém o resource bundle da aplicação
`Properties`	`getSpecificProperties()` Consulta ao conunto propriedades específicas.
`String`	`getString(String key)` Obtem uma string de idioma.
`String`	`getString(String key, Object[] objs)` Obtem uma string de idioma.
`List<String>`	`getStringListSpecificProperty(String name)` Obtém uma lista de valores de propriedades que seguem o padrão para propriedades multi-valoradas usado pelo JDK da Sun.
`String`	`getStringSpecificProperty(String propName)` Obtém uma propriedade específica.
`long`	`getTimestamp()` Retorna o timestamp desse registro no servidor.
`tecgraf.javautils.core.lng.LNG.TranslationListener`	`getTranslationListener()` Obtém o callback usado para chaves não encontradas.
`String`	`getVersion()` Consulta à versão do programa
`int`	`getVersionNumber()` Consulta à versão do programa
`boolean`	`hasClassString(Class<?> clazz, String key)` Consulta da existência de uma string de idioma, com base em uma classe.
`boolean`	`hasObjectString(Object object, String key)` Consulta da existência de uma string de idioma, com base em um objeto.
`boolean`	`hasString(String key)` Consulta da existência de uma string de idioma.
`boolean`	`isBundleRequired()` Consulta de bundle é necessário.
`boolean`	`isEnabled()` Consulta a habilitação do aplicativo.
`boolean`	`isPropertyNull(String propName)` Indicativo de propriedade sem valor.
`boolean`	`isRunnable()` Indica se a aplicação possui uma linha de comando e seu o comando foi encotrado no `PATH` do cliente.
`boolean`	`isShownAtApplicationMenu()` Consulta se aplicação aparece em menu.
`boolean`	`isShownAtApplicationPanel()` Consulta se aplicação aparece no app-panel
`boolean`	`isSingleton()` Consulta se uma aplicação é "singleton"
`boolean`	`loadClientBundles(Class<?> mainClass, Locale locale)` Carrega os arquivos de idioma.
`boolean`	`loadServerBundles(ApplicationServiceInterface appService, Locale locale)` Carga de bundle de servidor.
`void`	`loadURLBundles(String pathPrefixURL, Locale locale)` Carrega os arquivos de idiomas a partir de URLs.
`boolean`	`mainFrameIsVisible()` Consulta se a frame da aplicação deve ficar visível.
`boolean`	`requireProject()` Consulta se aplicação necessita de projeto.
`void`	`setClassLoaderBlackList(List<Pattern> blackList)` Define a lista com os padrões de nome que determina que uma classe não pode ser carregada no classloader da aplicação (além das que são declaradas no classpath da aplicação).
`void`	`setClassLoaderWhiteList(List<Pattern> whiteList)` Define a lista com os padrões de nome que determina que uma classe pode ser carregada no classloader da aplicação (além das que são declaradas no classpath da aplicação).
`void`	`setClasspathBaseDir(File baseDir)` Ajusta o diretório base de onde buscar os arquivos declarados no classpath.
`void`	`setIconDefinition(byte[] img16)` Ajuste de icone de aplicação.
`void`	`setImageDefinition(byte[] img32)` Ajuste de imagem de aplicação.
`void`	`setSpecificProperties(Properties prop)` Ajusta properties da aplicação.
`void`	`setTranslationListener(tecgraf.javautils.core.lng.LNG.TranslationListener callback)` Define o callback usado para chaves não encontradas.
`String`	`toString()`

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

- Constructor Detail
  - ApplicationRegistry
```
public ApplicationRegistry(String id,
                           long timestamp)
```
    Construtor.
    
    Parameters:
    
    id - identificador da aplicação.
    
    timestamp - data da última modificação do diretório da aplicação no servidor.
- Method Detail
  - setTranslationListener
```
public void setTranslationListener(tecgraf.javautils.core.lng.LNG.TranslationListener callback)
```
    Define o callback usado para chaves não encontradas.
    
    Parameters:
    
    callback - o objeto que implementa a interface NotTranslationInterface para tratar chaves não encontradas nos bundles carregados.
  - getTranslationListener
```
public tecgraf.javautils.core.lng.LNG.TranslationListener getTranslationListener()
```
    Obtém o callback usado para chaves não encontradas.
    
    Returns:
    
    callback o objeto que implementa a interface NotTranslationInterface para tratar chaves não encontradas nos bundles carregados.
  - loadClientBundles
```
public final boolean loadClientBundles(Class<?> mainClass,
                                       Locale locale)
```
    Carrega os arquivos de idioma. O primeiro bundle carregado é o arquivo da própria aplicação (p.ex. AppClassName_pt_BR.properties). Arquivos adicionais definidos via ADDITIONAL_LANGUAGE_FILE_PROPERTY são carregados em seguida, na ordem em que foram definidos. A busca por traduções acontece do último arquivo definido para o primeiro; o primeiro que possuir a chave desejada será usado.
    
    Parameters:
    
    mainClass - Classe principal da aplicação.
    
    locale - O locale do usuário logado.
    
    Returns:
    
    indicativo se algume arquivo foi encontrado e carregado.
  - loadServerBundles
```
public boolean loadServerBundles(ApplicationServiceInterface appService,
                                 Locale locale)
                          throws RemoteException
```
    Carga de bundle de servidor.
    
    Parameters:
    
    appService - serviço
    
    locale - locale
    
    Returns:
    
    indicativo se o arquivo foi encontrado e carregado.
    
    Throws:
    
    RemoteException - em caso de erro
  - loadURLBundles
```
public final void loadURLBundles(String pathPrefixURL,
                                 Locale locale)
```
    Carrega os arquivos de idiomas a partir de URLs. Os arquivos são carregados na ordem em que foram definidos. A busca por traduções acontece do último arquivo definido para o primeiro; o primeiro que possuir a chave desejada será usado.
    
    Assumimos que os bundles da aplicação já foram lidos anteriormente. Portanto, se os tipos de bundles forem utilizados por uma aplicação, isso significa que os bundles externos (obtidos de URLs) serão colocados no fim da hierarquia.
    
    Parameters:
    
    pathPrefixURL - URL-base (prefixo) para obter a URl dos bundles externos de cada aplicação. Deve conter o protocolo usado (http://, file://, etc.)
    
    locale - O locale do usuário logado.
  - hasClassString
```
public final boolean hasClassString(Class<?> clazz,
                                    String key)
```
    Consulta da existência de uma string de idioma, com base em uma classe.
    
    Parameters:
    
    clazz - classe.
    
    key - a chave de busca.
    
    Returns:
    
    indicativo
    
    See Also:
    
    hasString(String)
  - getClassString
```
public final String getClassString(Class<?> clazz,
                                   String key)
```
    Retorna uma string de idioma, com base em uma classe.
    
    Parameters:
    
    clazz - classe.
    
    key - a chave de busca.
    
    Returns:
    
    indicativo
    
    See Also:
    
    getString(String)
  - getClassString
```
public final String getClassString(Class<?> clazz,
                                   String key,
                                   Object... args)
```
    Retorna uma string de idioma, com base em uma classe.
    
    Parameters:
    
    clazz - a classe.
    
    key - a chave de busca.
    
    args - argumentos
    
    Returns:
    
    indicativo
    
    See Also:
    
    getString(String, Object[])
  - hasObjectString
```
public final boolean hasObjectString(Object object,
                                     String key)
```
    Consulta da existência de uma string de idioma, com base em um objeto.
    
    Parameters:
    
    object - o objeto.
    
    key - a chave de busca.
    
    Returns:
    
    indicativo
    
    See Also:
    
    hasString(String)
  - getObjectString
```
public final String getObjectString(Object object,
                                    String key)
```
    Retorna uma string de idioma, com base em um objeto.
    
    Parameters:
    
    object - o objeto.
    
    key - a chave de busca.
    
    Returns:
    
    indicativo
    
    See Also:
    
    getString(String)
  - getObjectString
```
public final String getObjectString(Object object,
                                    String key,
                                    Object... args)
```
    Retorna uma string de idioma, com base em um objeto.
    
    Parameters:
    
    object - o objeto.
    
    key - a chave de busca.
    
    args - argumentos
    
    Returns:
    
    indicativo
    
    See Also:
    
    getString(String, Object[])
  - hasString
```
public final boolean hasString(String key)
```
    Consulta da existência de uma string de idioma.
    
    Parameters:
    
    key - a chave de busca.
    
    Returns:
    
    o texto no idioma correto.
  - getString
```
public final String getString(String key)
```
    Obtem uma string de idioma.
    
    Parameters:
    
    key - a chave de busca.
    
    Returns:
    
    o texto no idioma correto.
    
    See Also:
    
    propResBundle
  - getString
```
public final String getString(String key,
                              Object[] objs)
```
    Obtem uma string de idioma.
    
    Parameters:
    
    key - a chave de busca.
    
    objs - os objetos de formatação
    
    Returns:
    
    o texto no idioma correto.
    
    See Also:
    
    propResBundle
  - isShownAtApplicationMenu
```
public final boolean isShownAtApplicationMenu()
```
    Consulta se aplicação aparece em menu.
    
    Returns:
    
    um flag indicativo.
  - isShownAtApplicationPanel
```
public final boolean isShownAtApplicationPanel()
```
    Consulta se aplicação aparece no app-panel
    
    Returns:
    
    um flag indicativo.
  - requireProject
```
public final boolean requireProject()
```
    Consulta se aplicação necessita de projeto.
    
    Returns:
    
    um flag indicativo.
  - mainFrameIsVisible
```
public final boolean mainFrameIsVisible()
```
    Consulta se a frame da aplicação deve ficar visível.
    
    Returns:
    
    um flag indicativo.
  - getId
```
public final String getId()
```
    Obtém o id da aplicação.
    
    Returns:
    
    o id com uma string.
    
    See Also:
    
    id
  - getResourceBundle
```
public final AppPropertyResourceBundle getResourceBundle()
```
    Obtém o resource bundle da aplicação
    
    Returns:
    
    o bundle
    
    See Also:
    
    propResBundle
  - getClassName
```
public final String getClassName()
```
    Obtém a classe da aplicação.
    
    Returns:
    
    o nome da classe.
  - getFileTypes
```
public final List<String> getFileTypes()
```
    Obtém os tipos de arquivo que abrem diretamente esta aplicação.
    
    Returns:
    
    os tipos de arquivo.
  - getApplicationCommand
```
public final String getApplicationCommand()
```
    Consulta ao comando da aplicação.
    
    Returns:
    
    um texto com a string.
  - getApplicationCommandDir
```
public final String getApplicationCommandDir()
```
    Consulta ao diretório onde está o comando da aplicação.
    
    Returns:
    
    o diretório onde está o comando da aplicação
  - isEnabled
```
public final boolean isEnabled()
```
    Consulta a habilitação do aplicativo.
    
    Returns:
    
    um flag booleano indicativo.
    
    See Also:
    
    isEnabled()
  - getClasspath
```
public final List<String> getClasspath()
```
    Consulta a lista de bibliotecas do classpath da aplicação.
    
    Returns:
    
    a lista de bibliotecas (jars, zips) da aplicação.
  - isRunnable
```
public final boolean isRunnable()
```
    Indica se a aplicação possui uma linha de comando e seu o comando foi encotrado no PATH do cliente.
    
    Returns:
    
    true se a aplicação pode ser executada
  - isSingleton
```
public final boolean isSingleton()
```
    Consulta se uma aplicação é "singleton"
    
    Returns:
    
    um indicativo
  - isPropertyNull
```
public final boolean isPropertyNull(String propName)
```
    Indicativo de propriedade sem valor.
    
    Parameters:
    
    propName - nome da propriedade.
    
    Returns:
    
    indicativo
  - closeConfiguration
```
public final void closeConfiguration()
                              throws ApplicationRegistryException
```
    Fecha as definições de um registry.
    
    Throws:
    
    ApplicationRegistryException - em caso de má configuração do servidor.
  - setClasspathBaseDir
```
public void setClasspathBaseDir(File baseDir)
```
    Ajusta o diretório base de onde buscar os arquivos declarados no classpath.
    
    Parameters:
    
    baseDir - o diretório base.
  - isBundleRequired
```
public final boolean isBundleRequired()
```
    Consulta de bundle é necessário.
    
    Returns:
    
    indicativo.
  - getStringListSpecificProperty
```
public final List<String> getStringListSpecificProperty(String name)
```
    Obtém uma lista de valores de propriedades que seguem o padrão para propriedades multi-valoradas usado pelo JDK da Sun.
    - propriedade.1=ABCD
    - propriedade.2=EFGH
    - propriedade.nome.1=ABCD
    - propriedade.nome.2=EFGH
    Parameters:
    
    name - O nome da propriedade (nos exemplos acima, seriam "propriedade" e "propriedade.nome" respectivamente).
    
    Returns:
    
    Uma lista com todas as propriedades (caso não existam propriedades, a lista estará vazia).
  - getImageDefinition
```
public final byte[] getImageDefinition()
```
    Busca da imagem configurada para a aplicação.
    
    Returns:
    
    a imagem
  - getIconDefinition
```
public final byte[] getIconDefinition()
```
    Busca do ícone configurada para a aplicação.
    
    Returns:
    
    a imagem
  - getAuthorMail
```
public final String getAuthorMail()
```
    Consulta ao email de contato.
    
    Returns:
    
    o email como string
  - getAuthorName
```
public final String getAuthorName()
```
    Consulta ao nome do autor do programa.
    
    Returns:
    
    o nome como string
  - getVersionNumber
```
public final int getVersionNumber()
```
    Consulta à versão do programa
    
    Returns:
    
    a versão como número
    
    See Also:
    
    getVersionNumber(String)
  - getVersion
```
public final String getVersion()
```
    Consulta à versão do programa
    
    Returns:
    
    a versão como string
  - getIntSpecificProperty
```
public final int getIntSpecificProperty(String propName)
```
    Obtém uma propriedade específica do tipo inteiro.
    
    Parameters:
    
    propName - nome da propriedade.
    
    Returns:
    
    propriedade específica do tipo inteiro.
    
    Throws:
    
    IllegalStateException - se a propriedade não foi definida ou se o valor não pode ser convertido para um número inteiro
  - getLongSpecificProperty
```
public final long getLongSpecificProperty(String propName)
```
    Obtém uma propriedade específica do tipo long.
    
    Parameters:
    
    propName - nome da propriedade.
    
    Returns:
    
    propriedade específica do tipo long.
    
    Throws:
    
    IllegalStateException - se a propriedade não foi definida ou se o valor não pode ser convertido para um número long
  - getBooleanSpecificProperty
```
public final boolean getBooleanSpecificProperty(String propName)
```
    Obtém uma propriedade específica do tipo booleana.
    
    Parameters:
    
    propName - nome da propriedade.
    
    Returns:
    
    propriedade específica do tipo booleana.
  - getStringSpecificProperty
```
public final String getStringSpecificProperty(String propName)
```
    Obtém uma propriedade específica.
    
    Parameters:
    
    propName - nome da propriedade.
    
    Returns:
    
    propriedade específica.
    
    Throws:
    
    IllegalStateException - se a propriedade não foi definida
  - getDoubleSpecificProperty
```
public final double getDoubleSpecificProperty(String propName)
```
    Obtém uma propriedade específica do tipo double.
    
    Parameters:
    
    propName - nome da propriedade.
    
    Returns:
    
    propriedade específica do tipo double.
    
    Throws:
    
    IllegalStateException - se a propriedade não foi definida ou se o valor não pode ser convertido para um número double.
  - getSpecificProperties
```
public final Properties getSpecificProperties()
```
    Consulta ao conunto propriedades específicas.
    
    Returns:
    
    conjunto.
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object
  - getApplicationName
```
public final String getApplicationName(Locale locale)
```
    Consulta o nome de uma aplicação.
    
    Parameters:
    
    locale - locale.
    
    Returns:
    
    o nome
  - getApplicationDescription
```
public final String getApplicationDescription(Locale locale)
```
    Consulta o nome de uma aplicação.
    
    Parameters:
    
    locale - locale.
    
    Returns:
    
    o nome
  - setIconDefinition
```
public final void setIconDefinition(byte[] img16)
```
    Ajuste de icone de aplicação.
    
    Parameters:
    
    img16 - imagem
  - setImageDefinition
```
public final void setImageDefinition(byte[] img32)
```
    Ajuste de imagem de aplicação.
    
    Parameters:
    
    img32 - imagem
  - setSpecificProperties
```
public final void setSpecificProperties(Properties prop)
```
    Ajusta properties da aplicação.
    
    Parameters:
    
    prop - propriedade a ser ajustada.
  - setClassLoaderWhiteList
```
public final void setClassLoaderWhiteList(List<Pattern> whiteList)
```
    Define a lista com os padrões de nome que determina que uma classe pode ser carregada no classloader da aplicação (além das que são declaradas no classpath da aplicação).
    
    Parameters:
    
    whiteList - a lista.
  - setClassLoaderBlackList
```
public final void setClassLoaderBlackList(List<Pattern> blackList)
```
    Define a lista com os padrões de nome que determina que uma classe *não* pode ser carregada no classloader da aplicação (além das que são declaradas no classpath da aplicação).
    
    Parameters:
    
    blackList - a lista.
  - getClassLoaderWhiteList
```
public List<Pattern> getClassLoaderWhiteList()
```
    Obtém a lista com os padrões de nome que determina que uma classe pode ser carregada no classloader da aplicação (além das que são declaradas no classpath da aplicação).
    
    Returns:
    
    a lista.
  - getClassLoaderBlackList
```
public List<Pattern> getClassLoaderBlackList()
```
    Obtém a lista com os padrões de nome que determina que uma classe *não* pode ser carregada no classloader da aplicação (além das que são declaradas no classpath da aplicação).
    
    Returns:
    
    a lista.
  - getTimestamp
```
public final long getTimestamp()
```
    Retorna o timestamp desse registro no servidor. Essa informação pode ser utilizada para verificar se a aplicação foi atualizada no servidor.
    
    Returns:
    
    o timestamp.
  - getApplicationLibs
```
public FileInfo[] getApplicationLibs()
```
    Obtém as bibliotecas da aplicação.
    
    Returns:
    
    Um conjunto de descritores de arquivo FileInfo das bibliotecas.

Class ApplicationRegistry

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ApplicationRegistry

Method Detail

setTranslationListener

getTranslationListener

loadClientBundles

loadServerBundles

loadURLBundles

hasClassString

getClassString

getClassString

hasObjectString

getObjectString

getObjectString

hasString

getString

getString

isShownAtApplicationMenu

isShownAtApplicationPanel

requireProject

mainFrameIsVisible

getId

getResourceBundle

getClassName

getFileTypes

getApplicationCommand

getApplicationCommandDir

isEnabled

getClasspath

isRunnable

isSingleton

isPropertyNull

closeConfiguration

setClasspathBaseDir

isBundleRequired

getStringListSpecificProperty

getImageDefinition

getIconDefinition

getAuthorMail

getAuthorName

getVersionNumber

getVersion

getIntSpecificProperty

getLongSpecificProperty

getBooleanSpecificProperty

getStringSpecificProperty

getDoubleSpecificProperty

getSpecificProperties

toString

getApplicationName

getApplicationDescription

setIconDefinition

setImageDefinition

setSpecificProperties

setClassLoaderWhiteList

setClassLoaderBlackList

getClassLoaderWhiteList

getClassLoaderBlackList

getTimestamp

getApplicationLibs