org.apache.flink.runtime.rest.messages

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

java.lang.Object

org.apache.flink.runtime.rest.messages.CustomHeadersDecorator<R,P,M>

All Implemented Interfaces:

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

public class CustomHeadersDecorator<R extends RequestBody,P extends ResponseBody,M extends MessageParameters>
extends Object
implements MessageHeaders<R,P,M>

Decorator class for MessageHeaders that adds the ability to include custom HTTP headers.

Constructor Summary

Constructors

Constructor and Description
CustomHeadersDecorator(MessageHeaders<R,P,M> decorated) Creates a new CustomHeadersDecorator for a given MessageHeaders object.

Method Summary

Modifier and Type	Method and Description
void	addCustomHeader(HttpHeader httpHeader) Adds a custom header to the message.
Collection<HttpHeader>	getCustomHeaders() Returns the custom headers added to the message.
MessageHeaders<R,P,M>	getDecorated()
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.
Collection<Class<?>>	getResponseTypeParameters() Returns the collection of type parameters for the response type.
Collection<? extends RestAPIVersion<?>>	getSupportedAPIVersions() Returns the supported API versions that this request supports.
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.
void	setCustomHeaders(Collection<HttpHeader> customHeaders) Sets the custom headers for the message.

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.runtime.rest.messages.MessageHeaders

operationId

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

acceptsFileUploads

Constructor Detail

CustomHeadersDecorator

public CustomHeadersDecorator(MessageHeaders<R,P,M> decorated)

Creates a new CustomHeadersDecorator for a given MessageHeaders object.

Parameters:

decorated - The MessageHeaders to decorate.

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

getSupportedAPIVersions

public Collection<? extends RestAPIVersion<?>> getSupportedAPIVersions()

Description copied from interface: RestHandlerSpecification

Returns the supported API versions that this request supports.

Specified by:

getSupportedAPIVersions in interface RestHandlerSpecification

Returns:

Collection of supported API versions

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

getCustomHeaders

public Collection<HttpHeader> getCustomHeaders()

Returns the custom headers added to the message.

Specified by:

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

Returns:

The custom headers as a collection of HttpHeader.

getResponseTypeParameters

public Collection<Class<?>> getResponseTypeParameters()

Description copied from interface: MessageHeaders

Returns the collection of type parameters for the response type.

Specified by:

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

Returns:

Collection of type parameters for the response type

setCustomHeaders

public void setCustomHeaders(Collection<HttpHeader> customHeaders)

Sets the custom headers for the message.

Parameters:

customHeaders - A collection of custom headers.

addCustomHeader

public void addCustomHeader(HttpHeader httpHeader)

Adds a custom header to the message. Initializes the custom headers collection if it hasn't been initialized yet.

Parameters:

httpHeader - The header to add.

getDecorated

public MessageHeaders<R,P,M> getDecorated()