Package org.apache.activemq.broker.jmx

Interface JobSchedulerViewMBean

All Known Implementing Classes:

JobSchedulerView

public interface JobSchedulerViewMBean

Method Summary

Modifier and Type	Method	Description
TabularData	getAllJobs()	Get all the outstanding Jobs that are scheduled in this scheduler store.
TabularData	getAllJobs(String start, String finish)	Get all outstanding jobs due to run between start and finish time range.
int	getDelayedMessageCount()	Get the number of delayed messages.
int	getExecutionCount(String jobId)	Gets the number of times a scheduled Job has been executed.
TabularData	getNextScheduleJobs()	Get all the jobs scheduled to run next.
String	getNextScheduleTime()	Get the next time jobs will be fired from this scheduler store.
int	getScheduledMessageCount()	Get the number of messages in the scheduler.
void	removeAllJobs()	Remove all the Jobs from the scheduler,
void	removeAllJobs(String start, String finish)	Remove all the Jobs from the scheduler that are due between the start and finish times.
void	removeAllJobsAtScheduledTime(String time)	Remove all jobs scheduled to run at this time.
void	removeJob(String jobId)	Remove a job with the matching jobId.

Method Detail

removeAllJobsAtScheduledTime

void removeAllJobsAtScheduledTime(String time)
                           throws Exception

Remove all jobs scheduled to run at this time. If there are no jobs scheduled at the given time this methods returns without making any modifications to the scheduler store.

Parameters:

time - the string formated time that should be used to remove jobs.

Throws:

Exception - if an error occurs while performing the remove.

removeJob

void removeJob(String jobId)
        throws Exception

Remove a job with the matching jobId. If the method does not find a matching job then it returns without throwing an error or making any modifications to the job scheduler store.

Parameters:

jobId - the Job Id to remove from the scheduler store.

Throws:

Exception - if an error occurs while attempting to remove the Job.

removeAllJobs

void removeAllJobs()
            throws Exception

Remove all the Jobs from the scheduler,

Throws:

Exception - if an error occurs while purging the store.

removeAllJobs

void removeAllJobs(String start,
                   String finish)
            throws Exception

Remove all the Jobs from the scheduler that are due between the start and finish times.

Parameters:

start - the starting time to remove jobs from.

finish - the finish time for the remove operation.

Throws:

Exception - if an error occurs while attempting to remove the jobs.

getNextScheduleTime

String getNextScheduleTime()
                    throws Exception

Get the next time jobs will be fired from this scheduler store.

Returns:

the time in milliseconds of the next job to execute.

Throws:

Exception - if an error occurs while accessing the store.

getExecutionCount

int getExecutionCount(String jobId)
               throws Exception

Gets the number of times a scheduled Job has been executed.

Returns:

the total number of time a scheduled job has executed.

Throws:

Exception - if an error occurs while querying for the Job.

getNextScheduleJobs

TabularData getNextScheduleJobs()
                         throws Exception

Get all the jobs scheduled to run next.

Returns:

a list of jobs that will be scheduled next

Throws:

Exception - if an error occurs while reading the scheduler store.

getAllJobs

TabularData getAllJobs()
                throws Exception

Get all the outstanding Jobs that are scheduled in this scheduler store.

Returns:

a table of all jobs in this scheduler store.

Throws:

Exception - if an error occurs while reading the store.

getAllJobs

TabularData getAllJobs(String start,
                       String finish)
                throws Exception

Get all outstanding jobs due to run between start and finish time range.

Parameters:

start - the starting time range to query the store for jobs.

finish - the ending time of this query for scheduled jobs.

Returns:

a table of jobs in the range given.

Throws:

Exception - if an error occurs while querying the scheduler store.

getScheduledMessageCount

int getScheduledMessageCount()
                      throws Exception

Get the number of messages in the scheduler.

Returns:

the number of messages in the scheduler.

Throws:

Exception - if an error occurs while querying the scheduler store.

getDelayedMessageCount

int getDelayedMessageCount()
                    throws Exception

Get the number of delayed messages.

Returns:

the number of delayed messages.

Throws:

Exception - if an error occurs while querying the scheduler store.