io.netty.handler.codec.http.cors

Class CorsHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.handler.codec.http.cors.CorsHandler

All Implemented Interfaces:

ChannelHandler

public class CorsHandler
extends ChannelHandlerAdapter

Handles Cross Origin Resource Sharing (CORS) requests.

This handler can be configured using a CorsConfig, please refer to this class for details about the configuration options available.

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

ChannelHandler.Sharable, ChannelHandler.Skip

Constructor Summary

Constructors

Constructor and Description
CorsHandler(CorsConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
void	channelRead(ChannelHandlerContext ctx, Object msg) Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelHandler in the ChannelPipeline.
void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause) Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline.
void	write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) Calls ChannelHandlerContext.write(Object) to forward to the next ChannelHandler in the ChannelPipeline.

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

bind, channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, close, connect, deregister, disconnect, flush, handlerAdded, handlerRemoved, isSharable, read, userEventTriggered

Methods inherited from class java.lang.Object

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

Constructor Detail

CorsHandler

public CorsHandler(CorsConfig config)

Method Detail

channelRead

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

Description copied from class: ChannelHandlerAdapter

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

Specified by:

channelRead in interface ChannelHandler

Overrides:

channelRead in class ChannelHandlerAdapter

Throws:

Exception

write

public void write(ChannelHandlerContext ctx,
         Object msg,
         ChannelPromise promise)
           throws Exception

Description copied from class: ChannelHandlerAdapter

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

Specified by:

write in interface ChannelHandler

Overrides:

write in class ChannelHandlerAdapter

Parameters:

ctx - the ChannelHandlerContext for which the write operation is made

msg - the message to write

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - thrown if an error accour

exceptionCaught

public void exceptionCaught(ChannelHandlerContext ctx,
                   Throwable cause)
                     throws Exception

Description copied from class: ChannelHandlerAdapter

Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

exceptionCaught in interface ChannelHandler

Overrides:

exceptionCaught in class ChannelHandlerAdapter

Throws:

Exception