validations

Class AbstractValidation

java.lang.Object

validations.AbstractValidation

Direct Known Subclasses:

PersistencyMoveValidation, PrjInfoValidation, PrjLockedInfoValidation, PrjPermsValidation, TrustedServer2ServerInfoValidation, UserMail2EmailsValidation, WallTimePropertyValidation

public abstract class AbstractValidation
extends Object

Validação abstrata. Define o comportamento geral de uma validação, mas delega para as subclasses concretas a implementação de etapas específicas.

See Also:

Validator, ValidatorUtils

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractValidation.Status Estados da validação/correção.

Field Summary

Fields

Modifier and Type	Field and Description
protected ValidationsLogger	logger Logger para registro de mensagens.
protected static String	RESOURCE_DIR_NAME Diretório de recursos dos validadores.

Constructor Summary

Constructors

Constructor and Description
AbstractValidation()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract boolean	applyPatch() Aplica as correções.
protected abstract boolean	backupData() Faz backup dos dados que serão alterados.
protected abstract void	finish() Finalização do processo.
File	getAlgorithmDir() Retorna o repositório de algoritmos.
protected String	getBackupDirPath() Obtém o path para o diretório onde serão armazenados os backups.
protected String	getMandatorySystemProperty(String propName) Retorna o valor associado a uma propriedade do sistema.
File	getProjectDir() Retorna o repositório de projetos.
protected abstract void	getSpecificFailureMessage(AbstractValidation.Status inputStatus, List<String> errors) Obtém mensagens exibidas quando ocorre algum erro que não é genérico.
protected abstract String	getStartMessage() Obtém o texto exibido no início do processamento da validação.
AbstractValidation.Status	getStatus() Obtém o status da validação.
protected abstract String	getSuccessMessage(AbstractValidation.Status inputStatus) Obtém a mensagem exibida quando a conversão é bem sucedida.
protected String	getSystemProperty(String propName) Retorna o valor associado a uma propriedade do sistema, ou null caso esta não exista.
protected String	getTempDirPath() Obtém o path para o diretório temporário da instalação.
protected abstract boolean	init() Inicialização.
protected boolean	isValidatingOnly() Verifica se estamos apenas validando (i.e. não devemos nem tentar corrigir).
protected boolean	isVerbose() Verifica se estamos em modo verbose.
boolean	removeBackupDir() Remove o diretório de backups desta validação.
protected abstract boolean	restoreBackup() Desfaz as alterações, restaurando os backups feitos por backupData().
boolean	rollback() Desfaz as alterações efetuadas por esta validação (apenas se a validação está em um estado reversível).
boolean	run(Validator validator) Executa a validação (e, opcionalmente, as correções).
protected abstract boolean	runsOnlyOnce() Indica se a validação só precisa ser executada com sucesso uma única vez.
protected abstract boolean	validate() Valida o sistema, sem efetuar nenhuma alteração.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE_DIR_NAME

protected static final String RESOURCE_DIR_NAME

Diretório de recursos dos validadores.

See Also:

Constant Field Values

logger

protected ValidationsLogger logger

Logger para registro de mensagens.

Constructor Detail

AbstractValidation

public AbstractValidation()

Method Detail

init

protected abstract boolean init()

Inicialização. Este método deve fazer as inicializações necessárias à execução da validação, mas não deve implementar nenhum processamento.

Returns:

flag indicando se a inicialização foi bem sucedida. Caso não seja, interrompe o processo.

See Also:

run(Validator)

getStartMessage

protected abstract String getStartMessage()

Obtém o texto exibido no início do processamento da validação.

Returns:

texto exibido no início do processamento da validação. Pode ser null.

runsOnlyOnce

protected abstract boolean runsOnlyOnce()

Indica se a validação só precisa ser executada com sucesso uma única vez.

Returns:

true se a validação só precisa ser executada com sucesso uma única vez

getSpecificFailureMessage

protected abstract void getSpecificFailureMessage(AbstractValidation.Status inputStatus,
                             List<String> errors)

Obtém mensagens exibidas quando ocorre algum erro que não é genérico.

Parameters:

inputStatus - status da validação

errors - lista a ser preenchida com as mensagens de erro

See Also:

getFailureMessage()

getSuccessMessage

protected abstract String getSuccessMessage(AbstractValidation.Status inputStatus)

Obtém a mensagem exibida quando a conversão é bem sucedida.

Parameters:

inputStatus - status da validação

Returns:

mensagem exibida quando a validação bem sucedida

validate

protected abstract boolean validate()
                             throws validations.ValidationException

Valida o sistema, sem efetuar nenhuma alteração.

Returns:

true se a validação foi bem sucedida, i.e. se não é necessário aplicar uma conversão. Este método deve retornar false apenas se a execução transcorreu sem problemas, e foi detectado que é necessário aplicar uma conversão. Exceções e outros erros que impeçam a execução da validação devem ser sinalizados via ValidationException

Throws:

ValidationException - se houve um erro não previsto durante a validação

See Also:

Validator, applyPatch()

backupData

protected abstract boolean backupData()

Faz backup dos dados que serão alterados. É executado pelo validador antes da aplicação do patch.

Returns:

true se o backup foi realizado com sucesso

See Also:

Validator, applyPatch()

restoreBackup

protected abstract boolean restoreBackup()

Desfaz as alterações, restaurando os backups feitos por backupData(). É executado pelo validador quando applyPatch() retorna false.

IMPORTANTE: este método pode ser executado mesmo que o patch tenha sido bem-sucedido, caso um patch subsequente falhe.

Returns:

true se a restauração foi bem-sucedida

applyPatch

protected abstract boolean applyPatch()

Aplica as correções. Este método só é executado se tanto validate() quanto isValidatingOnly() retornaram false.

Returns:

true se as correções foram aplicadas com sucesso, false em caso contrário.

finish

protected abstract void finish()

Finalização do processo. Permite a exibição de mensagens customizadas etc. Este método é executado mesmo em caso de falha, portanto cabe a ele verificar o status da validação.

See Also:

status

getStatus

public AbstractValidation.Status getStatus()

Obtém o status da validação.

Returns:

status da validação

See Also:

AbstractValidation.Status

run

public final boolean run(Validator validator)

Executa a validação (e, opcionalmente, as correções).

Este método é responsável por:

• inicializar o validador
• fazer a validação (modo validação)
• aplicar correções (modo patch)

Parameters:

validator - referência para o validador, para obtenção de informações globais tais como o logger, se estamos apenas em modo validação etc.

Returns:

true se o processo foi bem-sucedido na íntegra

rollback

public final boolean rollback()

Desfaz as alterações efetuadas por esta validação (apenas se a validação está em um estado reversível).

Returns:

true se a restauração foi bem-sucedida

See Also:

restoreBackup(), AbstractValidation.Status.isReversibleOperation

getSystemProperty

protected final 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:

Validator.getSystemProperty(String), getMandatorySystemProperty(String)

getMandatorySystemProperty

protected final 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:

Validator.getMandatorySystemProperty(String), getSystemProperty(String)

getProjectDir

public File getProjectDir()

Retorna o repositório de projetos.

Returns:

repositório de projetos

getAlgorithmDir

public File getAlgorithmDir()

Retorna o repositório de algoritmos.

Returns:

repositório de algoritmos

getTempDirPath

protected final 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

getBackupDirPath

protected final String getBackupDirPath()

Obtém o path para o diretório onde serão armazenados os backups.

Returns:

path para o diretório onde serão armazenados os backups

isValidatingOnly

protected final boolean isValidatingOnly()

Verifica se estamos apenas validando (i.e. não devemos nem tentar corrigir).

Returns:

true se estamos apenas validando

isVerbose

protected final boolean isVerbose()

Verifica se estamos em modo verbose.

Returns:

true se estamos em modo verbose

removeBackupDir

public boolean removeBackupDir()

Remove o diretório de backups desta validação.

Returns:

true se a operação foi bem sucedida