org.apache.flink.table.gateway.rest.header.util

Class UrlPrefixDecorator<R extends RequestBody,P extends ResponseBody,M extends MessageParameters>

java.lang.Object

org.apache.flink.table.gateway.rest.header.util.UrlPrefixDecorator<R,P,M>

Type Parameters:

R - the type of the request body

P - the type of the response body

M - the type of the message parameters

All Implemented Interfaces:

RestHandlerSpecification, MessageHeaders<R,P,M>, UntypedResponseMessageHeaders<R,M>, SqlGatewayMessageHeaders<R,P,M>

public class UrlPrefixDecorator<R extends RequestBody,P extends ResponseBody,M extends MessageParameters>
extends Object
implements SqlGatewayMessageHeaders<R,P,M>

This class decorates the URL of the original message headers by adding a prefix. The purpose of this decorator is to provide a consistent URL prefix for all the REST API endpoints while preserving the behavior of the original message headers.

Constructor Summary

Constructors

Constructor and Description
UrlPrefixDecorator(MessageHeaders<R,P,M> messageHeaders, String urlPrefix) Constructs an instance of UrlPrefixDecorator.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns the description for this header.
HttpMethodWrapper	getHttpMethod() Returns the HttpMethodWrapper to be used for the request.
Class<R>	getRequestClass() Returns the class of the request message.
Class<P>	getResponseClass() Returns the class of the response message.
org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponseStatus	getResponseStatusCode() Returns the http status code for the response.
String	getTargetRestEndpointURL() Returns the generalized endpoint url that this request should be sent to, for example /job/:jobid.
M	getUnresolvedMessageParameters() Returns a new MessageParameters object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.table.gateway.rest.header.SqlGatewayMessageHeaders

getSupportedAPIVersions

Methods inherited from interface org.apache.flink.runtime.rest.messages.MessageHeaders

getCustomHeaders, getResponseTypeParameters, operationId

Methods inherited from interface org.apache.flink.runtime.rest.messages.UntypedResponseMessageHeaders

acceptsFileUploads

Constructor Detail

UrlPrefixDecorator

public UrlPrefixDecorator(MessageHeaders<R,P,M> messageHeaders,
                          String urlPrefix)

Constructs an instance of UrlPrefixDecorator.

Parameters:

messageHeaders - the original SqlGatewayMessageHeaders to be decorated

urlPrefix - the URL prefix to be added to the target REST endpoint URL

Method Detail

getHttpMethod

public HttpMethodWrapper getHttpMethod()

Description copied from interface: RestHandlerSpecification

Returns the HttpMethodWrapper to be used for the request.

Specified by:

getHttpMethod in interface RestHandlerSpecification

Returns:

http method to be used for the request

getTargetRestEndpointURL

public String getTargetRestEndpointURL()

Description copied from interface: RestHandlerSpecification

Returns the generalized endpoint url that this request should be sent to, for example /job/:jobid.

Specified by:

getTargetRestEndpointURL in interface RestHandlerSpecification

Returns:

endpoint url that this request should be sent to

getResponseClass

public Class<P> getResponseClass()

Description copied from interface: MessageHeaders

Returns the class of the response message.

Specified by:

getResponseClass in interface MessageHeaders<R extends RequestBody,P extends ResponseBody,M extends MessageParameters>

Returns:

class of the response message

getResponseStatusCode

public org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponseStatus getResponseStatusCode()

Description copied from interface: MessageHeaders

Returns the http status code for the response.

Specified by:

getResponseStatusCode in interface MessageHeaders<R extends RequestBody,P extends ResponseBody,M extends MessageParameters>

Returns:

http status code of the response

getDescription

public String getDescription()

Description copied from interface: MessageHeaders

Returns the description for this header.

Specified by:

getDescription in interface MessageHeaders<R extends RequestBody,P extends ResponseBody,M extends MessageParameters>

Returns:

description for the header

getRequestClass

public Class<R> getRequestClass()

Description copied from interface: UntypedResponseMessageHeaders

Returns the class of the request message.

Specified by:

getRequestClass in interface UntypedResponseMessageHeaders<R extends RequestBody,M extends MessageParameters>

Returns:

class of the request message

getUnresolvedMessageParameters

public M getUnresolvedMessageParameters()

Description copied from interface: UntypedResponseMessageHeaders

Returns a new MessageParameters object.

Specified by:

getUnresolvedMessageParameters in interface UntypedResponseMessageHeaders<R extends RequestBody,M extends MessageParameters>

Returns:

new message parameters object