Service (csbase-server ERAS-1.0.0 API)

java.lang.Object
- csbase.remote.RemoteObjectObservable
- - csbase.server.ServerRemoteObjectObservable
  - - csbase.server.Service

All Implemented Interfaces:

csbase.remote.RemoteObservable, csbase.remote.RemoteObserverNotifierInterface, csbase.remote.ServiceInterface, csbase.server.plugin.service.IService, Remote

Direct Known Subclasses:

AdministrationService, AlgorithmService, ApplicationService, CommandPersistenceService, CSFSService, DBManagerService, DiagnosticService, DiskUsageService, EventLogService, FileTransferService, FTCService, HttpService, KillServerService, LogAdministrationService, LoginService, MailService, MessageService, NotificationService, OpenBusService, OpenDreamsService, OpenURLService, PluginService, ProjectService, ProjectSynchronizationService, RestService, SchedulerService, ServerService, SGAService, SharedObjectService, WIOService, XMLConversionService
```
public abstract class Service
extends ServerRemoteObjectObservable
implements csbase.remote.ServiceInterface, csbase.server.plugin.service.IService
```
Classe que implementa o framework para definição de um serviço. Nem todos os serviços são servidores RMI: os que precisam de validação de usuário são exportados por meio de proxies. Cada serviço tem recursos de log e um conjunto de propriedades específicos. Os nomes do arquivo de log e do arquivo de propriedades são construídos a partir do nome do serviço.

Author:

Tecgraf/PUC-Rio

Field Summary
- Fields inherited from class csbase.remote.RemoteObjectObservable
  observerManager

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Service(String srvName)` Construtor protegido da classe `Servico` que se encarrega de inicializar todas as funcionalidades de um serviço (log, propriedades etc).

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getBooleanProperty(String key)` Recupera uma propriedade do serviço, como um boolean.
`Locale`	`getDefaultLocale()` Retorno do locale padrão de internacionalização.
`double`	`getDoubleProperty(String key)` Recupera uma propriedade do serviço, como um double.
`Properties`	`getExternalPropertyFile(String key)` Obtém um conjunto de propriedades com base em um arquivo definido pela chave.
`String`	`getFormattedString(String key, 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).
`String`	`getFormattedString(String key, Object[] objects, Locale locale)` Traduz uma determinada chave na sua string formatada com base no locale.
`protected Service[]`	`getInitializationDependencies()` Obtém todos os serviços dos quais este serviço depende para a sua inicialização.
`static csbase.server.plugin.service.IService`	`getInstance(String serviceName)` Obtém a instância do serviço.
`int`	`getIntProperty(String key)` Recupera uma propriedade do serviço, como um int.
`static Object`	`getKey()` Esse método só pode ser chamado durante a execução de uma chamada remota.
`long`	`getLongProperty(String key)` Recupera uma propriedade do serviço, como um long.
`String`	`getName()` Informa o nome do serviço.
`String`	`getOptionalString(String key)` Traduz uma determinada chave na sua string inferindo o locale do usuário (thread) que originou a chamada (será usado um locale padrão se houver falha nesta identificação).
`String`	`getOptionalString(String key, Locale locale)` Traduz uma determinada chave na sua string correspondente de acordo com o locale desejado.
`protected String`	`getOSPropertyPath(String propertyPath)` Obtém o formato de caminho adequado para o sistema operacional em uso, a partir de 3 tipos possíveis de formatos de propriedades indicando caminhos para arquivos: Formato Unix relativo: os separadores "/" serão substituídos por `File.separator` (recomendado) Formato Unix absoluto: o caminho será retornado sem alterações e só funcionará em sistemas UNIX-LIKE Outros formatos: o caminho será retornado sem alterações e só é garantido de funcionar no sistema para o qual foi criado
`String`	`getSenderName()` Informa o nome de serviço para ser usado como remetente no envio de notificações aos usuários.
`static Map<String,Service>`	`getServices()` Método para obtenção de todos os serviços.
`String`	`getString(String key)` Traduz uma determinada chave na sua string inferindo o locale do usuário (thread) que originou a chamada (será usado um locale padrão se houver falha nesta identificação).
`String`	`getString(String key, Locale locale)` Traduz uma determinada chave na sua string correspondente de acordo com o locale desejado.
`List<String>`	`getStringListProperty(String key)` Recupera uma propriedade da aplicação (lista).
`String`	`getStringProperty(String key)` Obtém uma propriedade do serviço, como uma string.
`static String`	`getSystemId()` Obtém a string que identifica o sistema onde o usuário da sessão atual originou a chamada remota.
`protected Locale`	`getThreadLocale()` Consulta do locale da thread.
`static csbase.logic.User`	`getUser()` Este método retorna o usuário que realizou a chamada a um método de um serviço.
`protected <T extends csbase.logic.Permission> T`	`getUserPermission(Class<T> permissionClass)` Obtém uma determinada permissão para o usuário que realizou a chamada ao método no serviço.
`boolean`	`hasProperty(String propertyKey)` Verifica se existe uma propriedade no serviço com o nome passado como parâmetro.
`protected <T> void`	`incrCounter(Map<T,Integer> counter, T key)` Incrementa um contador de um mapa que associa chaves a contadores.
`protected abstract void`	`initService()` Método abstrato de inicialização do serviço.
`boolean`	`isActive()` Verifica se o serviço está ativo.
`boolean`	`isEnabled()` Verifica se o serviço está habilitado.
`static boolean`	`isInternalServerRequest()` Indica se a thread que originou a chamada deste método veio internamente do servidor.
`boolean`	`isLoggingNotifications()`
`boolean`	`isPropertyNull(String key)` Verifica se uma propriedade foi definida como "não usada" ( `NULL`).
`void`	`logNotification(String msg)`
`protected void`	`setEnabled(boolean enabled)` Define se o serviço está habilitado.
`static void`	`setKey(Object key)` Guarda nos dados locais do thread corrente o identificador da sessão do usuário.
`static void`	`setSystemId(String systemId)` Guarda nos dados locais da thread corrente, a string que identifica o sistema onde o usuário da sessão atual originou a chamada remota.
`static void`	`setUserId(Object userId)` Guarda o usuário nos dados locais do thread corrente.
`static void`	`setUserLocale(Locale locale)` Guarda o locale do usuários nos dados locais do thread corrente.
`protected abstract void`	`shutdownService()` Método abstrato de término do serviço

Methods inherited from class csbase.server.ServerRemoteObjectObservable
handleException, handleFatalError

Methods inherited from class csbase.remote.RemoteObjectObservable
addObserver, countObservers, deleteObserver, deleteObserver, deleteObservers, has2Update, has2update, notifyObservers

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

- Constructor Detail
  - Service
```
protected Service(String srvName)
           throws ServerException
```
    Construtor protegido da classe Servico que se encarrega de inicializar todas as funcionalidades de um serviço (log, propriedades etc).
    
    Parameters:
    
    srvName - nome no serviço
    
    Throws:
    
    ServerException - se houver erro na instanciação.
- Method Detail
  - setKey
```
public static void setKey(Object key)
```
    Guarda nos dados locais do thread corrente o identificador da sessão do usuário. Este método deve ser chamado pelos objetos remotos exportados pelo servidor antes de repassar a chamada ao respectivo serviço.
    
    Parameters:
    
    key - a chave a ser guardada.
  - setUserId
```
public static void setUserId(Object userId)
```
    Guarda o usuário nos dados locais do thread corrente. Este método é chamado quando a chamada de um método do serviço não é feito pelo proxy de um cliente, mas quando é feito, por exemplo, por outros serviços, ou pelo WIO.
    
    Parameters:
    
    userId - o identificador do usuário.
  - setUserLocale
```
public static void setUserLocale(Locale locale)
```
    Guarda o locale do usuários nos dados locais do thread corrente.
    
    Parameters:
    
    locale - o locale do usuário.
  - isInternalServerRequest
```
public static boolean isInternalServerRequest()
```
    Indica se a thread que originou a chamada deste método veio internamente do servidor.
    
    Returns:
    
    true quando a chamada a este método veio de uma thread interna do servidor. False quando a chamada é feita pelo cliente ou por outro servidor, ou seja, através dos proxies para os serviços.
  - getUser
```
public static final csbase.logic.User getUser()
```
    Este método retorna o usuário que realizou a chamada a um método de um serviço. Para esse mecanismo funcionar, quando este método é chamdo durante a execução de uma chamada remota, é preciso que cada objeto remoto exportado pelo servidor chame o setKey antes de repassar a chamada para o respectivo serviço. Quando este método é chamado a partir de outro serviço, para funcionar, o método setUser deve ser chamado antes de fazer chamadas para o serviço.
    
    Returns:
    
    o usuário registrado.
  - getKey
```
public static final Object getKey()
```
    Esse método só pode ser chamado durante a execução de uma chamada remota. Nessa situação, este método retorna o usuário que realizou a chamada. Para esse mecanismo funcionar, é preciso que cada objeto remoto exportado pelo servidor chame o setKey antes de repassar a chamada para o respectivo serviço.
    
    Returns:
    
    a chave solicitada.
  - getDefaultLocale
```
public final Locale getDefaultLocale()
```
    Retorno do locale padrão de internacionalização.
    
    Returns:
    
    o locale.
  - getThreadLocale
```
protected final Locale getThreadLocale()
```
    Consulta do locale da thread.
    
    Returns:
    
    o locale ou null.
  - getUserPermission
```
protected final <T extends csbase.logic.Permission> T getUserPermission(Class<T> permissionClass)
```
    Obtém uma determinada permissão para o usuário que realizou a chamada ao método no serviço.
    
    Type Parameters:
    
    T - Tipo de permissão.
    
    Parameters:
    
    permissionClass - classe que representa a permissão.
    
    Returns:
    
    uma instância da permissão.
  - getFormattedString
```
public final String getFormattedString(String key,
                                       Object[] objects,
                                       Locale locale)
```
    Traduz uma determinada chave na sua string formatada com base no locale.
    
    Parameters:
    
    key - chave do bundle.
    
    locale - o locale desejado para intercionalização.
    
    objects - array de objetos de formatação.
    
    Returns:
    
    string com o texto respectivo a chave.
  - getFormattedString
```
public final String getFormattedString(String key,
                                       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.
  - getString
```
public final String getString(String key)
```
    Traduz uma determinada chave na sua string 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.
    
    Returns:
    
    String com o texto respectivo a chave.
  - getOptionalString
```
public final String getOptionalString(String key)
```
    Traduz uma determinada chave na sua string inferindo o locale do usuário (thread) que originou a chamada (será usado um locale padrão se houver falha nesta identificação). Se a chave não estiver definida, retorna null. Nos demais casos de erro, uma string de erro é retornada.
    
    Parameters:
    
    key - chave do bundle.
    
    Returns:
    
    String com o texto respectivo a chave.
  - getString
```
public final String getString(String key,
                              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 intercionalização.
    
    Returns:
    
    String com o texto respectivo a chave.
  - getOptionalString
```
public final String getOptionalString(String key,
                                      Locale locale)
```
    Traduz uma determinada chave na sua string correspondente de acordo com o locale desejado. Se a chave não estiver definida, retorna null. Nos demais casos de erro, uma string de erro é retornada.
    
    Parameters:
    
    key - chave do bundle.
    
    locale - o locale desejado para intercionalização.
    
    Returns:
    
    String com o texto respectivo a chave.
  - isPropertyNull
```
public final boolean isPropertyNull(String key)
```
    Verifica se uma propriedade foi definida como "não usada" ( NULL).
    
    Parameters:
    
    key - a identificação da propriedade, sem o prefixo da classe
    
    Returns:
    
    indicativo
  - getExternalPropertyFile
```
public final Properties getExternalPropertyFile(String key)
```
    Obtém um conjunto de propriedades com base em um arquivo definido pela chave.
    
    Parameters:
    
    key - o nome da propriedade, sem o prefixo da classe
    
    Returns:
    
    o o conjunto da propriedade (que pode ser vazia, caso o arquivo não exista ou não esteja especificado).
  - getStringListProperty
```
public final List<String> getStringListProperty(String key)
```
    Recupera uma propriedade da aplicação (lista). Caso a propriedade tenha sido redefinida no arquivo de configuação do servidor, este valor será retornado.
    
    Parameters:
    
    key - o nome da propriedade, sem o prefixo da classe e sem o sufixo ".1", ".2" etc.
    
    Returns:
    
    os valores em forma de lista de strings.
    
    Throws:
    
    IllegalStateException - se a propriedade não estiver setada.
  - getStringProperty
```
public final String getStringProperty(String key)
```
    Obtém uma propriedade do serviço, como uma string. Caso a propriedade tenha sido redefinida no arquivo de configuação do servidor, este valor será retornado.
    
    Parameters:
    
    key - o nome da propriedade, sem o prefixo da classe
    
    Returns:
    
    o valor da propriedade como uma string
    
    Throws:
    
    IllegalStateException - se a propriedade não estiver setada.
  - getDoubleProperty
```
public final double getDoubleProperty(String key)
```
    Recupera uma propriedade do serviço, como um double. Caso a propriedade tenha sido redefinida no arquivo de configuação do servidor, este valor será retornado.
    
    Parameters:
    
    key - o nome da propriedade, sem o prefixo da classe
    
    Returns:
    
    o valor como um double
    
    Throws:
    
    IllegalStateException - se a propriedade não estiver setada.
  - getIntProperty
```
public final int getIntProperty(String key)
```
    Recupera uma propriedade do serviço, como um int. Caso a propriedade tenha sido redefinida no arquivo de configuação do servidor, este valor será retornado.
    
    Parameters:
    
    key - o nome da propriedade, sem o prefixo da classe
    
    Returns:
    
    o valor como um inteiro
    
    Throws:
    
    IllegalStateException - se a propriedade não estiver setada.
  - getLongProperty
```
public final long getLongProperty(String key)
```
    Recupera uma propriedade do serviço, como um long. Caso a propriedade tenha sido redefinida no arquivo de configuação do servidor, este valor será retornado.
    
    Parameters:
    
    key - o nome da propriedade, sem o prefixo da classe
    
    Returns:
    
    o valor como um long
    
    Throws:
    
    IllegalStateException - se a propriedade não estiver setada.
  - getBooleanProperty
```
public final boolean getBooleanProperty(String key)
```
    Recupera uma propriedade do serviço, como um boolean. Caso a propriedade tenha sido redefinida no arquivo de configuação do servidor, este valor será retornado.
    
    Parameters:
    
    key - o nome da propriedade, sem o prefixo da classe
    
    Returns:
    
    o valor como um boolean
    
    Throws:
    
    IllegalStateException - se a propriedade não estiver setada.
  - getOSPropertyPath
```
protected final String getOSPropertyPath(String propertyPath)
```
    Obtém o formato de caminho adequado para o sistema operacional em uso, a partir de 3 tipos possíveis de formatos de propriedades indicando caminhos para arquivos:
    1. Formato Unix relativo: os separadores "/" serão substituídos por File.separator (recomendado)
    2. Formato Unix absoluto: o caminho será retornado sem alterações e só funcionará em sistemas UNIX-LIKE
    3. Outros formatos: o caminho será retornado sem alterações e só é garantido de funcionar no sistema para o qual foi criado
    Parameters:
    
    propertyPath - caminho para um arquivo.
    
    Returns:
    
    caminho no formato do S.O. corrente (usando File.separator) para caminhos Unix relativos; retorna o caminho original caso este esteja em outros formatos.
  - getName
```
public final String getName()
```
    Informa o nome do serviço.
    
    Specified by:
    
    getName in interface csbase.remote.ServiceInterface
    
    Returns:
    
    o nome do serviço.
  - getSenderName
```
public String getSenderName()
```
    Informa o nome de serviço para ser usado como remetente no envio de notificações aos usuários.
    
    Returns:
    
    O nome do serviço a ser usado como remetente.
  - isLoggingNotifications
```
public boolean isLoggingNotifications()
```
    Specified by:
    
    isLoggingNotifications in interface csbase.remote.RemoteObserverNotifierInterface
  - logNotification
```
public void logNotification(String msg)
```
    Specified by:
    
    logNotification in interface csbase.remote.RemoteObserverNotifierInterface
  - getServices
```
public static Map<String,Service> getServices()
```
    Método para obtenção de todos os serviços.
    
    Returns:
    
    Hashtable com as referências para todos os serviços.
  - isActive
```
public boolean isActive()
```
    Verifica se o serviço está ativo.
    
    Specified by:
    
    isActive in interface csbase.remote.ServiceInterface
    
    Returns:
    
    um flag booleano indicativo.
  - isEnabled
```
public final boolean isEnabled()
```
    Verifica se o serviço está habilitado.
    
    Returns:
    
    true caso o serviço esteja habilitado, ou false, caso contrário.
  - setEnabled
```
protected final void setEnabled(boolean enabled)
```
    Define se o serviço está habilitado.
    
    Parameters:
    
    enabled - Indica se o serviço deve ser habilitado.
  - getInstance
```
public static csbase.server.plugin.service.IService getInstance(String serviceName)
```
    Obtém a instância do serviço.
    
    Parameters:
    
    serviceName - o nome do serviço desejado.
    
    Returns:
    
    a instância.
  - setSystemId
```
public static void setSystemId(String systemId)
```
    Guarda nos dados locais da thread corrente, a string que identifica o sistema onde o usuário da sessão atual originou a chamada remota. Este método é chamado quando a chamada de um método do serviço não é feito pelo proxy de um cliente, mas quando é feito, por exemplo, por outros serviços. Um exemplo de atribuição a essa variável, por exemplo, temos quando há uma execução de um comando do sistema atual, feita via o serviço OpenDreams. Nesse caso, o serviço OpenDreams deve garantir que a atribuição do sistema em que a chamada remota foi originada seja feita na thread do serviço, para futura checagem de permissão para realizar essa operação.
    
    Parameters:
    
    systemId - o identificador (string) do sistema
  - getSystemId
```
public static final String getSystemId()
```
    Obtém a string que identifica o sistema onde o usuário da sessão atual originou a chamada remota. Se a variável de sistema não foi inicializada, então o valor retornado é null. Para esse mecanismo funcionar, quando este método é chamado a partir de outro serviço, o método setSystemId deve ter sido chamado antes de fazer chamadas para o serviço.
    
    Returns:
    
    o identificado (string) do sistema que originou a chamada remota, ou retorna null caso a variável que indica o sistema não tenha sido atualizada
  - getInitializationDependencies
```
protected Service[] getInitializationDependencies()
```
    Obtém todos os serviços dos quais este serviço depende para a sua inicialização.
    
    Returns:
    
    Os serviços dos quais este serviço depende.
  - initService
```
protected abstract void initService()
                             throws ServerException
```
    Método abstrato de inicialização do serviço.
    
    Throws:
    
    ServerException - em caso de falha
  - shutdownService
```
protected abstract void shutdownService()
                                 throws ServerException
```
    Método abstrato de término do serviço
    
    Throws:
    
    ServerException - em caso de falha.
  - incrCounter
```
protected <T> void incrCounter(Map<T,Integer> counter,
                               T key)
```
    Incrementa um contador de um mapa que associa chaves a contadores.
    
    Type Parameters:
    
    T - tipo das chaves do mapa
    
    Parameters:
    
    counter - mapa de contadores
    
    key - chave a ter seu contador incrementado
  - hasProperty
```
public boolean hasProperty(String propertyKey)
```
    Verifica se existe uma propriedade no serviço com o nome passado como parâmetro.
    
    Parameters:
    
    propertyKey - a chave da propriedade a ser verificada
    
    Returns:
    
    true se existe uma propriedade no serviço com a chave indicada ou false se não for encontrada uma propriedade com essa chave.

Class Service

Field Summary

Fields inherited from class csbase.remote.RemoteObjectObservable

Constructor Summary

Method Summary

Methods inherited from class csbase.server.ServerRemoteObjectObservable

Methods inherited from class csbase.remote.RemoteObjectObservable

Methods inherited from class java.lang.Object

Constructor Detail

Service

Method Detail

setKey

setUserId

setUserLocale

isInternalServerRequest

getUser

getKey

getDefaultLocale

getThreadLocale

getUserPermission

getFormattedString

getFormattedString

getString

getOptionalString

getString

getOptionalString

isPropertyNull

getExternalPropertyFile

getStringListProperty

getStringProperty

getDoubleProperty

getIntProperty

getLongProperty

getBooleanProperty

getOSPropertyPath

getName

getSenderName

isLoggingNotifications

logNotification

getServices

isActive

isEnabled

setEnabled

getInstance

setSystemId

getSystemId

getInitializationDependencies

initService

shutdownService

incrCounter

hasProperty