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 .
| Constructor and Description |
|---|
CommandPropertyParser()
Cria um analisador para ler ou escrever um arquivo com as propriedades do
comando.
|
| 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.
|
List<csbase.logic.algorithms.MonitoredFile> |
getMonitoredFiles()
Lê os arquivos monitorados na 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.
|
protected boolean |
hasWarnings()
Lê a propriedade que indica se o comando gerou alertas durante sua
execução.
|
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 |
setMonitoredFiles(List<csbase.logic.algorithms.MonitoredFile> monitoredFiles)
Cria a propriedade que informa os arquivos monitorados 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.
|
void |
setWarningFlag(boolean hasWarnings)
Cria a propriedade que indica se o comando gerou alertas durante sua
execução e a anexa à lista de propriedades.
|
public CommandPropertyParser()
public void setExecutionCountForMultipleExecution(Integer executionCount)
executionCount - O número de número de execuções que devem ser
disparadas na execução do comando. (Não aceita null)public int getExecutionCountForMultipleExecution()
throws csbase.exception.ParseException
csbase.exception.ParseException - Em caso de erro no formato do número de execuções ou
se a propriedade não existir.public void setExecutionCountPerSGAForMultipleExecution(Integer executionCount)
executionCount - O número de execuções por sgas que devem ser
disparadas na execução do comando. (Não aceita null)public int getExecutionCountPerSGAForMultipleExecution()
throws csbase.exception.ParseException
csbase.exception.ParseException - Em caso de erro no formato do número de execuções
por sga ou se a propriedade não existir.public void setDescription(String description)
description - A descrição do comando. (Não aceita null)public String getDescription()
null se ele não estiver nas
propriedades do comando.public void setExecutionType(csbase.logic.algorithms.ExecutionType executionType)
ExecutionType
.executionType - O tipo de execução do comando (Não aceita null
).public csbase.logic.algorithms.ExecutionType getExecutionType()
throws csbase.exception.ParseException
ExecutionType#SIMPLE se a
propriedade não existir.csbase.exception.ParseException - Em caso de erro no formato do tipo de execução.public void setGlobalPosition(Integer globalPosition)
globalPosition - A posição do comando na fila do escalonador. (Não
aceita null).public Integer getGlobalPosition() throws csbase.exception.ParseException
csbase.exception.ParseException - Em caso de erro no formato da posição do comando.public void setId(String id)
id - O identificador do comando. (Não aceita null).public String getId() throws csbase.exception.ParseException
csbase.exception.ParseException - Se o identificador do comando não estiver nas
propriedades.public void setIsAutomatic(boolean isAutomatic)
isAutomatic - verdadeiro caso a seleção seja automática ou falso caso
contrário.public boolean getIsAutomatic()
throws csbase.exception.ParseException
csbase.exception.ParseException - Se a indicação de seleção de sgas não estiver no
formato correto.public void setMailAtEnd(boolean mailAtEnd)
mailAtEnd - verdadeiro caso o email deva ser enviado ou falso caso
contrário.public boolean getMailAtEnd()
throws csbase.exception.ParseException
csbase.exception.ParseException - Se a indicação de envio de email não estiver no
formato correto.public void setPlatformFilter(String platformFilter)
platformFilter - A restrição de plataforma do comando. (Não aceita
null)public String getPlatformFilter()
null se ele
não estiver nas propriedades do comando.public void setPriority(csbase.logic.Priority priority)
Priority.priority - Um nome que representa um Priority. (Não aceita
null).public csbase.logic.Priority getPriority()
throws csbase.exception.ParseException
null se a
propriedade não existir.csbase.exception.ParseException - Em caso de erro no formato da prioridade.public void setSelectedSGAsNames(List<String> sgasNames)
sgasNames - A lista de nomes dos sgas. (Não aceita null)public String getSelectedSGAName() throws csbase.exception.ParseException
csbase.exception.ParseException - Em caso de erro no formato da lista lida ou se a
propriedade não existir.public List<String> getSelectedSGAsNames() throws csbase.exception.ParseException
csbase.exception.ParseException - Em caso de erro no formato da lista lida ou se a
propriedade não existir.public void setSGAName(String sgaName)
sgaName - O nome do SGA. (Não aceita null).public String getSGAName()
null se ele não estiver nas propriedades
do comando.public void setStatus(csbase.logic.CommandStatus status)
CommandStatus.status - O estado de um comando. (Não aceita null).public csbase.logic.CommandStatus getStatus()
throws csbase.exception.ParseException
CommandStatus#FINISHED se a
propriedade não existir.csbase.exception.ParseException - Em caso de erro no formato do estado do comando.protected void setExitCode(Integer exitCode)
exitCode - O código de saída do comando. (Não aceita null ).public void setFinalizationInfo(csbase.logic.CommandFinalizationInfo finalizationInfo)
finalizationInfo - Informação de finalização do comando. (Não aceita
null ).protected void setSimpleFinalizationInfo(csbase.logic.CommandFinalizationInfo finalizationInfo)
FinalizationInfoType#SIMPLE).finalizationInfo - Informação simples de finalização do comando. (Não
aceita null ).protected void setExtendedFinalizationInfo(csbase.logic.ExtendedCommandFinalizationInfo finalizationInfo)
FinalizationInfoType#EXTENDED).finalizationInfo - Informação composta de finalização do comando. (Não
aceita null ).protected void setFinalizationInfoType(csbase.logic.CommandFinalizationInfo.FinalizationInfoType infoType)
CommandFinalizationInfo.FinalizationInfoType .infoType - O tipo de informação de finalização de um comando. (Não
aceita null).public csbase.logic.CommandFinalizationInfo.FinalizationInfoType getFinalizationInfoType()
throws csbase.exception.ParseException
FinalizationInfoType#SIMPLE se ele
não está nas propriedades do comando.csbase.exception.ParseException - Em caso de erro no formato do tipo de informação.protected void setGuiltyNodeId(Integer nodeId)
nodeId - identificador do nó responsável por erro na execução do
fluxo, se houver. (Não aceita null).protected Integer getExitCode() throws csbase.exception.ParseException
null se ele não está nas
propriedades do comando.csbase.exception.ParseException - Em caso de erro no formato do código.protected Integer getGuiltyNodeId() throws csbase.exception.ParseException
null se ele não está nas propriedades do
comando.csbase.exception.ParseException - Em caso de erro no formato do código.public csbase.logic.CommandFinalizationInfo getFinalizationInfo()
throws csbase.exception.ParseException
csbase.exception.ParseException - Em caso de erro no formato das propriedades.protected csbase.logic.CommandFinalizationInfo getSimpleFinalizationInfo()
throws csbase.exception.ParseException
FinalizationInfoType#SIMPLE ).csbase.exception.ParseException - Em caso de erro no formato das propriedades.protected csbase.logic.ExtendedCommandFinalizationInfo getExtendedFinalizationInfo()
throws csbase.exception.ParseException
FinalizationInfoType#EXTENDED ).csbase.exception.ParseException - Em caso de erro no formato das propriedades.public void setFailureCause(csbase.logic.FailureFinalizationType failureCause)
FailureFinalizationType.failureCause - O que levou o comando a falhar (Não aceita null
).public void setWarningFlag(boolean hasWarnings)
hasWarnings - verdadeiro caso o comando tenha gerado alertas ou falso,
caso contrário.public void setFinalizationType(csbase.logic.CommandFinalizationType finalizationType)
CommandFinalizationType.finalizationType - O que levou o comando a terminar. (Não aceita
null).protected csbase.logic.CommandFinalizationType getFinalizationType()
throws csbase.exception.ParseException
CommandFinalizationType#UNKNOWN se
a propriedade não existir.csbase.exception.ParseException - Em caso de erro no formato do estado do comando.protected csbase.logic.FailureFinalizationType getFailureCause()
throws csbase.exception.ParseException
FailureFinalizationType#UNKNOWN se a propriedade não
existir.csbase.exception.ParseException - Em caso de erro no formato do estado do comando.protected boolean hasWarnings()
throws csbase.exception.ParseException
csbase.exception.ParseException - Em caso de erro no formato do campo.public void setSubmittedDate(Date submittedDate)
Date.submittedDate - A data em que o comando foi submetido. (Não aceita
null).public Date getSubmittedDate() throws csbase.exception.ParseException
null se ela não está nas propriedades do comando.csbase.exception.ParseException - Em caso de erro no formato da data.public void setWallTimeSec(Integer wallTimeSec)
Integer.wallTimeSec - tempo total de execução do processo principal. (Não
aceita null).public Integer getWallTimeSec() throws csbase.exception.ParseException
null se ela não está nas propriedades do
comando.csbase.exception.ParseException - Em caso de erro no formato da data.public void setTip(String tip)
tip - A descrição do algoritmo. (Não aceita null)public String getTip()
null se ele
não estiver nas propriedades do comando.public void setUserId(Object userId)
userId - O identificador do usuário. (Não aceita null).public String getUserId()
null se ele não estiver nas
propriedades do comando.public void saveProperties(OutputStream outputStream) throws IOException
outputStream - O stream de saída (Não aceita null).IOException - Em caso de erro de ES ao escrever no stream.public void loadProperties(InputStream inputStream) throws IOException
inputStream - O stream de entrada (Não aceita null).IOException - Em caso de erro de ES ao ler do stream.public void setMonitoredFiles(List<csbase.logic.algorithms.MonitoredFile> monitoredFiles)
monitoredFiles - A lista arquivos monitoradospublic List<csbase.logic.algorithms.MonitoredFile> getMonitoredFiles() throws csbase.exception.ParseException
csbase.exception.ParseExceptionCopyright © 2017. All rights reserved.