Netty 4.1.107.Final · io.netty.handler.codec.http.cors.CorsHandler

Modifier and Type	Field and Description
private static final String	ANY_ORIGIN
private CorsConfig	config
private final List<CorsConfig>	configList
private final boolean	isShortCircuit
private static final InternalLogger	logger
private static final String	NULL_ORIGIN
private HttpRequest	request

Access	Constructor and Description
public	CorsHandler(final CorsConfig config) Creates a new instance with a single `CorsConfig`.
public	CorsHandler(final List<CorsConfig> List of `CorsConfig` configList, boolean Same as `CorsConfig#isShortCircuit` but applicable to all supplied configs. isShortCircuit) Creates a new instance with the specified config list.

Method Summary

Modifier and Type	Method and Description
public void	channelRead(final ChannelHandlerContext ctx, final Object msg) Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelRead. Implements io.netty.channel.ChannelInboundHandler.channelRead. Calls `ChannelHandlerContext#fireChannelRead(Object)` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`.
private void	echoRequestOrigin(final HttpResponse response)
private static void	forbidden(final ChannelHandlerContext ctx, final HttpRequest request)
private CorsConfig	getForOrigin(String requestOrigin)
private void	handlePreflight(final ChannelHandlerContext ctx, final HttpRequest request)
private static boolean	isPreflightRequest(final HttpRequest request)
private static void	respond(final ChannelHandlerContext ctx, final HttpRequest request, final HttpResponse response)
private void	setAllowCredentials(final HttpResponse response)
private void	setAllowHeaders(final HttpResponse response)
private void	setAllowMethods(final HttpResponse response)
private void	setAllowPrivateNetwork(final HttpResponse response)
private static void	setAnyOrigin(final HttpResponse response)
private void	setExposeHeaders(final HttpResponse response)
private void	setMaxAge(final HttpResponse response)
private static void	setNullOrigin(final HttpResponse response)
private boolean	setOrigin(final HttpResponse response)
private static void	setOrigin(final HttpResponse response, final String origin)
private void	setPreflightHeaders(final HttpResponse the HttpResponse to which the preflight response headers should be added. response) This is a non CORS specification feature which enables the setting of preflight response headers that might be required by intermediaries.
private static void	setVaryHeader(final HttpResponse response)
public void	write(final ChannelHandlerContext the `ChannelHandlerContext` for which the write operation is made ctx, final Object the message to write msg, final ChannelPromise the `ChannelPromise` to notify once the operation completes promise) Overrides io.netty.channel.ChannelDuplexHandler.write. Implements io.netty.channel.ChannelOutboundHandler.write. Calls `ChannelHandlerContext#write(Object, ChannelPromise)` to forward to the next `ChannelOutboundHandler` in the `ChannelPipeline`.

Inherited from io.netty.channel.ChannelDuplexHandler:: bind close connect deregister disconnect flush read

ANY_ORIGIN	back to summary
private static final String ANY_ORIGIN

config	back to summary
private CorsConfig config

configList	back to summary
private final List<CorsConfig> configList

isShortCircuit	back to summary
private final boolean isShortCircuit

logger	back to summary
private static final InternalLogger logger

NULL_ORIGIN	back to summary
private static final String NULL_ORIGIN

request	back to summary
private HttpRequest request

CorsHandler	back to summary
public CorsHandler(final CorsConfig config) Creates a new instance with a single `CorsConfig`.

CorsHandler	back to summary
public CorsHandler(final List<CorsConfig> configList, boolean isShortCircuit) Creates a new instance with the specified config list. If more than one config matches a certain origin, the first in the List will be used. Parameters configList:List<CorsConfig> List of `CorsConfig` isShortCircuit:boolean Same as `CorsConfig#isShortCircuit` but applicable to all supplied configs.

Method Detail

channelRead back to summary

channelRead	back to summary
public void channelRead(final ChannelHandlerContext ctx, final Object msg) throws Exception Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelRead. Implements io.netty.channel.ChannelInboundHandler.channelRead. Doc from io.netty.channel.ChannelInboundHandlerAdapter.channelRead. Calls `ChannelHandlerContext#fireChannelRead(Object)` to forward to the next `ChannelInboundHandler` in the `ChannelPipeline`. Sub-classes may override this method to change behavior. Annotations @Override

public void channelRead(final ChannelHandlerContext ctx, final Object msg) throws Exception

Overrides io.netty.channel.ChannelInboundHandlerAdapter.channelRead.

Implements io.netty.channel.ChannelInboundHandler.channelRead.

Doc from io.netty.channel.ChannelInboundHandlerAdapter.channelRead.

Calls ChannelHandlerContext#fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Annotations

@Override

echoRequestOrigin	back to summary
private void echoRequestOrigin(final HttpResponse response)

forbidden	back to summary
private static void forbidden(final ChannelHandlerContext ctx, final HttpRequest request)

getForOrigin	back to summary
private CorsConfig getForOrigin(String requestOrigin)

handlePreflight	back to summary
private void handlePreflight(final ChannelHandlerContext ctx, final HttpRequest request)

isPreflightRequest	back to summary
private static boolean isPreflightRequest(final HttpRequest request)

respond	back to summary
private static void respond(final ChannelHandlerContext ctx, final HttpRequest request, final HttpResponse response)

setAllowCredentials	back to summary
private void setAllowCredentials(final HttpResponse response)

setAllowHeaders	back to summary
private void setAllowHeaders(final HttpResponse response)

setAllowMethods	back to summary
private void setAllowMethods(final HttpResponse response)

setAllowPrivateNetwork	back to summary
private void setAllowPrivateNetwork(final HttpResponse response)

setAnyOrigin	back to summary
private static void setAnyOrigin(final HttpResponse response)

setExposeHeaders	back to summary
private void setExposeHeaders(final HttpResponse response)

setMaxAge	back to summary
private void setMaxAge(final HttpResponse response)

setNullOrigin	back to summary
private static void setNullOrigin(final HttpResponse response)

setOrigin	back to summary
private boolean setOrigin(final HttpResponse response)

setOrigin	back to summary
private static void setOrigin(final HttpResponse response, final String origin)

setPreflightHeaders	back to summary
private void setPreflightHeaders(final HttpResponse response) This is a non CORS specification feature which enables the setting of preflight response headers that might be required by intermediaries. Parameters response:HttpResponse the HttpResponse to which the preflight response headers should be added.

setPreflightHeaders

back to summary

private void setPreflightHeaders(final HttpResponse response)

This is a non CORS specification feature which enables the setting of preflight response headers that might be required by intermediaries.

Parameters

response:HttpResponse: the HttpResponse to which the preflight response headers should be added.

setVaryHeader	back to summary
private static void setVaryHeader(final HttpResponse response)

write back to summary

write	back to summary
public void write(final ChannelHandlerContext ctx, final Object msg, final ChannelPromise promise) throws Exception Overrides io.netty.channel.ChannelDuplexHandler.write. Implements io.netty.channel.ChannelOutboundHandler.write. Doc from io.netty.channel.ChannelDuplexHandler.write. Calls `ChannelHandlerContext#write(Object, ChannelPromise)` to forward to the next `ChannelOutboundHandler` in the `ChannelPipeline`. Sub-classes may override this method to change behavior. Parameters ctx:ChannelHandlerContext Doc from io.netty.channel.ChannelOutboundHandler.write. the `ChannelHandlerContext` for which the write operation is made msg:Object Doc from io.netty.channel.ChannelOutboundHandler.write. the message to write promise:ChannelPromise Doc from io.netty.channel.ChannelOutboundHandler.write. the `ChannelPromise` to notify once the operation completes Annotations @Override Exceptions Exception: Doc from io.netty.channel.ChannelOutboundHandler.write. thrown if an error occurs