validations

Class UserMail2EmailsValidation

java.lang.Object

validations.AbstractValidation

validations.UserMail2EmailsValidation

public class UserMail2EmailsValidation
extends AbstractValidation

Percorrer os arquivos de persistência do usuário substituindo a propriedade que armazena o e-mail do usuário pela propriedade User.EMAILS que tem como valor um array de e-mails do usuário.
Durante esse processo, caso o valor da propriedade seja diferente de null, ele será incluído no array de e-mails.
Obs. Esse validador irá executar apenas uma vez.

Esse validador é uma consequência da issue [CSBASE-2016][CSBASE] Permitir que usuários possam cadastrar mais de um email no sistema.

Author:

Tecgraf

Nested Class Summary

Nested classes/interfaces inherited from class validations.AbstractValidation

AbstractValidation.Status

Field Summary

Fields inherited from class validations.AbstractValidation

logger, RESOURCE_DIR_NAME

Constructor Summary

Constructors

Constructor and Description
UserMail2EmailsValidation()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	applyPatch() Aplica as correções.
protected boolean	backupData() Faz backup dos dados que serão alterados.
protected void	finish() Finalização do processo.
protected void	getSpecificFailureMessage(AbstractValidation.Status status, java.util.List<java.lang.String> errors) Obtém mensagens exibidas quando ocorre algum erro que não é genérico.
protected java.lang.String	getStartMessage() Obtém o texto exibido no início do processamento da validação.
protected java.lang.String	getSuccessMessage(AbstractValidation.Status status) Obtém a mensagem exibida quando a conversão é bem sucedida.
protected boolean	init() Inicialização.
protected boolean	restoreBackup() Desfaz as alterações, restaurando os backups feitos por AbstractValidation.backupData().
protected boolean	runsOnlyOnce() Indica se a validação só precisa ser executada com sucesso uma única vez.
protected boolean	validate() Valida o sistema, sem efetuar nenhuma alteração.

Methods inherited from class validations.AbstractValidation

getAlgorithmDir, getBackupDirPath, getMandatorySystemProperty, getProjectDir, getStatus, getSystemProperty, getTempDirPath, isValidatingOnly, isVerbose, removeBackupDir, rollback, run

Methods inherited from class java.lang.Object

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

Constructor Detail

UserMail2EmailsValidation

public UserMail2EmailsValidation()

Method Detail

init

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

Specified by:

init in class AbstractValidation

Returns:

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

See Also:

AbstractValidation.run(Validator)

getStartMessage

protected java.lang.String getStartMessage()

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

Specified by:

getStartMessage in class AbstractValidation

Returns:

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

getSpecificFailureMessage

protected void getSpecificFailureMessage(AbstractValidation.Status status,
                             java.util.List<java.lang.String> errors)

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

Specified by:

getSpecificFailureMessage in class AbstractValidation

Parameters:

status - status da validação

errors - lista a ser preenchida com as mensagens de erro

See Also:

AbstractValidation.getFailureMessage()

getSuccessMessage

protected java.lang.String getSuccessMessage(AbstractValidation.Status status)

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

Specified by:

getSuccessMessage in class AbstractValidation

Parameters:

status - status da validação

Returns:

mensagem exibida quando a validação bem sucedida

backupData

protected boolean backupData()

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

Specified by:

backupData in class AbstractValidation

Returns:

true se o backup foi realizado com sucesso

See Also:

Validator, AbstractValidation.applyPatch()

restoreBackup

protected boolean restoreBackup()

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

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

Specified by:

restoreBackup in class AbstractValidation

Returns:

true se a restauração foi bem-sucedida

validate

protected boolean validate()

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

Specified by:

validate in class AbstractValidation

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

See Also:

Validator, AbstractValidation.applyPatch()

applyPatch

protected boolean applyPatch()

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

Specified by:

applyPatch in class AbstractValidation

Returns:

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

finish

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

Specified by:

finish in class AbstractValidation

See Also:

AbstractValidation.status

runsOnlyOnce

protected boolean runsOnlyOnce()

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

Specified by:

runsOnlyOnce in class AbstractValidation

Returns:

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