org.apache.lens.server.scheduler

Class AlarmService

java.lang.Object

org.apache.hive.service.AbstractService

org.apache.lens.server.scheduler.AlarmService

All Implemented Interfaces:

org.apache.hive.service.Service, HealthCheckable, LensService

public class AlarmService
extends org.apache.hive.service.AbstractService
implements LensService

This service is used primarily by Scheduler to get alarm notifications for scheduled queries.

As a schedule this service accepts start time, frequency, end time and timeZone. It also requires the SchedulerJobHandle which it sends as part of the SchedulerAlarmEvent to inform the scheduler about the job for which job the notification has been generated.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AlarmService.LensJob

Nested classes/interfaces inherited from interface org.apache.hive.service.Service

org.apache.hive.service.Service.STATE

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALARM_SERVICE
static String	LENS_JOBS
static String	NAME

Constructor Summary

Constructors

Constructor and Description
AlarmService() Creates a new instance of AlarmService.

Method Summary

Modifier and Type	Method and Description
boolean	checkExists(SchedulerJobHandle handle)
List<org.quartz.JobExecutionContext>	getCurrentlyExecutingJobs()
HealthStatus	getHealthStatus() Returns the health status of the service.
void	init(org.apache.hadoop.hive.conf.HiveConf hiveConf)
boolean	isShouldWaitForScheduleEventProcessing()
void	pauseJob(SchedulerJobHandle jobHandle)
void	resumeJob(SchedulerJobHandle jobHandle)
void	schedule(org.joda.time.DateTime start, org.joda.time.DateTime end, XFrequency frequency, String jobHandle) This method can be used by any consumer who wants to receive notifications during a time range at a given frequency.
void	setShouldWaitForScheduleEventProcessing(boolean shouldWaitForScheduleEventProcessing)
void	start()
void	stop()
boolean	unSchedule(SchedulerJobHandle jobHandle)

Methods inherited from class org.apache.hive.service.AbstractService

getHiveConf, getName, getServiceState, getStartTime, register, unregister

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

LENS_JOBS

public static final String LENS_JOBS

See Also:

Constant Field Values

ALARM_SERVICE

public static final String ALARM_SERVICE

See Also:

Constant Field Values

Constructor Detail

AlarmService

public AlarmService()

Creates a new instance of AlarmService.

Method Detail

getHealthStatus

public HealthStatus getHealthStatus()

Description copied from interface: HealthCheckable

Returns the health status of the service.

Specified by:

getHealthStatus in interface HealthCheckable

Returns:

init

public void init(org.apache.hadoop.hive.conf.HiveConf hiveConf)

Specified by:

init in interface org.apache.hive.service.Service

Overrides:

init in class org.apache.hive.service.AbstractService

start

public void start()

Specified by:

start in interface org.apache.hive.service.Service

Overrides:

start in class org.apache.hive.service.AbstractService

stop

public void stop()

Specified by:

stop in interface org.apache.hive.service.Service

Overrides:

stop in class org.apache.hive.service.AbstractService

getCurrentlyExecutingJobs

public List<org.quartz.JobExecutionContext> getCurrentlyExecutingJobs()

schedule

public void schedule(org.joda.time.DateTime start,
                     org.joda.time.DateTime end,
                     XFrequency frequency,
                     String jobHandle)
              throws LensException

This method can be used by any consumer who wants to receive notifications during a time range at a given frequency.

This method is intended to be used by LensScheduler to subscribe for time based notifications to schedule queries. On receiving a job to be scheduled LensScheduler will subscribe to all triggers required for the job, including AlarmService for time based triggers.

Parameters:

start - start time for notifications

end - end time for notifications

frequency - Frequency to determine the frequency at which notification should be sent.

jobHandle - Must be a unique jobHanlde across all consumers

Throws:

LensException

unSchedule

public boolean unSchedule(SchedulerJobHandle jobHandle)
                   throws LensException

Throws:

LensException

checkExists

public boolean checkExists(SchedulerJobHandle handle)
                    throws LensException

Throws:

LensException

pauseJob

public void pauseJob(SchedulerJobHandle jobHandle)
              throws LensException

Throws:

LensException

resumeJob

public void resumeJob(SchedulerJobHandle jobHandle)
               throws LensException

Throws:

LensException

isShouldWaitForScheduleEventProcessing

@Generated(value="lombok")
public boolean isShouldWaitForScheduleEventProcessing()

setShouldWaitForScheduleEventProcessing

@Generated(value="lombok")
public void setShouldWaitForScheduleEventProcessing(boolean shouldWaitForScheduleEventProcessing)