csbase.server.services.commandpersistenceservice

Class CommandPropertyParser

java.lang.Object

csbase.server.services.commandpersistenceservice.CommandPropertyParser

public final class CommandPropertyParser
extends Object

Analisador para arquivos que descrevem as propriedades de um comando.

Esta classe é responsável por ler e escrever arquivos de propridades de comando. O arquivo de propriedades de comando é um arquivo properties padrão para Java com codificação .

Author:

Tecgraf/PUC-Rio

Constructor Summary

Constructors

Constructor and Description
CommandPropertyParser() Cria um analisador para ler ou escrever um arquivo com as propriedades do comando.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Lê a descrição do comando.
int	getExecutionCountForMultipleExecution() Lê o número de o número de execuções para a execução múltipla.
int	getExecutionCountPerSGAForMultipleExecution() Lê o número de o número de execuções por sga para a execução múltipla.
csbase.logic.algorithms.ExecutionType	getExecutionType() Lê o tipo de execução do comando.
protected Integer	getExitCode() Lê o identificador do nó responsável por erro na execução do fluxo (se houver).
protected csbase.logic.ExtendedCommandFinalizationInfo	getExtendedFinalizationInfo() Lê as propriedades que informam o estado finalização do comando.
protected csbase.logic.FailureFinalizationType	getFailureCause() Lê a propriedade que informa a causa da falha na finalização do comando.
csbase.logic.CommandFinalizationInfo	getFinalizationInfo() Lê as propriedades que informam o estado finalização do comando.
csbase.logic.CommandFinalizationInfo.FinalizationInfoType	getFinalizationInfoType() Lê a propriedade com o tipo de informação de finalização disponível para o comando.
protected csbase.logic.CommandFinalizationType	getFinalizationType() Lê a propriedade que informa o que levou o comando a terminar.
Integer	getGlobalPosition() Lê a posição do comando na fila do escalonador.
protected Integer	getGuiltyNodeId() Lê o código de saída do comando.
String	getId() Lê o identificador do comando.
boolean	getIsAutomatic() Lê se a seleção de sgas é automática.
boolean	getMailAtEnd() Lê se um email deve ser enviado ao usuário ao final da execução do comando.
String	getPlatformFilter() Lê a restrição de plataforma do comando.
csbase.logic.Priority	getPriority() Lê a prioridade de escalonamento do comando.
String	getSelectedSGAName() Lê um sga selecionado pelo usuário.
List<String>	getSelectedSGAsNames() Lê os sgas selecionados pelo usuário.
String	getSGAName() Lê o nome do SGA que executou o comando.
protected csbase.logic.CommandFinalizationInfo	getSimpleFinalizationInfo() Lê as propriedades que informam o estado finalização do comando.
csbase.logic.CommandStatus	getStatus() Lê a propriedade que informa o estado do comando.
Date	getSubmittedDate() Lê a data em que o comando foi iniciado.
String	getTip() Lê a descrição do algoritmo do comando.
String	getUserId() Lê o identificador do usuário que executou o comando.
Integer	getWallTimeSec() Lê o tempo total de execução do processo principal.
void	loadProperties(InputStream inputStream) Carrega uma lista de propriedades do stream de entrada.
void	saveProperties(OutputStream outputStream) Salva uma lista de propriedades no stream de saída.
void	setDescription(String description) Cria a propriedade que informa a descrição do comando e a anexa à lista de propriedades.
void	setExecutionCountForMultipleExecution(Integer executionCount) Cria a propriedade que informa o número de execuções para a execução múltipla e a anexa à lista de propriedades.
void	setExecutionCountPerSGAForMultipleExecution(Integer executionCount) Cria a propriedade que informa o número de execuções por sga para a execução múltipla e a anexa à lista de propriedades.
void	setExecutionType(csbase.logic.algorithms.ExecutionType executionType) Cria a propriedade que informa o tipo de execução do comando e a anexa à lista de propriedades.
protected void	setExitCode(Integer exitCode) Cria a propriedade que informa o código de saída do comando e a anexa à lista de propriedades.
protected void	setExtendedFinalizationInfo(csbase.logic.ExtendedCommandFinalizationInfo finalizationInfo) Cria as propriedades que informam sobre o estado de finalização do comando e as anexa à lista de propriedades.
void	setFailureCause(csbase.logic.FailureFinalizationType failureCause) Cria a propriedade que informa a causa da falha na finalização do comando e a anexa à lista de propriedades.
void	setFinalizationInfo(csbase.logic.CommandFinalizationInfo finalizationInfo) Cria as propriedades que informam sobre o estado de finalização do comando e as anexa à lista de propriedades.
protected void	setFinalizationInfoType(csbase.logic.CommandFinalizationInfo.FinalizationInfoType infoType) Cria a propriedade que informa o tipo de informação de finalização disponível para o comando e a anexa à lista de propriedades.
void	setFinalizationType(csbase.logic.CommandFinalizationType finalizationType) Cria a propriedade que informa o que levou o comando a terminar e a anexa à lista de propriedades.
void	setGlobalPosition(Integer globalPosition) Cria a propriedade que informa a posição do comando na fila do escalonador e a anexa à lista de propriedades.
protected void	setGuiltyNodeId(Integer nodeId) Cria a propriedade que identifica o nó responsável por erro na execução do fluxo (se houver).
void	setId(String id) Cria a propriedade que informa o identificador do comando e a anexa à lista de propriedades.
void	setIsAutomatic(boolean isAutomatic) Cria a propriedade que informa se a seleção de sgas é automática e a anexa à lista de propriedades.
void	setMailAtEnd(boolean mailAtEnd) Cria a propriedade que informa se um email deve ser enviado ao usuário ao final da execução do comando e a anexa à lista de propriedades.
void	setPlatformFilter(String platformFilter) Cria a propriedade que informa uma restrição de plataforma do comando e a anexa à lista de propriedades.
void	setPriority(csbase.logic.Priority priority) Cria a propriedade que informa a prioridade de escalonamento do comando e a anexa à lista de propriedades.
void	setSelectedSGAsNames(List<String> sgasNames) Cria a propriedade que informa os sgas selecionados e a anexa à lista de propriedades.
void	setSGAName(String sgaName) Cria a propriedade que informa o nome do SGA que executou o comando (se existir) e a anexa à lista de propriedades.
protected void	setSimpleFinalizationInfo(csbase.logic.CommandFinalizationInfo finalizationInfo) Cria as propriedades que informam sobre o estado de finalização do comando e as anexa à lista de propriedades.
void	setStatus(csbase.logic.CommandStatus status) Cria a propriedade que informa o estado do comando e a anexa à lista de propriedades.
void	setSubmittedDate(Date submittedDate) Cria a propriedade que informa a data e hora em que o comando foi submetido para execução e a anexa à lista de propriedades.
void	setTip(String tip) Cria a propriedade que informa a descrição do algoritmo e a anexa à lista de propriedades.
void	setUserId(Object userId) Cria a propriedade que informa o identificador do usuário que submeteu o comando para execução e a anexa à lista de propriedades.
void	setWallTimeSec(Integer wallTimeSec) Cria a propriedade que informa o tempo total de execução do processo principal e a anexa à lista de propriedades.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandPropertyParser

public CommandPropertyParser()

Cria um analisador para ler ou escrever um arquivo com as propriedades do comando. As propriedades ficam guardadas no analisador.

Method Detail

setExecutionCountForMultipleExecution

public void setExecutionCountForMultipleExecution(Integer executionCount)

Cria a propriedade que informa o número de execuções para a execução múltipla e a anexa à lista de propriedades. A chave é obrigatória quando o tipo de execução for múltipla e a selação de sgas for automática. Seu valor é o número de número de execuções que devem ser disparadas na execução do comando.

Parameters:

executionCount - O número de número de execuções que devem ser disparadas na execução do comando. (Não aceita null)

getExecutionCountForMultipleExecution

public int getExecutionCountForMultipleExecution()
                                          throws csbase.exception.ParseException

Lê o número de o número de execuções para a execução múltipla. Esta propriedade é obrigatória quando o tipo de execução for múltipla e a selação de sgas for automática.

Returns:

o número de o número de execuções para a execução múltipla.

Throws:

csbase.exception.ParseException - Em caso de erro no formato do número de execuções ou se a propriedade não existir.

setExecutionCountPerSGAForMultipleExecution

public void setExecutionCountPerSGAForMultipleExecution(Integer executionCount)

Cria a propriedade que informa o número de execuções por sga para a execução múltipla e a anexa à lista de propriedades. A chave é obrigatória quando o tipo de execução é múltipla e a seleção de sgas é manual. Seu valor é o número de execuções por sgas que devem ser disparadas na execução do comando.

Parameters:

executionCount - O número de execuções por sgas que devem ser disparadas na execução do comando. (Não aceita null)

getExecutionCountPerSGAForMultipleExecution

public int getExecutionCountPerSGAForMultipleExecution()
                                                throws csbase.exception.ParseException

Lê o número de o número de execuções por sga para a execução múltipla. Esta propriedade é obrigatória quando o tipo de execução é múltipla e a seleção de sgas é manual.

Returns:

o número de execuções por sga para a execução múltipla.

Throws:

csbase.exception.ParseException - Em caso de erro no formato do número de execuções por sga ou se a propriedade não existir.

setDescription

public void setDescription(String description)

Cria a propriedade que informa a descrição do comando e a anexa à lista de propriedades. A chave é opcional e o seu valor é a descrição do comando.

Parameters:

description - A descrição do comando. (Não aceita null)

getDescription

public String getDescription()

Lê a descrição do comando.

Returns:

A descrição do comando. Retorna null se ele não estiver nas propriedades do comando.

setExecutionType

public void setExecutionType(csbase.logic.algorithms.ExecutionType executionType)

Cria a propriedade que informa o tipo de execução do comando e a anexa à lista de propriedades. A chave é obrigatória e o seu valor é um nome que representa um ExecutionType .

Parameters:

executionType - O tipo de execução do comando (Não aceita null ).

getExecutionType

public csbase.logic.algorithms.ExecutionType getExecutionType()
                                                       throws csbase.exception.ParseException

Lê o tipo de execução do comando.

Returns:

o tipo de execução do comando ou ExecutionType#SIMPLE se a propriedade não existir.

Throws:

csbase.exception.ParseException - Em caso de erro no formato do tipo de execução.

setGlobalPosition

public void setGlobalPosition(Integer globalPosition)

Cria a propriedade que informa a posição do comando na fila do escalonador e a anexa à lista de propriedades. A chave é obrigatória e o seu valor é a posição do comando na fila do escalonador.

Parameters:

globalPosition - A posição do comando na fila do escalonador. (Não aceita null).

getGlobalPosition

public Integer getGlobalPosition()
                          throws csbase.exception.ParseException

Lê a posição do comando na fila do escalonador.

Returns:

a posição do comando na fila do escalonador ou se a propriedade não existir.

Throws:

csbase.exception.ParseException - Em caso de erro no formato da posição do comando.

setId

public void setId(String id)

Cria a propriedade que informa o identificador do comando e a anexa à lista de propriedades. A chave é obrigatória e o seu valor é o identificador do comando.

Parameters:

id - O identificador do comando. (Não aceita null).

getId

public String getId()
             throws csbase.exception.ParseException

Lê o identificador do comando. Esta propriedade é obrigatória.

Returns:

O identificador do comando.

Throws:

csbase.exception.ParseException - Se o identificador do comando não estiver nas propriedades.

setIsAutomatic

public void setIsAutomatic(boolean isAutomatic)

Cria a propriedade que informa se a seleção de sgas é automática e a anexa à lista de propriedades. A chave é obrigatória e o seu valor é verdadeiro caso a seleção seja automática ou falso caso contrário.

Parameters:

isAutomatic - verdadeiro caso a seleção seja automática ou falso caso contrário.

getIsAutomatic

public boolean getIsAutomatic()
                       throws csbase.exception.ParseException

Lê se a seleção de sgas é automática.

Returns:

verdadeiro caso a seleção seja automática ou falso caso contrário.

Throws:

csbase.exception.ParseException - Se a indicação de seleção de sgas não estiver no formato correto.

setMailAtEnd

public void setMailAtEnd(boolean mailAtEnd)

Cria a propriedade que informa se um email deve ser enviado ao usuário ao final da execução do comando e a anexa à lista de propriedades. A chave é obrigatória e o seu valor é verdadeiro caso o email deva ser enviado ou falso caso contrário.

Parameters:

mailAtEnd - verdadeiro caso o email deva ser enviado ou falso caso contrário.

getMailAtEnd

public boolean getMailAtEnd()
                     throws csbase.exception.ParseException

Lê se um email deve ser enviado ao usuário ao final da execução do comando.

Returns:

verdadeiro caso o email deva ser enviado ou falso caso contrário.

Throws:

csbase.exception.ParseException - Se a indicação de envio de email não estiver no formato correto.

setPlatformFilter

public void setPlatformFilter(String platformFilter)

Cria a propriedade que informa uma restrição de plataforma do comando e a anexa à lista de propriedades. A chave é opcional e o seu valor é a restrição de plataforma do comando.

Parameters:

platformFilter - A restrição de plataforma do comando. (Não aceita null)

getPlatformFilter

public String getPlatformFilter()

Lê a restrição de plataforma do comando.

Returns:

A restrição de plataforma do comando. Retorna null se ele não estiver nas propriedades do comando.

setPriority

public void setPriority(csbase.logic.Priority priority)

Cria a propriedade que informa a prioridade de escalonamento do comando e a anexa à lista de propriedades. A chave é obrigatória e o seu valor é um nome que representa um Priority.

Parameters:

priority - Um nome que representa um Priority. (Não aceita null).

getPriority

public csbase.logic.Priority getPriority()
                                  throws csbase.exception.ParseException

Lê a prioridade de escalonamento do comando.

Returns:

a prioridade de escalonamento do comando ou null se a propriedade não existir.

Throws:

csbase.exception.ParseException - Em caso de erro no formato da prioridade.

setSelectedSGAsNames

public void setSelectedSGAsNames(List<String> sgasNames)

Cria a propriedade que informa os sgas selecionados e a anexa à lista de propriedades. A chave é obrigatória quando a seleção de sgas for manual. Seu valor é uma lista com os sgas selecionados separados por vírgulas.

Parameters:

sgasNames - A lista de nomes dos sgas. (Não aceita null)

getSelectedSGAName

public String getSelectedSGAName()
                          throws csbase.exception.ParseException

Lê um sga selecionado pelo usuário. Esta propriedade é obrigatória quando a seleção de sgas for manual.

Returns:

o sga selecionado pelo usuário.

Throws:

csbase.exception.ParseException - Em caso de erro no formato da lista lida ou se a propriedade não existir.

getSelectedSGAsNames

public List<String> getSelectedSGAsNames()
                                  throws csbase.exception.ParseException

Lê os sgas selecionados pelo usuário. Esta propriedade é obrigatória quando a seleção de sgas for manual.

Returns:

a lista de sgas selecionados pelo usuário.

Throws:

csbase.exception.ParseException - Em caso de erro no formato da lista lida ou se a propriedade não existir.

setSGAName

public void setSGAName(String sgaName)

Cria a propriedade que informa o nome do SGA que executou o comando (se existir) e a anexa à lista de propriedades. A chave é opcional. Seu valor é o nome do SGA.

Parameters:

sgaName - O nome do SGA. (Não aceita null).

getSGAName

public String getSGAName()

Lê o nome do SGA que executou o comando.

Returns:

O nome do SGA ou null se ele não estiver nas propriedades do comando.

setStatus

public void setStatus(csbase.logic.CommandStatus status)

Cria a propriedade que informa o estado do comando e a anexa à lista de propriedades. A chave é obrigatória e o seu valor é um nome que representa um CommandStatus.

Parameters:

status - O estado de um comando. (Não aceita null).

getStatus

public csbase.logic.CommandStatus getStatus()
                                     throws csbase.exception.ParseException

Lê a propriedade que informa o estado do comando.

Returns:

o estado do comando ou CommandStatus#FINISHED se a propriedade não existir.

Throws:

csbase.exception.ParseException - Em caso de erro no formato do estado do comando.

setExitCode

protected void setExitCode(Integer exitCode)

Cria a propriedade que informa o código de saída do comando e a anexa à lista de propriedades. A chave é opcional e o seu valor é um inteiro.

Parameters:

exitCode - O código de saída do comando. (Não aceita null ).

setFinalizationInfo

public void setFinalizationInfo(csbase.logic.CommandFinalizationInfo finalizationInfo)

Cria as propriedades que informam sobre o estado de finalização do comando e as anexa à lista de propriedades. As propriedades dependem do tipo de informação de finalização disponível para o comando.

Parameters:

finalizationInfo - Informação de finalização do comando. (Não aceita null ).

setSimpleFinalizationInfo

protected void setSimpleFinalizationInfo(csbase.logic.CommandFinalizationInfo finalizationInfo)

Cria as propriedades que informam sobre o estado de finalização do comando e as anexa à lista de propriedades. Utilizadas para armazenar informações simples de um comando (FinalizationInfoType#SIMPLE).

Parameters:

finalizationInfo - Informação simples de finalização do comando. (Não aceita null ).

setExtendedFinalizationInfo

protected void setExtendedFinalizationInfo(csbase.logic.ExtendedCommandFinalizationInfo finalizationInfo)

Cria as propriedades que informam sobre o estado de finalização do comando e as anexa à lista de propriedades. Utilizadas para armazenar informações consolidadas de fluxos e seus nós em um comando. ( FinalizationInfoType#EXTENDED).

Parameters:

finalizationInfo - Informação composta de finalização do comando. (Não aceita null ).

setFinalizationInfoType

protected void setFinalizationInfoType(csbase.logic.CommandFinalizationInfo.FinalizationInfoType infoType)

Cria a propriedade que informa o tipo de informação de finalização disponível para o comando e a anexa à lista de propriedades. A chave é obrigatória e o seu valor é um nome que representa um CommandFinalizationInfo.FinalizationInfoType .

Parameters:

infoType - O tipo de informação de finalização de um comando. (Não aceita null).

getFinalizationInfoType

public csbase.logic.CommandFinalizationInfo.FinalizationInfoType getFinalizationInfoType()
                                                                                  throws csbase.exception.ParseException

Lê a propriedade com o tipo de informação de finalização disponível para o comando.

Returns:

O tipo de informação ou FinalizationInfoType#SIMPLE se ele não está nas propriedades do comando.

Throws:

csbase.exception.ParseException - Em caso de erro no formato do tipo de informação.

setGuiltyNodeId

protected void setGuiltyNodeId(Integer nodeId)

Cria a propriedade que identifica o nó responsável por erro na execução do fluxo (se houver). A chave é opcional e o seu valor é um inteiro que representa o id do nó.

Parameters:

nodeId - identificador do nó responsável por erro na execução do fluxo, se houver. (Não aceita null).

getExitCode

protected Integer getExitCode()
                       throws csbase.exception.ParseException

Lê o identificador do nó responsável por erro na execução do fluxo (se houver).

Returns:

O identificador do nó ou null se ele não está nas propriedades do comando.

Throws:

csbase.exception.ParseException - Em caso de erro no formato do código.

getGuiltyNodeId

protected Integer getGuiltyNodeId()
                           throws csbase.exception.ParseException

Lê o código de saída do comando.

Returns:

O código ou null se ele não está nas propriedades do comando.

Throws:

csbase.exception.ParseException - Em caso de erro no formato do código.

getFinalizationInfo

public csbase.logic.CommandFinalizationInfo getFinalizationInfo()
                                                         throws csbase.exception.ParseException

Lê as propriedades que informam o estado finalização do comando.

Returns:

As informações de finalização do comando.

Throws:

csbase.exception.ParseException - Em caso de erro no formato das propriedades.

getSimpleFinalizationInfo

protected csbase.logic.CommandFinalizationInfo getSimpleFinalizationInfo()
                                                                  throws csbase.exception.ParseException

Lê as propriedades que informam o estado finalização do comando. Utilizadas para ler informações simples de um comando ( FinalizationInfoType#SIMPLE ).

Returns:

informações simples de finalização do comando.

Throws:

csbase.exception.ParseException - Em caso de erro no formato das propriedades.

getExtendedFinalizationInfo

protected csbase.logic.ExtendedCommandFinalizationInfo getExtendedFinalizationInfo()
                                                                            throws csbase.exception.ParseException

Lê as propriedades que informam o estado finalização do comando. Utilizadas para ler informações consolidadas de um fluxo e seus nós em um comando ( FinalizationInfoType#EXTENDED ).

Returns:

informações compostas de finalização do comando.

Throws:

csbase.exception.ParseException - Em caso de erro no formato das propriedades.

setFailureCause

public void setFailureCause(csbase.logic.FailureFinalizationType failureCause)

Cria a propriedade que informa a causa da falha na finalização do comando e a anexa à lista de propriedades. A chave é opcional eo seu valor é um nome que representa um FailureFinalizationType.

Parameters:

failureCause - O que levou o comando a falhar (Não aceita null ).

setFinalizationType

public void setFinalizationType(csbase.logic.CommandFinalizationType finalizationType)

Cria a propriedade que informa o que levou o comando a terminar e a anexa à lista de propriedades. A chave é obrigatória e o seu valor é um nome que representa um CommandFinalizationType.

Parameters:

finalizationType - O que levou o comando a terminar. (Não aceita null).

getFinalizationType

protected csbase.logic.CommandFinalizationType getFinalizationType()
                                                            throws csbase.exception.ParseException

Lê a propriedade que informa o que levou o comando a terminar.

Returns:

o comando a terminar ou CommandFinalizationType#UNKNOWN se a propriedade não existir.

Throws:

csbase.exception.ParseException - Em caso de erro no formato do estado do comando.

getFailureCause

protected csbase.logic.FailureFinalizationType getFailureCause()
                                                        throws csbase.exception.ParseException

Lê a propriedade que informa a causa da falha na finalização do comando.

Returns:

a causa do comando terminar com falha ou FailureFinalizationType#UNKNOWN se a propriedade não existir.

Throws:

csbase.exception.ParseException - Em caso de erro no formato do estado do comando.

setSubmittedDate

public void setSubmittedDate(Date submittedDate)

Cria a propriedade que informa a data e hora em que o comando foi submetido para execução e a anexa à lista de propriedades. A chave é obrigatória e o seu valor é um Date.

Parameters:

submittedDate - A data em que o comando foi submetido. (Não aceita null).

getSubmittedDate

public Date getSubmittedDate()
                      throws csbase.exception.ParseException

Lê a data em que o comando foi iniciado.

Returns:

A data ou null se ela não está nas propriedades do comando.

Throws:

csbase.exception.ParseException - Em caso de erro no formato da data.

setWallTimeSec

public void setWallTimeSec(Integer wallTimeSec)

Cria a propriedade que informa o tempo total de execução do processo principal e a anexa à lista de propriedades. A chave é obrigatória e o seu valor é um Integer.

Parameters:

wallTimeSec - tempo total de execução do processo principal. (Não aceita null).

getWallTimeSec

public Integer getWallTimeSec()
                       throws csbase.exception.ParseException

Lê o tempo total de execução do processo principal.

Returns:

O tempo ou null se ela não está nas propriedades do comando.

Throws:

csbase.exception.ParseException - Em caso de erro no formato da data.

setTip

public void setTip(String tip)

Cria a propriedade que informa a descrição do algoritmo e a anexa à lista de propriedades. A chave é opcional e o seu valor é a descrição do algoritmo.

Parameters:

tip - A descrição do algoritmo. (Não aceita null)

getTip

public String getTip()

Lê a descrição do algoritmo do comando.

Returns:

A descrição do algoritmo do comando. Retorna null se ele não estiver nas propriedades do comando.

setUserId

public void setUserId(Object userId)

Cria a propriedade que informa o identificador do usuário que submeteu o comando para execução e a anexa à lista de propriedades. A chave é obrigatória e o seu valor é o identificador do usuário.

Parameters:

userId - O identificador do usuário. (Não aceita null).

getUserId

public String getUserId()

Lê o identificador do usuário que executou o comando.

Returns:

O identificador do usuário ou null se ele não estiver nas propriedades do comando.

saveProperties

public void saveProperties(OutputStream outputStream)
                    throws IOException

Salva uma lista de propriedades no stream de saída.

Parameters:

outputStream - O stream de saída (Não aceita null).

Throws:

IOException - Em caso de erro de ES ao escrever no stream.

loadProperties

public void loadProperties(InputStream inputStream)
                    throws IOException

Carrega uma lista de propriedades do stream de entrada.

Parameters:

inputStream - O stream de entrada (Não aceita null).

Throws:

IOException - Em caso de erro de ES ao ler do stream.