Package com.linkedin.venice.controller.server

Class AdminSparkServer

java.lang.Object

com.linkedin.venice.service.AbstractVeniceService

com.linkedin.venice.controller.server.AdminSparkServer

All Implemented Interfaces:

Closeable, AutoCloseable

public class AdminSparkServer
extends AbstractVeniceService

Controller admin API leveraging sparkjava: http://sparkjava.com/documentation.html

AdminSparkServer is shared by multiple clusters' controllers running in one physical Venice controller instance.

Nested Class Summary

Nested classes/interfaces inherited from class com.linkedin.venice.service.AbstractVeniceService

AbstractVeniceService.ServiceState

Field Summary

Fields

Modifier and Type	Field	Description
protected static final com.fasterxml.jackson.databind.ObjectMapper	OBJECT_MAPPER

Fields inherited from class com.linkedin.venice.service.AbstractVeniceService

logger, serviceState

Constructor Summary

Constructors

Constructor

Description

AdminSparkServer(int port, Admin admin, io.tehuti.metrics.MetricsRepository metricsRepository, Set<String> clusters, boolean enforceSSL, Optional<SSLConfig> sslConfig, boolean checkReadMethodForKafka, Optional<DynamicAccessController> accessController, List<ControllerRoute> disabledRoutes, VeniceProperties jettyConfigOverrides, boolean disableParentRequestTopicForStreamPushes, PubSubTopicRepository pubSubTopicRepository, VeniceControllerRequestHandler requestHandler)

Method Summary

Modifier and Type	Method	Description
protected static String	getOptionalParameterValue(spark.Request request, String parameter)
protected static String	getOptionalParameterValue(spark.Request request, String parameter, String defaultValue)
protected static void	handleError(Throwable e, spark.Request request, spark.Response response)
protected static void	handleError(Throwable e, spark.Request request, spark.Response response, boolean logErrorMessage)
boolean	startInner()
void	stopInner()
protected static void	validateParams(spark.Request request, List<String> requiredParams, Admin admin)

Methods inherited from class com.linkedin.venice.service.AbstractVeniceService

close, getName, isRunning, start, stop

Methods inherited from class java.lang.Object

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

Field Details

OBJECT_MAPPER

protected static final com.fasterxml.jackson.databind.ObjectMapper OBJECT_MAPPER

Constructor Details

AdminSparkServer

public AdminSparkServer(int port,
 Admin admin,
 io.tehuti.metrics.MetricsRepository metricsRepository,
 Set<String> clusters,
 boolean enforceSSL,
 Optional<SSLConfig> sslConfig,
 boolean checkReadMethodForKafka,
 Optional<DynamicAccessController> accessController,
 List<ControllerRoute> disabledRoutes,
 VeniceProperties jettyConfigOverrides,
 boolean disableParentRequestTopicForStreamPushes,
 PubSubTopicRepository pubSubTopicRepository,
 VeniceControllerRequestHandler requestHandler)

Method Details

startInner

public boolean startInner()
                   throws Exception

Specified by:

startInner in class AbstractVeniceService

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 AbstractVeniceService.serviceState to AbstractVeniceService.ServiceState.STARTED upon completion of the async work).

Throws:

Exception

stopInner

public void stopInner()

Specified by:

stopInner in class AbstractVeniceService

validateParams

protected static void validateParams(spark.Request request,
 List<String> requiredParams,
 Admin admin)

getOptionalParameterValue

protected static String getOptionalParameterValue(spark.Request request,
 String parameter)

getOptionalParameterValue

protected static String getOptionalParameterValue(spark.Request request,
 String parameter,
 String defaultValue)

handleError

protected static void handleError(Throwable e,
 spark.Request request,
 spark.Response response)

handleError

protected static void handleError(Throwable e,
 spark.Request request,
 spark.Response response,
 boolean logErrorMessage)