org.apache.lens.server.api.scheduler

Interface SchedulerService

All Superinterfaces:

HealthCheckable, LensService, SessionValidator

All Known Implementing Classes:

SchedulerServiceImpl

public interface SchedulerService
extends LensService, SessionValidator

Scheduler interface.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME The constant name for scheduler service.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	deleteJob(LensSessionHandle sessionHandle, SchedulerJobHandle jobHandle) Delete a job.
boolean	expireJob(LensSessionHandle sessionHandle, SchedulerJobHandle jobHandle) End a job by specifying an expiry time.
Collection<SchedulerJobStats>	getAllJobStats(String state, String user, String jobName, long startTime, long endTime)
SchedulerJobInstanceInfo	getInstanceDetails(SchedulerJobInstanceHandle instanceHandle) Instance details for an instance.
XJob	getJobDefinition(SchedulerJobHandle jobHandle) Returns the definition of a job.
SchedulerJobInfo	getJobDetails(SchedulerJobHandle jobHandle) Returns the details of a job.
List<SchedulerJobInstanceInfo>	getJobInstances(SchedulerJobHandle jobHandle, Long numResults) Returns handles for last numResults instances for the job.
SchedulerJobStats	getJobStats(SchedulerJobHandle handle, String state, long startTime, long endTime) Returns stats for a job.
boolean	killInstance(LensSessionHandle sessionHandle, SchedulerJobInstanceHandle instanceHandle) Kills a running job instance.
LensSessionHandle	openSessionAsUser(String user) Create session as user for scheduling the job with no auth.
boolean	rerunInstance(LensSessionHandle sessionHandle, SchedulerJobInstanceHandle instanceHandle) Reruns a failed/killed/completed job instance.
boolean	resumeJob(LensSessionHandle sessionHandle, SchedulerJobHandle jobHandle) Resume a job from a given time.
boolean	scheduleJob(LensSessionHandle sessionHandle, SchedulerJobHandle jobHandle) Schedule a job.
SchedulerJobHandle	submitAndScheduleJob(LensSessionHandle sessionHandle, XJob job) Submit a job and also schedule it.
SchedulerJobHandle	submitJob(LensSessionHandle sessionHandle, XJob job) Submit a job.
boolean	suspendJob(LensSessionHandle sessionHandle, SchedulerJobHandle jobHandle) Suspend a job.
boolean	updateJob(LensSessionHandle sessionHandle, SchedulerJobHandle jobHandle, XJob newJobDefinition) Update a job with new definition.

Methods inherited from interface org.apache.lens.server.api.health.HealthCheckable

getHealthStatus

Methods inherited from interface org.apache.lens.server.api.SessionValidator

validateSession

Field Detail

NAME

static final String NAME

The constant name for scheduler service.

See Also:

Constant Field Values

Method Detail

submitJob

SchedulerJobHandle submitJob(LensSessionHandle sessionHandle,
                           XJob job)
                             throws LensException

Submit a job.

Parameters:

sessionHandle - handle for this session.

job - job to be submitted.

Returns:

unique id for the submitted job.

Throws:

LensException - the lens exception

scheduleJob

boolean scheduleJob(LensSessionHandle sessionHandle,
                  SchedulerJobHandle jobHandle)
                    throws LensException

Schedule a job.

Parameters:

sessionHandle - handle for the current session.

jobHandle - handle for the job to be scheduled.

Returns:

true if there is a successful schedule

Throws:

LensException - the lens exception

submitAndScheduleJob

SchedulerJobHandle submitAndScheduleJob(LensSessionHandle sessionHandle,
                                      XJob job)
                                        throws LensException

Submit a job and also schedule it.

Parameters:

sessionHandle - handle for the session.

job - job definition.

Returns:

unique id of the job which is submitted and scheduled.

Throws:

LensException - the lens exception

getJobDefinition

XJob getJobDefinition(SchedulerJobHandle jobHandle)
                      throws LensException

Returns the definition of a job.

Parameters:

jobHandle - handle for the job

Returns:

job definition

Throws:

LensException - the lens exception

getJobDetails

SchedulerJobInfo getJobDetails(SchedulerJobHandle jobHandle)
                               throws LensException

Returns the details of a job. Details may contain extra system information like id for the job.

Parameters:

jobHandle - handle for the job

Returns:

job details for the job

Throws:

LensException - the lens exception

updateJob

boolean updateJob(LensSessionHandle sessionHandle,
                SchedulerJobHandle jobHandle,
                XJob newJobDefinition)
                  throws LensException

Update a job with new definition.

Updates will be applied only for newer instances. Running instances will be running with old definition

Parameters:

sessionHandle -

jobHandle - handle for the job which you want to update.

newJobDefinition -

Returns:

true or false based on whether the update was successful or failed.

Throws:

LensException - the lens exception

expireJob

boolean expireJob(LensSessionHandle sessionHandle,
                SchedulerJobHandle jobHandle)
                  throws LensException

End a job by specifying an expiry time.

Parameters:

sessionHandle - handle for the current session.

jobHandle - handle for the job

Returns:

true if the operation is successful.

Throws:

LensException - the lens exception

suspendJob

boolean suspendJob(LensSessionHandle sessionHandle,
                 SchedulerJobHandle jobHandle)
                   throws LensException

Suspend a job.

If the job is not in scheduled state, it will return true. Once a job is suspended, no further instances of that job will run. Any running instances of that job will continue normally.

Parameters:

sessionHandle - handle for the current session.

jobHandle - handle for the job

Returns:

true if the job was suspended successfully, false otherwise.

Throws:

LensException - the lens exception

resumeJob

boolean resumeJob(LensSessionHandle sessionHandle,
                SchedulerJobHandle jobHandle)
                  throws LensException

Resume a job from a given time.

Parameters:

sessionHandle - handle for the session.

jobHandle - handle for the job

Returns:

true if the job was resumed successfully, false otherwise.

Throws:

LensException - the lens exception

deleteJob

boolean deleteJob(LensSessionHandle sessionHandle,
                SchedulerJobHandle jobHandle)
                  throws LensException

Delete a job.

Parameters:

sessionHandle - handle for the session.

jobHandle - handle for the job

Returns:

true if the job was deleted successfully.

Throws:

LensException - the lens exception

getAllJobStats

Collection<SchedulerJobStats> getAllJobStats(String state,
                                           String user,
                                           String jobName,
                                           long startTime,
                                           long endTime)
                                             throws LensException

Parameters:

state - filter for status, if specified only jobs in that state will be returned, if null no entries will be removed from result

user - filter for user who submitted the job, if specified only jobs submitted by the given user will be returned, if not specified no entries will be removed from result on basis of userName

jobName - filter for jobName, if specified only the jobs with name same as given name will be considered , else no jobs will be filtered out on the basis of name.

startTime - if specified only instances with scheduleTime after this time will be considered.

endTime - if specified only instances with scheduleTime before this time will be considered.

Returns:

A collection of stats per job

Throws:

LensException

getJobStats

SchedulerJobStats getJobStats(SchedulerJobHandle handle,
                            String state,
                            long startTime,
                            long endTime)
                              throws LensException

Returns stats for a job.

Parameters:

handle - handle for the job

state - filter for status, if specified only jobs in that state will be returned, if null no entries will be removed from result

startTime - if specified only instances with scheduleTime after this time will be considered.

endTime - if specified only instances with scheduleTime before this time will be considered.

Throws:

LensException - the lens exception

getJobInstances

List<SchedulerJobInstanceInfo> getJobInstances(SchedulerJobHandle jobHandle,
                                             Long numResults)
                                               throws LensException

Returns handles for last numResults instances for the job.

Parameters:

jobHandle - handle for the job

numResults - - number of results to be returned, default 100.

Returns:

list of instance ids for the job

Throws:

LensException - the lens exception

killInstance

boolean killInstance(LensSessionHandle sessionHandle,
                   SchedulerJobInstanceHandle instanceHandle)
                     throws LensException

Kills a running job instance.

If the job instance is already completed or not in running state, this will be a no-op and will return false.

Parameters:

sessionHandle - handle for the session.

instanceHandle - handle for the instance

Returns:

true if the instance was killed successfully, false otherwise.

Throws:

LensException - the lens exception

rerunInstance

boolean rerunInstance(LensSessionHandle sessionHandle,
                    SchedulerJobInstanceHandle instanceHandle)
                      throws LensException

Reruns a failed/killed/completed job instance.

If the instance is not in a terminal state, then this operation will be a no-op and will return false.

Parameters:

sessionHandle - handle for the session.

instanceHandle - handle for the instance

Returns:

true if the instance was re run successfully, false otherwise.

Throws:

LensException - the lens exception

getInstanceDetails

SchedulerJobInstanceInfo getInstanceDetails(SchedulerJobInstanceHandle instanceHandle)
                                            throws LensException

Instance details for an instance.

Parameters:

instanceHandle - handle for the instance.

Returns:

details for the instance.

Throws:

LensException - the lens exception

openSessionAsUser

LensSessionHandle openSessionAsUser(String user)
                                    throws LensException

Create session as user for scheduling the job with no auth.

Parameters:

user -

Returns:

LensSessionHandle

Throws:

LensException