io.netty.example.http.cors

Class HttpCorsServerInitializer

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelInitializer<SocketChannel>

io.netty.example.http.cors.HttpCorsServerInitializer

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

public class HttpCorsServerInitializer
extends ChannelInitializer<SocketChannel>

Please refer to the CorsConfig javadocs for information about all the configuration options available. Below are some of configuration discussed in this example:

Support only a specific origin

To support a single origin instead of the wildcard use the following:

 CorsConfig corsConfig = CorsConfig.withOrigin("http://domain1.com")
 

Enable loading from the file system

To enable the server to handle an origin specified as 'null', which happens when a web browser loads a file from the local file system use the following:

 corsConfig.isNullOriginAllowed()
 

Enable request headers

To enable additional request headers:

 corsConfig.allowedRequestHeaders("custom-request-header")
 

Expose response headers

By default a browser only exposes the following simple header:

• Cache-Control
• Content-Language
• Content-Type
• Expires
• Last-Modified
• Pragma

Any of the above response headers can be retrieved by:

 xhr.getResponseHeader("Content-Type");
 

If you need to get access to other headers this must be enabled by the server, for example:

 corsConfig.exposedHeaders("custom-response-header");
 

Nested Class Summary

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

ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
HttpCorsServerInitializer(SslContext sslCtx)

Method Summary

Modifier and Type	Method and Description
void	initChannel(SocketChannel ch) This method will be called once the Channel was registered.

Methods inherited from class io.netty.channel.ChannelInitializer

channelRegistered, exceptionCaught, handlerAdded

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelRead, channelReadComplete, channelUnregistered, channelWritabilityChanged, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

handlerRemoved

Constructor Detail

HttpCorsServerInitializer

public HttpCorsServerInitializer(SslContext sslCtx)

Method Detail

initChannel

public void initChannel(SocketChannel ch)

Description copied from class: ChannelInitializer

This method will be called once the Channel was registered. After the method returns this instance will be removed from the ChannelPipeline of the Channel.

Specified by:

initChannel in class ChannelInitializer<SocketChannel>

Parameters:

ch - the Channel which was registered.