Package com.linkedin.venice.controller.server

Class VeniceRouteHandler<T extends ControllerResponse>

java.lang.Object

com.linkedin.venice.controller.server.VeniceRouteHandler<T>

Type Parameters:

T -

All Implemented Interfaces:

spark.Route

public abstract class VeniceRouteHandler<T extends ControllerResponse>
extends Object
implements spark.Route

Common route handler implement the common part of error handling and writing response to json.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACL_CHECK_FAILURE_WARN_MESSAGE_PREFIX

Constructor Summary

Constructors

Constructor	Description
VeniceRouteHandler(Class<T> responseType)

Method Summary

Modifier and Type	Method	Description
protected boolean	checkIsAllowListUser(spark.Request request, ControllerResponse veniceResponse, BooleanSupplier isAllowListUser)
Object	handle(spark.Request request, spark.Response response)
abstract void	internalHandle(spark.Request request, T veniceResponse)	provides a common way to write a handler function for an HTTP request and fill in the HTTP response.

Methods inherited from class java.lang.Object

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

Field Details

ACL_CHECK_FAILURE_WARN_MESSAGE_PREFIX

public static final String ACL_CHECK_FAILURE_WARN_MESSAGE_PREFIX

See Also:

• Constant Field Values

Constructor Details

VeniceRouteHandler

public VeniceRouteHandler(Class<T> responseType)

Method Details

handle

public Object handle(spark.Request request,
 spark.Response response)
              throws Exception

Specified by:

handle in interface spark.Route

Throws:

Exception

checkIsAllowListUser

protected boolean checkIsAllowListUser(spark.Request request,
 ControllerResponse veniceResponse,
 BooleanSupplier isAllowListUser)

internalHandle

public abstract void internalHandle(spark.Request request,
 T veniceResponse)

provides a common way to write a handler function for an HTTP request and fill in the HTTP response.

Parameters:

request - HTTP request for Venice.

veniceResponse - Venice constructed response.