org.atmosphere.nettosphere

Class Config.Builder

java.lang.Object

org.atmosphere.nettosphere.Config.Builder

Enclosing class:

Config

public static final class Config.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Config.Builder	aggregateRequestBodyInMemory(boolean aggregateRequestBodyInMemory) By default, Nettosphere aggregate the HTTP request's body in memory an invoke an Atmosphere's components with a single AtmosphereResource.
Config.Builder	binaryWrite(boolean binaryWrite) Write binary frame when websocket transport is used.
Config.Builder	bossExecutor(java.util.concurrent.ExecutorService bossExecutor) The Executor to be used in providing (the) I/O boss-thread(s).
Config.Builder	broadcaster(java.lang.Class<? extends org.atmosphere.cpr.Broadcaster> broadcasterClass) Configure the default Broadcaster
Config.Builder	broadcasterCache(java.lang.Class<? extends org.atmosphere.cpr.BroadcasterCache> broadcasterCache) Configure the default BroadcasterCache
Config.Builder	broadcasterFactory(org.atmosphere.cpr.BroadcasterFactory broadcasterFactory) Configure the default BroadcasterFactory
Config	build() Build an instance of this class.
Config.Builder	channelUpstreamHandler(io.netty.channel.ChannelInboundHandler h) Add a ChannelInboundHandler.
Config.Builder	configFile(java.lang.String atmosphereDotXmlPath) The path location of the atmosphere.xml file.
Config.Builder	enabledCipherSuites(java.lang.String[] cipherSuitesToEnable) Set a String[] of cipher suites to be enabled.
Config.Builder	enablePong(boolean enablePong) Enable WebSokcet Pong message.
Config.Builder	epoll(boolean epoll) Use EpollEventLoopGroup
Config.Builder	excludeInterceptor(java.lang.String interceptor) Exclude an AtmosphereInterceptor from being added, at startup, by Atmosphere.
Config.Builder	host(java.lang.String host) The server's host
Config.Builder	initParam(java.lang.String name, java.lang.String value) Add some init param
Config.Builder	interceptor(org.atmosphere.cpr.AtmosphereInterceptor interceptor) Add an AtmosphereInterceptor
Config.Builder	ioExceptionHandler(IOExceptionHandler ioExceptionHandler) Set an IOExceptionHandler to handle unexpected I/O exception
Config.Builder	mappingPath(java.lang.String mappingPath) Set the mapping path.
Config.Builder	maxChunkContentLength(int maxChunkContentLength) When aggregateRequestBodyInMemory is true,the maximum length of the aggregated content.
Config.Builder	maxWebSocketFrameSize(int maxWebSocketFrameSize) Set the maximum WebSocket Frame Size.
Config.Builder	noInternalAlloc(boolean noInternalAlloc) Proxy AtmosphereRequest, AtmosphereResource and AtmosphereRequest with no ops implementations.
Config.Builder	port(int port) The server's port
Config.Builder	resource(java.lang.Class<?> c) Add an annotated class.
Config.Builder	resource(Handler handler) Add an Handler mapped to the default, which is '/*'
Config.Builder	resource(java.lang.String path) Add a path to scan when looking for static resources like javascript file, html, etc.
Config.Builder	resource(java.lang.String path, org.atmosphere.cpr.AtmosphereHandler c) Add an AtmosphereHandler that will be mapped to the specified path
Config.Builder	resource(java.lang.String path, java.lang.Class<?> c) Add an AtmosphereHandler or Servlet class
Config.Builder	resource(java.lang.String path, Handler handler) Add an Handler that will be mapped to the specified path
Config.Builder	resource(java.lang.String path, javax.servlet.Servlet c) Add an Servlet that will be mapped to the specified path
Config.Builder	resource(java.lang.String path, org.atmosphere.websocket.WebSocketHandler c) Add an WebSocketHandler that will be mapped to the specified path
Config.Builder	scanLibrary(java.lang.String librariesPath) Set the path to the library when annotation scanning is enabled.
Config.Builder	servletContextAttribute(java.lang.String name, java.lang.Object value) Set ServletContext Attribute
Config.Builder	shareHeaders(boolean shareHeaders) Share underlying headers map with newly created WebSocket.
Config.Builder	socketKeepAlive(boolean socketKeepAlive) Set Netty's Bootstrap 'child.keepAlive'
Config.Builder	socketNoTcpDelay(boolean socketNoTcpDelay) Set Netty's Bootstrap 'child.tcpDelay'
Config.Builder	sslContext(io.netty.handler.ssl.SslContext sslContext) Set the SslContext
Config.Builder	sslContext(javax.net.ssl.SSLContext context) Set an SSLContext in order enable SSL
Config.Builder	sslContextListener(SSLContextListener listener) Add a SSLContextListener
Config.Builder	subProtocols(java.lang.String subProtocols) A coma delimited of allowed WebSocket Sub Protocol (Sec-WebSocket-Protocol)
Config.Builder	supportChunking(boolean supportChunking) Set to false to override the default behavior when writing bytes, which is use chunking.
Config.Builder	textFrameAsBinary(boolean textFrameAsBinary) Do not decode TextWebSocketFrame into a String and instead pass it to the WebSocketProcessor as binary.
Config.Builder	webSocketOnly(boolean webSocketOnly) Only Support WebSocket.
Config.Builder	webSocketProtocol(java.lang.Class<? extends org.atmosphere.websocket.WebSocketProtocol> webSocketProtocol) Configure the default WebSocketProtocol
Config.Builder	workerExecutor(java.util.concurrent.ExecutorService workerExecutor) The Executor to be used in providing (the) I/O worker-thread(s).

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

shareHeaders

public Config.Builder shareHeaders(boolean shareHeaders)

Share underlying headers map with newly created WebSocket. Best used when noInternalAlloc is set to true. Default is false

Parameters:

shareHeaders -

Returns:

sslContext

public Config.Builder sslContext(javax.net.ssl.SSLContext context)

Set an SSLContext in order enable SSL

Parameters:

context -

Returns:

this

enabledCipherSuites

public Config.Builder enabledCipherSuites(java.lang.String[] cipherSuitesToEnable)

Set a String[] of cipher suites to be enabled.

Parameters:

String-array - of cipher suites to be enabled.

Returns:

this

sslContext

public Config.Builder sslContext(io.netty.handler.ssl.SslContext sslContext)

Set the SslContext

Parameters:

sslContext -

Returns:

this

maxWebSocketFrameSize

public Config.Builder maxWebSocketFrameSize(int maxWebSocketFrameSize)

Set the maximum WebSocket Frame Size. Default is 65536

Parameters:

maxWebSocketFrameSize - the maximum WebSocket Frame Size.

Returns:

this

sslContextListener

public Config.Builder sslContextListener(SSLContextListener listener)

Add a SSLContextListener

Parameters:

listener -

Returns:

this

mappingPath

public Config.Builder mappingPath(java.lang.String mappingPath)

Set the mapping path. If you have worked with Servlet, the mapping path is equivalent to the servlet path.

Parameters:

mappingPath - the path under which the application will be mapped.

Returns:

this

enablePong

public Config.Builder enablePong(boolean enablePong)

Enable WebSokcet Pong message. Disabled by default.

Parameters:

enablePong - Enable WebSokcet Pong message

Returns:

this

maxChunkContentLength

public Config.Builder maxChunkContentLength(int maxChunkContentLength)

When aggregateRequestBodyInMemory is true,the maximum length of the aggregated content. If the length of the aggregated content exceeds this value, a TooLongFrameException will be raised.

Returns:

this

scanLibrary

public Config.Builder scanLibrary(java.lang.String librariesPath)

Set the path to the library when annotation scanning is enabled. Default is "./". Use this method when your annotated resource is packaged inside the jar/zip.

Parameters:

librariesPath - the path to the library when annotation scanning is enabled.

Returns:

this

configFile

public Config.Builder configFile(java.lang.String atmosphereDotXmlPath)

The path location of the atmosphere.xml file.

Parameters:

atmosphereDotXmlPath - path location of the atmosphere.xml file.

Returns:

this

bossExecutor

public Config.Builder bossExecutor(java.util.concurrent.ExecutorService bossExecutor)

The Executor to be used in providing (the) I/O boss-thread(s).

Parameters:

bossExecutor - ExecutorService to be used for boss threads.

Returns:

this

workerExecutor

public Config.Builder workerExecutor(java.util.concurrent.ExecutorService workerExecutor)

The Executor to be used in providing (the) I/O worker-thread(s).

Parameters:

workerExecutor - ExecutorService to be used for worker threads.

Returns:

this

host

public Config.Builder host(java.lang.String host)

The server's host

Parameters:

host - server's host

Returns:

this

port

public Config.Builder port(int port)

The server's port

Parameters:

port - server's port

Returns:

this

initParam

public Config.Builder initParam(java.lang.String name,
                                java.lang.String value)

Add some init param

Parameters:

name - the name

value - the value

Returns:

this

resource

public Config.Builder resource(java.lang.String path)

Add a path to scan when looking for static resources like javascript file, html, etc.

Parameters:

path -

Returns:

this

resource

public Config.Builder resource(java.lang.String path,
                               org.atmosphere.cpr.AtmosphereHandler c)

Add an AtmosphereHandler that will be mapped to the specified path

Parameters:

path - a mapping path

c - an AtmosphereHandler

Returns:

this

resource

public Config.Builder resource(java.lang.String path,
                               org.atmosphere.websocket.WebSocketHandler c)

Add an WebSocketHandler that will be mapped to the specified path

Parameters:

path - a mapping path

c - an AtmosphereHandler

Returns:

this

resource

public Config.Builder resource(java.lang.String path,
                               javax.servlet.Servlet c)

Add an Servlet that will be mapped to the specified path

Parameters:

path - a mapping path

c - an Servlet

Returns:

this

resource

public Config.Builder resource(Handler handler)

Add an Handler mapped to the default, which is '/*'

Parameters:

handler - Handler

Returns:

this

resource

public Config.Builder resource(java.lang.String path,
                               Handler handler)

Add an Handler that will be mapped to the specified path

Parameters:

handler - Handler

Returns:

this

resource

public Config.Builder resource(java.lang.Class<?> c)

Add an annotated class. The annotation can be from Atmosphere or Jersey.

Parameters:

c - an annotated class. The annotation can be from Atmosphere or Jersey.

Returns:

this

resource

public Config.Builder resource(java.lang.String path,
                               java.lang.Class<?> c)

Add an AtmosphereHandler or Servlet class

Parameters:

path - a mapping path

c - an AtmosphereHandler or Servlet class

Returns:

this

broadcaster

public Config.Builder broadcaster(java.lang.Class<? extends org.atmosphere.cpr.Broadcaster> broadcasterClass)

Configure the default Broadcaster

Parameters:

broadcasterClass - a Broadcaster

Returns:

this

broadcasterFactory

public Config.Builder broadcasterFactory(org.atmosphere.cpr.BroadcasterFactory broadcasterFactory)

Configure the default BroadcasterFactory

Parameters:

broadcasterFactory - a BroadcasterFactory's class

Returns:

this

broadcasterCache

public Config.Builder broadcasterCache(java.lang.Class<? extends org.atmosphere.cpr.BroadcasterCache> broadcasterCache)

Configure the default BroadcasterCache

Parameters:

broadcasterCache - a BroadcasterCache's class

Returns:

this

webSocketProtocol

public Config.Builder webSocketProtocol(java.lang.Class<? extends org.atmosphere.websocket.WebSocketProtocol> webSocketProtocol)

Configure the default WebSocketProtocol

Parameters:

webSocketProtocol - a WebSocketProtocol's class

Returns:

this

interceptor

public Config.Builder interceptor(org.atmosphere.cpr.AtmosphereInterceptor interceptor)

Add an AtmosphereInterceptor

Parameters:

interceptor - an AtmosphereInterceptor

Returns:

this

excludeInterceptor

public Config.Builder excludeInterceptor(java.lang.String interceptor)

Exclude an AtmosphereInterceptor from being added, at startup, by Atmosphere. The default's AtmosphereInterceptor are candidates for being excluded

Parameters:

interceptor - an AtmosphereInterceptor

Returns:

this

channelUpstreamHandler

public Config.Builder channelUpstreamHandler(io.netty.channel.ChannelInboundHandler h)

Add a ChannelInboundHandler. All will be executed before BridgeRuntime

Parameters:

h - ChannelInboundHandler

Returns:

this;

supportChunking

public Config.Builder supportChunking(boolean supportChunking)

Set to false to override the default behavior when writing bytes, which is use chunking. When set to false the ChunkedWriteHandler will not be added to the Netty's ChannelPipeline

This is strongly recommended to turn chunking to false if you are using websocket to get better performance.

Parameters:

supportChunking - false to disable.

Returns:

this

aggregateRequestBodyInMemory

public Config.Builder aggregateRequestBodyInMemory(boolean aggregateRequestBodyInMemory)

By default, Nettosphere aggregate the HTTP request's body in memory an invoke an Atmosphere's components with a single AtmosphereResource. Setting supportChunkAggregator to false will instead invoke Atmosphere's component with a new AtmosphereResource each time the request's body is read in memory. Setting to false may significantly increase the performance and reduce memory footprint. Note that setting this value to false may deliver to your Atmosphere's component partial body, so your application must make sure to aggregate the body before parsing the data if needed. For example, if you are using JSON as format, make sure you parse the data incrementally.

Parameters:

aggregateRequestBodyInMemory - false to disable.

Returns:

this

socketNoTcpDelay

public Config.Builder socketNoTcpDelay(boolean socketNoTcpDelay)

Set Netty's Bootstrap 'child.tcpDelay'

Parameters:

socketNoTcpDelay -

Returns:

this

socketKeepAlive

public Config.Builder socketKeepAlive(boolean socketKeepAlive)

Set Netty's Bootstrap 'child.keepAlive'

Parameters:

socketKeepAlive -

Returns:

this

textFrameAsBinary

public Config.Builder textFrameAsBinary(boolean textFrameAsBinary)

Do not decode TextWebSocketFrame into a String and instead pass it to the WebSocketProcessor as binary.

Parameters:

textFrameAsBinary -

Returns:

this

subProtocols

public Config.Builder subProtocols(java.lang.String subProtocols)

A coma delimited of allowed WebSocket Sub Protocol (Sec-WebSocket-Protocol)

Parameters:

subProtocols - A coma delimited of allowed WebSocket Sub Protocol

Returns:

this

noInternalAlloc

public Config.Builder noInternalAlloc(boolean noInternalAlloc)

Proxy AtmosphereRequest, AtmosphereResource and AtmosphereRequest with no ops implementations.

Set it to true only if you are using WebSocket with a your own implementation of WebSocketProcessor. The WebSocketProcessor MUST not invoked those objects and only use the WebSocket API.

Default is false

Parameters:

noInternalAlloc -

Returns:

this

binaryWrite

public Config.Builder binaryWrite(boolean binaryWrite)

Write binary frame when websocket transport is used.

Parameters:

binaryWrite - true or false

Returns:

this

webSocketOnly

public Config.Builder webSocketOnly(boolean webSocketOnly)

Only Support WebSocket. All HTTP call will be dropped. Default is false

Parameters:

webSocketOnly - true if only the websocket protocol needs to be suppored.

Returns:

this

ioExceptionHandler

public Config.Builder ioExceptionHandler(IOExceptionHandler ioExceptionHandler)

Set an IOExceptionHandler to handle unexpected I/O exception

Parameters:

ioExceptionHandler -

Returns:

this

build

public Config build()

Build an instance of this class.

Returns:

this;

servletContextAttribute

public Config.Builder servletContextAttribute(java.lang.String name,
                                              java.lang.Object value)

Set ServletContext Attribute

Parameters:

name -

value -

Returns:

this

epoll

public Config.Builder epoll(boolean epoll)

Use EpollEventLoopGroup

Returns:

this