io.cdap.http

Class NettyHttpService.Builder

java.lang.Object

io.cdap.http.NettyHttpService.Builder

Enclosing class:

NettyHttpService

public static class NettyHttpService.Builder
extends Object

Builder to help create the NettyHttpService.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder(String serviceName)

Method Summary

Modifier and Type	Method and Description
NettyHttpService	build()
NettyHttpService.Builder	enableSSL(SSLConfig sslConfig) Enable SSL by using the provided SSL information.
NettyHttpService.Builder	enableSSL(SSLHandlerFactory sslHandlerFactory) Enable SSL by using the given SSLHandlerFactory to create SslHandler.
NettyHttpService.Builder	setAuthHandler(AuthHandler authHandler) Add the AuthHandler that performs the checks for methods annotated by Secured and RequiredRoles.
NettyHttpService.Builder	setBossThreadPoolSize(int bossThreadPoolSize) Set size of bossThreadPool in netty default value is 1 if it is not set.
NettyHttpService.Builder	setChannelConfig(io.netty.channel.ChannelOption<?> channelOption, Object value) Sets channel configuration for the netty service.
NettyHttpService.Builder	setChannelPipelineModifier(ChannelPipelineModifier pipelineModifier) Sets the ChannelPipelineModifier to use for modifying ChannelPipeline on new Channel registration.
NettyHttpService.Builder	setChildChannelConfig(io.netty.channel.ChannelOption<?> channelOption, Object value) Sets channel configuration for the child socket channel for the netty service.
NettyHttpService.Builder	setConnectionBacklog(int connectionBacklog) Set size of backlog in netty service - size of accept queue of the TCP stack.
NettyHttpService.Builder	setExceptionHandler(ExceptionHandler exceptionHandler) Set the ExceptionHandler for the service.
NettyHttpService.Builder	setExecThreadKeepAliveSeconds(long threadKeepAliveSecs) Set the maximum time that excess idle threads will wait for new tasks before terminating.
NettyHttpService.Builder	setExecThreadPoolSize(int execThreadPoolSize) Set size of executorThreadPool in netty default value is 60 if it is not set.
NettyHttpService.Builder	setHandlerHooks(Iterable<? extends HandlerHook> handlerHooks) Set HandlerHooks to be executed pre and post handler calls.
NettyHttpService.Builder	setHost(String host) Set the bindAddress for the service.
NettyHttpService.Builder	setHttpChunkLimit(int value) Set the HTTP chunk limit.
NettyHttpService.Builder	setHttpHandlers(HttpHandler... handlers) Add HttpHandlers that service the request.
NettyHttpService.Builder	setHttpHandlers(Iterable<? extends HttpHandler> handlers) Add HttpHandlers that service the request.
NettyHttpService.Builder	setPort(int port) Set the port on which the service should listen to.
NettyHttpService.Builder	setRejectedExecutionHandler(RejectedExecutionHandler rejectedExecutionHandler) Set RejectedExecutionHandler - rejection policy for executor.
NettyHttpService.Builder	setUrlRewriter(URLRewriter urlRewriter) Set URLRewriter to re-write URL of an incoming request before any handlers or their hooks are called.
NettyHttpService.Builder	setWorkerThreadPoolSize(int workerThreadPoolSize) Set size of workerThreadPool in netty default value is 10 if it is not set.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

protected Builder(String serviceName)

Method Detail

setAuthHandler

public NettyHttpService.Builder setAuthHandler(AuthHandler authHandler)

Add the AuthHandler that performs the checks for methods annotated by Secured and RequiredRoles.

Parameters:

authHandler - the handler to add

Returns:

instance of Builder.

setChannelPipelineModifier

public NettyHttpService.Builder setChannelPipelineModifier(ChannelPipelineModifier pipelineModifier)

Sets the ChannelPipelineModifier to use for modifying ChannelPipeline on new Channel registration.

Parameters:

pipelineModifier - the modifier to use

Returns:

this builder instance.

setHttpHandlers

public NettyHttpService.Builder setHttpHandlers(Iterable<? extends HttpHandler> handlers)

Add HttpHandlers that service the request.

Parameters:

handlers - Iterable of HttpHandlers.

Returns:

instance of Builder.

setHttpHandlers

public NettyHttpService.Builder setHttpHandlers(HttpHandler... handlers)

Add HttpHandlers that service the request.

Parameters:

handlers - a list of HttpHandlers to add

Returns:

instance of Builder.

setHandlerHooks

public NettyHttpService.Builder setHandlerHooks(Iterable<? extends HandlerHook> handlerHooks)

Set HandlerHooks to be executed pre and post handler calls. They are executed in the same order as specified by the iterable.

Parameters:

handlerHooks - Iterable of HandlerHooks.

Returns:

an instance of Builder.

setUrlRewriter

public NettyHttpService.Builder setUrlRewriter(URLRewriter urlRewriter)

Set URLRewriter to re-write URL of an incoming request before any handlers or their hooks are called.

Parameters:

urlRewriter - instance of URLRewriter.

Returns:

an instance of Builder.

setBossThreadPoolSize

public NettyHttpService.Builder setBossThreadPoolSize(int bossThreadPoolSize)

Set size of bossThreadPool in netty default value is 1 if it is not set.

Parameters:

bossThreadPoolSize - size of bossThreadPool.

Returns:

an instance of Builder.

setWorkerThreadPoolSize

public NettyHttpService.Builder setWorkerThreadPoolSize(int workerThreadPoolSize)

Set size of workerThreadPool in netty default value is 10 if it is not set.

Parameters:

workerThreadPoolSize - size of workerThreadPool.

Returns:

an instance of Builder.

setConnectionBacklog

public NettyHttpService.Builder setConnectionBacklog(int connectionBacklog)

Set size of backlog in netty service - size of accept queue of the TCP stack.

Parameters:

connectionBacklog - backlog in netty server. Default value is 1000.

Returns:

an instance of Builder.

setChannelConfig

public NettyHttpService.Builder setChannelConfig(io.netty.channel.ChannelOption<?> channelOption,
                                                 Object value)

Sets channel configuration for the netty service.

Parameters:

channelOption - the ChannelOption to set

value - Value of the configuration.

Returns:

an instance of Builder.

See Also:

ChannelConfig, ServerSocketChannelConfig

setChildChannelConfig

public NettyHttpService.Builder setChildChannelConfig(io.netty.channel.ChannelOption<?> channelOption,
                                                      Object value)

Sets channel configuration for the child socket channel for the netty service.

Parameters:

channelOption - the ChannelOption to set

value - Value of the configuration.

Returns:

an instance of Builder.

See Also:

ChannelConfig, ServerSocketChannelConfig

setExecThreadPoolSize

public NettyHttpService.Builder setExecThreadPoolSize(int execThreadPoolSize)

Set size of executorThreadPool in netty default value is 60 if it is not set. If the size is <= 0, then no executor will be used, hence calls to HttpHandler would be made from worker threads directly.

Parameters:

execThreadPoolSize - size of workerThreadPool.

Returns:

an instance of Builder.

setExecThreadKeepAliveSeconds

public NettyHttpService.Builder setExecThreadKeepAliveSeconds(long threadKeepAliveSecs)

Set the maximum time that excess idle threads will wait for new tasks before terminating. Default value is 60 seconds. If the value is <= 0, then idle threads will not be terminated.

Parameters:

threadKeepAliveSecs - thread keep alive seconds.

Returns:

an instance of Builder.

setRejectedExecutionHandler

public NettyHttpService.Builder setRejectedExecutionHandler(RejectedExecutionHandler rejectedExecutionHandler)

Set RejectedExecutionHandler - rejection policy for executor.

Parameters:

rejectedExecutionHandler - rejectionExecutionHandler.

Returns:

an instance of Builder.

setPort

public NettyHttpService.Builder setPort(int port)

Set the port on which the service should listen to. By default the service will run on a random port.

Parameters:

port - port on which the service should listen to.

Returns:

instance of Builder.

setHost

public NettyHttpService.Builder setHost(String host)

Set the bindAddress for the service. Default value is localhost.

Parameters:

host - bindAddress for the service.

Returns:

instance of Builder.

setHttpChunkLimit

public NettyHttpService.Builder setHttpChunkLimit(int value)

Set the HTTP chunk limit.

Parameters:

value - the chunk limit

Returns:

instance of Builder.

enableSSL

public NettyHttpService.Builder enableSSL(SSLConfig sslConfig)

Enable SSL by using the provided SSL information.

Parameters:

sslConfig - the SSL configuration

Returns:

instance of Builder.

enableSSL

public NettyHttpService.Builder enableSSL(SSLHandlerFactory sslHandlerFactory)

Enable SSL by using the given SSLHandlerFactory to create SslHandler.

Parameters:

sslHandlerFactory - the factory for creating SslHandlers

Returns:

instance of Builder.

setExceptionHandler

public NettyHttpService.Builder setExceptionHandler(ExceptionHandler exceptionHandler)

Set the ExceptionHandler for the service.

Parameters:

exceptionHandler - the exception handler to use

Returns:

instance of Builder.

build

public NettyHttpService build()

Returns:

instance of NettyHttpService