org.apache.oozie.service

Interface Service

All Known Implementing Classes:

AbandonedCoordCheckerService, ActionCheckerService, ActionService, AuthorizationService, BundleEngineService, CallableQueueService, CallbackService, ConfigurationService, CoordinatorEngineService, CoordMaterializeTriggerService, DagEngineService, DagXLogInfoService, DBLiteWorkflowStoreService, ELService, EventHandlerService, GroupsService, HadoopAccessorService, HCatAccessorService, InstrumentationService, JMSAccessorService, JMSTopicService, JobsConcurrencyService, JPAService, JvmPauseMonitorService, LiteWorkflowAppService, LiteWorkflowStoreService, MemoryLocksService, MetricsInstrumentationService, PartitionDependencyManagerService, PauseTransitService, ProxyUserService, PurgeService, RecoveryService, SchedulerService, SchemaService, ShareLibService, SLAService, SLAStoreService, SparkConfigurationService, StatusTransitService, StoreService, URIHandlerService, UserGroupInformationService, UUIDService, WorkflowAppService, WorkflowSchemaService, WorkflowStoreService, XLogService, XLogStreamingService, ZKJobsConcurrencyService, ZKLocksService, ZKUUIDService, ZKXLogStreamingService

public interface Service

A service is component managed by the Services singleton.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONF_PREFIX Prefix for all services configuration properties.
static java.lang.String	DEFAULT_LOCK_TIMEOUT
static long	lockTimeout Lock timeout value if service is only allowed to have one single running instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Destroy the service.
java.lang.Class<? extends Service>	getInterface() Return the public interface of the service.
void	init(Services services) Initialize the service.

Field Detail

DEFAULT_LOCK_TIMEOUT

static final java.lang.String DEFAULT_LOCK_TIMEOUT

See Also:

Constant Field Values

CONF_PREFIX

static final java.lang.String CONF_PREFIX

Prefix for all services configuration properties.

See Also:

Constant Field Values

lockTimeout

static final long lockTimeout

Lock timeout value if service is only allowed to have one single running instance.

Method Detail

init

void init(Services services)
          throws ServiceException

Initialize the service.

Invoked by the Service singleton at start up time.

Parameters:

services - services singleton initializing the service.

Throws:

ServiceException - thrown if the service could not initialize.

destroy

void destroy()

Destroy the service.

Invoked by the Service singleton at shutdown time.

getInterface

java.lang.Class<? extends Service> getInterface()

Return the public interface of the service.

Services are retrieved by its public interface. Specializations of services must return the public interface.

Returns:

the interface of the service.