org.apache.flink.runtime.rest.messages

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

java.lang.Object

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

所有已实现的接口:

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.

构造器概要

构造器

构造器和说明
CustomHeadersDecorator(MessageHeaders<R,P,M> decorated) Creates a new CustomHeadersDecorator for a given MessageHeaders object.

方法概要

限定符和类型	方法和说明
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.

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.apache.flink.runtime.rest.messages.MessageHeaders

operationId

从接口继承的方法 org.apache.flink.runtime.rest.messages.UntypedResponseMessageHeaders

acceptsFileUploads

构造器详细资料

CustomHeadersDecorator

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

Creates a new CustomHeadersDecorator for a given MessageHeaders object.

参数:

decorated - The MessageHeaders to decorate.

方法详细资料

getHttpMethod

public HttpMethodWrapper getHttpMethod()

从接口复制的说明: RestHandlerSpecification

Returns the HttpMethodWrapper to be used for the request.

指定者:

getHttpMethod 在接口中 RestHandlerSpecification

返回:

http method to be used for the request

getTargetRestEndpointURL

public String getTargetRestEndpointURL()

从接口复制的说明: RestHandlerSpecification

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

指定者:

getTargetRestEndpointURL 在接口中 RestHandlerSpecification

返回:

endpoint url that this request should be sent to

getSupportedAPIVersions

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

从接口复制的说明: RestHandlerSpecification

Returns the supported API versions that this request supports.

指定者:

getSupportedAPIVersions 在接口中 RestHandlerSpecification

返回:

Collection of supported API versions

getResponseClass

public Class<P> getResponseClass()

从接口复制的说明: MessageHeaders

Returns the class of the response message.

指定者:

getResponseClass 在接口中 MessageHeaders<R extends RequestBody,P extends ResponseBody,M extends MessageParameters>

返回:

class of the response message

getResponseStatusCode

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

从接口复制的说明: MessageHeaders

Returns the http status code for the response.

指定者:

getResponseStatusCode 在接口中 MessageHeaders<R extends RequestBody,P extends ResponseBody,M extends MessageParameters>

返回:

http status code of the response

getDescription

public String getDescription()

从接口复制的说明: MessageHeaders

Returns the description for this header.

指定者:

getDescription 在接口中 MessageHeaders<R extends RequestBody,P extends ResponseBody,M extends MessageParameters>

返回:

description for the header

getRequestClass

public Class<R> getRequestClass()

从接口复制的说明: UntypedResponseMessageHeaders

Returns the class of the request message.

指定者:

getRequestClass 在接口中 UntypedResponseMessageHeaders<R extends RequestBody,M extends MessageParameters>

返回:

class of the request message

getUnresolvedMessageParameters

public M getUnresolvedMessageParameters()

从接口复制的说明: UntypedResponseMessageHeaders

Returns a new MessageParameters object.

指定者:

getUnresolvedMessageParameters 在接口中 UntypedResponseMessageHeaders<R extends RequestBody,M extends MessageParameters>

返回:

new message parameters object

getCustomHeaders

public Collection<HttpHeader> getCustomHeaders()

Returns the custom headers added to the message.

指定者:

getCustomHeaders 在接口中 MessageHeaders<R extends RequestBody,P extends ResponseBody,M extends MessageParameters>

返回:

The custom headers as a collection of HttpHeader.

getResponseTypeParameters

public Collection<Class<?>> getResponseTypeParameters()

从接口复制的说明: MessageHeaders

Returns the collection of type parameters for the response type.

指定者:

getResponseTypeParameters 在接口中 MessageHeaders<R extends RequestBody,P extends ResponseBody,M extends MessageParameters>

返回:

Collection of type parameters for the response type

setCustomHeaders

public void setCustomHeaders(Collection<HttpHeader> customHeaders)

Sets the custom headers for the message.

参数:

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.

参数:

httpHeader - The header to add.

getDecorated

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