Validator (csbase-validations 3.1.0 API)

java.lang.Object
- validations.Validator

```
public class Validator
extends Object
```
Classe que executa validações sobre uma instalação do sistema. Todas as subclasses de AbstractValidation implementadas no pacote validations do CSBase e no pacote validations_sys do projeto serão automaticamente executadas. Os parâmetros da linha de comando são processados e definem a configuração de alguns parâmetros da execução que podem ser consultados pelas validações. O único parâmetro obrigatório é o path para o arquivo que contém as propriedades globais definidas para a instalação em questão do sistema. Deste arquivo são extraídas propriedades obrigatórias para o processo de validação:
- ProjectService.baseProjectDir path para o diretório project do CSBase. Pode ser absoluto ou relativo ao diretório onde se encontra o arquivo de propriedades.
- Validator.tempDir path para o diretório temporário onde serão criados os backups e onde será armazenado o log da validação ( validacoes.log).
Além das propriedades obrigatórias, existem algumas propriedades opcionais que podem ser usadas para ajustes finos:
- Validator.logPath path para o log da validação.
As validações recebem o validador como parâmetro e podem usá-lo p.ex. para consultar as propriedades lidas do arquivo de propriedades. Um logger específico é criado por default, para registro do processo tanto no console quanto no arquivo validacoes.log. O nível de logging para o arquivo é definido como Level.FINE enquanto que o nível default para o console é Level.INFO. As validações são instanciadas por reflexividade e ordenadas de acordo com seus nomes. Normalmente a ordem entre as validações não deve ser um fator relevante mas, caso seja, pode-se adotar uma política semelhante à usada para os scripts de inicialização UNIX (p.ex. Val05XXX, Val10YYY etc.). O validador pode ser executado em modo validação (parâmetro -V) ou em modo patch (default). No modo validação os backups não são criados, e nenhuma alteração é feita. No modo patch, caso a aplicação de um dos patches falhe, este e todos os demais aplicadas antes dele são desfeitos, na ordem inversa em que foram executados. Os diretórios de backup são removidos apenas em duas situações:
1. quando todos os patches foram aplicados com sucesso
2. quando algum patch falhou mas todos os rollbacks foram bem-sucedidos
Em todos os demais casos, os diretórios de backup são preservados para restauração "manual" dos dados alterados (que deve ser feita sob supervisão da equipe de desenvolvimento). As validações não são executadas se seus respectivos diretórios de backup não existem, i.e. uma tentativa de instalação que tenha sido mal-sucedida e tenha deixado para trás diretórios de backup impedirá instalações subsequentes até que o problema tenha sido corrigido e os diretórios de backup tenham sido removidos. Instalações bem sucedidas podem ser repetidas sem efeito colateral, i.e. patches aplicados com sucesso não serão aplicados novamente em instalações subsequentes.
Author:

Tecgraf

See Also:

processArgs(String[]), isValidatingOnly(), isVerbose(), getSystemProperty(String), getLogger(), rollback(AbstractValidation), run(), ValidationsLogger, AbstractValidation, ValidatorUtils

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SAMPLE_PROPERTIES_FILE` Nome do arquivo de exemplo com valores default para as configurações.
`static String`	`VALIDATIONS_TEMP_DIR` Chave para a propriedade que contém o path para o diretório temporário da instalação.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected File`	`getAlgorithmDir()` Retorna uma referência para o repositório de algoritmos do CSBase.
`ValidationsLogger`	`getLogger()` Obtém o logger.
`String`	`getMandatorySystemProperty(String propName)` Retorna o valor associado a uma propriedade do sistema.
`protected File`	`getProjectDir()` Retorna uma referência para o repositório de projetos do CSBase.
`String`	`getSystemProperty(String propName)` Retorna o valor associado a uma propriedade do sistema, ou `null` caso esta não exista.
`String`	`getTempDirPath()` Obtém o path para o diretório temporário da instalação.
`boolean`	`isValidatingOnly()` Verifica se estamos apenas validando (i.e.
`boolean`	`isVerbose()` Indica se estamos em modo verbose.
`static void`	`main(String[] args)` Método de entrada.

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

- Field Detail
  - VALIDATIONS_TEMP_DIR
```
public static final String VALIDATIONS_TEMP_DIR
```
    Chave para a propriedade que contém o path para o diretório temporário da instalação.
    
    See Also:
    
    Constant Field Values
  - SAMPLE_PROPERTIES_FILE
```
public static final String SAMPLE_PROPERTIES_FILE
```
    Nome do arquivo de exemplo com valores default para as configurações. Caso o usuário não forneça o path para o arquivo de propriedades, ele terá a chance de criar um arquivo de propriedades a partir deste.
- Method Detail
  - getProjectDir
```
protected final File getProjectDir()
```
    Retorna uma referência para o repositório de projetos do CSBase.
    
    Returns:
    
    a referência para o repositório de projetos.
  - getAlgorithmDir
```
protected final File getAlgorithmDir()
```
    Retorna uma referência para o repositório de algoritmos do CSBase.
    
    Returns:
    
    a referência para o repositório de algoritmos.
  - main
```
public static void main(String[] args)
```
    Método de entrada. Para cada execução, cria uma nova instância do validador e executa todas as validações.
    Se todas as validações forem aplicadas com sucesso, encerra a JVM com código 0, senão encerra com código 1.
    
    Parameters:
    
    args - - parâmetros da linha de comando
  - getTempDirPath
```
public String getTempDirPath()
```
    Obtém o path para o diretório temporário da instalação.
    
    Returns:
    
    path para o diretório temporário da instalação
  - getLogger
```
public ValidationsLogger getLogger()
```
    Obtém o logger.
    
    Returns:
    
    logger
  - getSystemProperty
```
public String getSystemProperty(String propName)
```
    Retorna o valor associado a uma propriedade do sistema, ou null caso esta não exista.
    
    Parameters:
    
    propName - nome da propriedade
    
    Returns:
    
    valor associado à propriedade do sistema, ou null caso esta não exista
    
    See Also:
    
    getMandatorySystemProperty(String)
  - getMandatorySystemProperty
```
public String getMandatorySystemProperty(String propName)
```
    Retorna o valor associado a uma propriedade do sistema. Caso esta não exista, sinaliza no log e retorna null.
    
    Parameters:
    
    propName - nome da propriedade
    
    Returns:
    
    valor associado à propriedade do sistema, ou null caso esta não exista
    
    See Also:
    
    getSystemProperty(String)
  - isValidatingOnly
```
public boolean isValidatingOnly()
```
    Verifica se estamos apenas validando (i.e. não será feito nenhum ajuste). As validações devem usar este método para configurar seu modo de operação.
    
    Returns:
    
    true se estamos apenas validando
  - isVerbose
```
public boolean isVerbose()
```
    Indica se estamos em modo verbose. As validações devem usar este método para configurar seu modo de operação.
    
    Returns:
    
    true se estamos em modo verbose

Class Validator

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VALIDATIONS_TEMP_DIR

SAMPLE_PROPERTIES_FILE

Method Detail

getProjectDir

getAlgorithmDir

main

getTempDirPath

getLogger

getSystemProperty

getMandatorySystemProperty

isValidatingOnly

isVerbose