Package com.linkedin.venice.service

Class AbstractVeniceService

java.lang.Object

com.linkedin.venice.service.AbstractVeniceService

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

AbstractKafkaConsumerService, AbstractStoreBufferService, AdaptiveThrottlerSignalService, AdminConsumerService, AdminSparkServer, AggKafkaConsumerService, BackupVersionOptimizationService, DictionaryRetrievalService, DisabledPartitionEnablerService, DiskHealthCheckService, HeartbeatMonitoringService, HelixParticipationService, IsolatedIngestionServer, KafkaStoreIngestionService, LeakedPushStatusCleanUpService, LeakedResourceCleaner, ListenerService, MainIngestionMonitorService, MainIngestionStorageMetadataService, P2PBlobTransferService, RemoteIngestionRepairService, RouterHeartbeat, RouterServer, StorageEngineMetadataService, StorageService, StoreBackupVersionCleanupService, StoreGraveyardCleanupService, StoreValueSchemasCacheService, SystemStoreRepairService, TopicCleanupService, UnusedValueSchemaCleanupService, VeniceControllerService

public abstract class AbstractVeniceService
extends Object
implements Closeable

Blueprint for all Services initiated from Venice Server

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	AbstractVeniceService.ServiceState

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.apache.logging.log4j.Logger	logger
protected final AtomicReference<AbstractVeniceService.ServiceState>	serviceState

Constructor Summary

Constructors

Constructor	Description
AbstractVeniceService()

Method Summary

Modifier and Type	Method	Description
void	close()
String	getName()
boolean	isRunning()
void	start()
abstract boolean	startInner()
void	stop()
abstract void	stopInner()

Methods inherited from class java.lang.Object

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

Field Details

logger

protected final org.apache.logging.log4j.Logger logger

serviceState

protected final AtomicReference<AbstractVeniceService.ServiceState> serviceState

Constructor Details

AbstractVeniceService

public AbstractVeniceService()

Method Details

getName

public String getName()

isRunning

public boolean isRunning()

start

public void start()

stop

public void stop()
          throws Exception

Throws:

Exception

startInner

public abstract boolean startInner()
                            throws Exception

Returns:

true if the service is completely started, false if it is still starting asynchronously (in this case, it is the implementer's responsibility to set serviceState to AbstractVeniceService.ServiceState.STARTED upon completion of the async work).

Throws:

Exception

stopInner

public abstract void stopInner()
                        throws Exception

Throws:

Exception

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable