csbase.server.services.opendreamsservice.opendreams.v1_9

Class JobInfoQueue

java.lang.Object

csbase.server.services.opendreamsservice.opendreams.v1_9.JobInfoQueue

public class JobInfoQueue
extends Object

Controle dos jobs submetidos pelo OpenDreams.

Author:

Tecgraf PUC-Rio

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_EXIT_CODE O Job terminou mas não tem um codigo de saída
static long	WAITING_TIMEOUT Tempo em milisegundos para reavaliar se a fila já possui informação sobre o término do job.

Constructor Summary

Constructors

Constructor and Description
JobInfoQueue()

Method Summary

Modifier and Type	Method and Description
String[]	getAllJobs() Obtem todos os jobs submetidos na sessão
static tecgraf.openbus.opendreams.v1_9.FinalizationType	getFinalizationType(csbase.logic.CommandFinalizationType type, csbase.logic.FailureFinalizationType cause) Mapeia o tipo de finalização do comando do CSBase para o tipo de finalização de comando definido pela IDL do OpenDreams.
tecgraf.openbus.DRMAA.v1_9.JobInfo	getJobInfo(String jobId) Obtém as informações sobre se o job submetido já finalizou sua execução.
void	jobExit(csbase.logic.CommandNotification cmdEvent) Indica que um job finalizou
void	jobSubmited(String jobId) Indica que um job foi submetido
void	waitFor(String[] jobIdList, long timeout, boolean dispose) Agurada que uma lista de jobs submetidos teminem suas execuções.
tecgraf.openbus.DRMAA.v1_9.JobInfo	waitFor(String jobId, long timeout) Aguarda que um determinado job submetido termine sua execução.
void	waitForAllJobs(long timeout, boolean dispose) Aguarda que todos os jobs ativos na sessão, no momento da chamada do método, terminem suas execuções.
tecgraf.openbus.DRMAA.v1_9.JobInfo	waitForAnyJob(long timeout) Aguarda que qualquer um dos jobs submetidos termine sua execução.

Methods inherited from class java.lang.Object

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

Field Detail

NO_EXIT_CODE

public static final int NO_EXIT_CODE

O Job terminou mas não tem um codigo de saída

See Also:

Constant Field Values

WAITING_TIMEOUT

public static final long WAITING_TIMEOUT

Tempo em milisegundos para reavaliar se a fila já possui informação sobre o término do job.

See Also:

Constant Field Values

Constructor Detail

JobInfoQueue

public JobInfoQueue()

Method Detail

jobSubmited

public void jobSubmited(String jobId)

Indica que um job foi submetido

Parameters:

jobId - o identificador do job submetido

jobExit

public void jobExit(csbase.logic.CommandNotification cmdEvent)

Indica que um job finalizou

Parameters:

cmdEvent - evento com as informações de término do job

getFinalizationType

public static tecgraf.openbus.opendreams.v1_9.FinalizationType getFinalizationType(csbase.logic.CommandFinalizationType type,
                                                                                   csbase.logic.FailureFinalizationType cause)

Mapeia o tipo de finalização do comando do CSBase para o tipo de finalização de comando definido pela IDL do OpenDreams.

Parameters:

type - o tipo de finalização do comando no CSBase

cause - a causa da falha no caso do comando ou null caso o comando não tenha falhado.

Returns:

o tipo de finalização do comando mapeado para o OpenDreams

waitFor

public tecgraf.openbus.DRMAA.v1_9.JobInfo waitFor(String jobId,
                                                  long timeout)
                                           throws tecgraf.openbus.DRMAA.v1_9.InvalidJobException,
                                                  tecgraf.openbus.DRMAA.v1_9.ExitTimeoutException

Aguarda que um determinado job submetido termine sua execução. Se mais de uma chamada estiver aguardando pelo mesmo job, apenas uma delas recebe a informação de término do job. As outras chamadas recebem e exceção InvalidJobException. Essa mesma exceção é também lançada se o identificador do job não for encontrado entre os jobs submetidos nessa sessão. No caso do timeout ter esgotado sem que o job tenha terminado, a exceção ExitTimeoutException é lançada. Nesse caso, a informação sobre o job permanece disponível para uma outra requisição.

Parameters:

jobId - o nome do job monitorado

timeout - o tempo de espera limite em segundos

Returns:

a informação sobre o job submetido

Throws:

tecgraf.openbus.DRMAA.v1_9.InvalidJobException - se o identificador do job não foi encontrado ou se outra requisição já recebeu a informação de término do job.

tecgraf.openbus.DRMAA.v1_9.ExitTimeoutException - se o timeout esgotou e o job não terminou.

waitForAnyJob

public tecgraf.openbus.DRMAA.v1_9.JobInfo waitForAnyJob(long timeout)
                                                 throws tecgraf.openbus.DRMAA.v1_9.ExitTimeoutException,
                                                        tecgraf.openbus.DRMAA.v1_9.InvalidJobException

Aguarda que qualquer um dos jobs submetidos termine sua execução. Quando um deles terminar, retorna a informação sobre esse job. Apenas uma chamada recebe a informação de um determinado job. Se outras chamadas estiverem aguardando e não houver mais jobs submetidos (no momento em que a requisição de "wait" for feita), as outras recebem a exceção InvalidJobException. No caso do timeout ter esgotado sem que algum job tenha terminado, a exceção ExitTimeoutException é lançada.

Parameters:

timeout - o tempo de espera limite em segundos

Returns:

a informação sobre o primeiro job que terminou

Throws:

tecgraf.openbus.DRMAA.v1_9.InvalidJobException - se não há mais jobs submetidos na sessão que ainda não tenham terminado sua execução

tecgraf.openbus.DRMAA.v1_9.ExitTimeoutException - se o timeout esgotou e nenhum job terminou.

getJobInfo

public tecgraf.openbus.DRMAA.v1_9.JobInfo getJobInfo(String jobId)
                                              throws tecgraf.openbus.DRMAA.v1_9.InvalidJobException

Obtém as informações sobre se o job submetido já finalizou sua execução.

Parameters:

jobId - o nome do job

Returns:

o objeto JobInfo que possui as informações sobre o job submetido

Throws:

tecgraf.openbus.DRMAA.v1_9.InvalidJobException - se o identificador do job não foi encontrado

waitFor

public void waitFor(String[] jobIdList,
                    long timeout,
                    boolean dispose)
             throws tecgraf.openbus.DRMAA.v1_9.InvalidJobException,
                    tecgraf.openbus.DRMAA.v1_9.ExitTimeoutException

Agurada que uma lista de jobs submetidos teminem suas execuções. Se mais de uma chamada estiver aguardando pelo mesmo job, apenas uma delas recebe a informação de término do job. As outras chamadas recebem e exceção InvalidJobException. Essa mesma exceção é também lançada se o identificador do job não for encontrado entre os jobs submetidos nessa sessão. Se o parâmetro dispose tiver o valor true as informações de término dos jobs da lista serão descartadas. No caso do timeout ter esgotado sem que todos os jobs da lista tenham terminado, a exceção ExitTimeoutException é lançada. Nesse caso, as informações sobre os jobs permanecem disponíveis para uma outra requisição.

Parameters:

jobIdList - lista de identificadores de jobs para esperar

timeout - o tempo de espera limite em segundos

dispose - indica se as informação sobre a execução de um job dever ser apagadas ou não

Throws:

tecgraf.openbus.DRMAA.v1_9.InvalidJobException - se um identificador de um job da lista não foi encontrado ou se outra requisição já recebeu a informação de término deste job.

tecgraf.openbus.DRMAA.v1_9.ExitTimeoutException - se o timeout esgotou e nenhum job terminou.

waitForAllJobs

public void waitForAllJobs(long timeout,
                           boolean dispose)
                    throws tecgraf.openbus.DRMAA.v1_9.ExitTimeoutException

Aguarda que todos os jobs ativos na sessão, no momento da chamada do método, terminem suas execuções. Se alguma outra chamada estiver aguardando o término de algum job ativo na sessão e receber sua informação de término, não é lançada exceção, diferentemente com o comportamento dos outros métodos de espera. Se o parâmetro dispose tiver o valor true as informações de término dos jobs ativos na sessão serão descartadas. No caso do timeout ter esgotado sem que todos os jobs ativos na sessão tenham terminado, a exceção ExitTimeoutException é lançada. Nesse caso, as informações sobre os jobs permanecem disponíveis para uma outra requisição.

Parameters:

timeout - o tempo de espera limite em segundos

dispose - indica se as informação sobre a execução de um job dever ser apagadas ou não

Throws:

tecgraf.openbus.DRMAA.v1_9.ExitTimeoutException - se o timeout esgotou e nenhum job terminou.

getAllJobs

public String[] getAllJobs()

Obtem todos os jobs submetidos na sessão

Returns:

lista com os identificadores dos jobs