netflix.karyon

Class Karyon

java.lang.Object

netflix.karyon.Karyon

public final class Karyon
extends java.lang.Object

An entry point into karyon to create various flavors of karyon servers. For applications using governator's Bootstrap annotations it is easier to use KaryonRunner passing the main class containing all the Bootstrap annotations.

Method Summary

Methods

Modifier and Type	Method and Description
static KaryonServer	forApplication(java.lang.Class<?> mainClass, com.netflix.governator.guice.BootstrapModule... bootstrapModules) Creates a new KaryonServer which uses the passed class to detect any modules.
static KaryonServer	forApplication(java.lang.Class<?> mainClass, com.google.inject.Module... modules) Creates a new KaryonServer which uses the passed class to detect any modules.
static KaryonServer	forHttpServer(io.reactivex.netty.protocol.http.server.HttpServer<?,?> server, com.netflix.governator.guice.BootstrapModule... bootstrapModules) Creates a new KaryonServer which combines lifecycle of the passed HttpServer with it's own lifecycle.
static KaryonServer	forHttpServer(io.reactivex.netty.protocol.http.server.HttpServer<?,?> server, com.google.inject.Module... modules) Creates a new KaryonServer which combines lifecycle of the passed HttpServer with it's own lifecycle.
static KaryonServer	forModules(com.google.inject.Module... modules) Creates a new KaryonServer from the passed modules.
static KaryonServer	forRequestHandler(int port, io.reactivex.netty.protocol.http.server.RequestHandler<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> handler, com.netflix.governator.guice.BootstrapModule... bootstrapModules) Creates a new KaryonServer that has a single HTTP server instance which delegates all request handling to RequestHandler.
static KaryonServer	forRequestHandler(int port, io.reactivex.netty.protocol.http.server.RequestHandler<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> handler, com.google.inject.Module... modules) Creates a new KaryonServer that has a single HTTP server instance which delegates all request handling to RequestHandler.
static KaryonServer	forServer(KaryonServer server, com.netflix.governator.guice.BootstrapModule... bootstrapModules) Creates a new KaryonServer which combines lifecycle of the passed KaryonServer with it's own lifecycle.
static KaryonServer	forServer(KaryonServer server, com.google.inject.Module... modules) Creates a new KaryonServer which combines lifecycle of the passed KaryonServer with it's own lifecycle.
static KaryonServer	forSuites(com.netflix.governator.guice.BootstrapModule... bootstrapModules) Creates a new KaryonServer from the passed bootstrapModules.
static KaryonServer	forTcpConnectionHandler(int port, io.reactivex.netty.channel.ConnectionHandler<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> handler, com.netflix.governator.guice.BootstrapModule... bootstrapModules) Creates a new KaryonServer that has a single TCP server instance which delegates all connection handling to ConnectionHandler.
static KaryonServer	forTcpConnectionHandler(int port, io.reactivex.netty.channel.ConnectionHandler<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> handler, com.google.inject.Module... modules) Creates a new KaryonServer that has a single TCP server instance which delegates all connection handling to ConnectionHandler.
static KaryonServer	forTcpServer(io.reactivex.netty.server.RxServer<?,?> server, com.netflix.governator.guice.BootstrapModule... bootstrapModules) Creates a new KaryonServer which combines lifecycle of the passed RxServer with it's own lifecycle.
static KaryonServer	forTcpServer(io.reactivex.netty.server.RxServer<?,?> server, com.google.inject.Module... modules) Creates a new KaryonServer which combines lifecycle of the passed RxServer with it's own lifecycle.
static KaryonServer	forUdpConnectionHandler(int port, io.reactivex.netty.channel.ConnectionHandler<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> handler, com.netflix.governator.guice.BootstrapModule... bootstrapModules) Creates a new KaryonServer that has a single UDP server instance which delegates all connection handling to ConnectionHandler.
static KaryonServer	forUdpConnectionHandler(int port, io.reactivex.netty.channel.ConnectionHandler<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> handler, com.google.inject.Module... modules) Creates a new KaryonServer that has a single UDP server instance which delegates all connection handling to ConnectionHandler.
static KaryonServer	forUdpServer(io.reactivex.netty.protocol.udp.server.UdpServer<?,?> server, com.netflix.governator.guice.BootstrapModule... bootstrapModules) Creates a new KaryonServer which combines lifecycle of the passed UdpServer with it's own lifecycle.
static KaryonServer	forUdpServer(io.reactivex.netty.protocol.udp.server.UdpServer<?,?> server, com.google.inject.Module... modules) Creates a new KaryonServer which combines lifecycle of the passed UdpServer with it's own lifecycle.
static KaryonServer	forWebSocketServer(io.reactivex.netty.server.RxServer<? extends io.netty.handler.codec.http.websocketx.WebSocketFrame,? extends io.netty.handler.codec.http.websocketx.WebSocketFrame> server, com.netflix.governator.guice.BootstrapModule... bootstrapModules) Creates a new KaryonServer which combines lifecycle of the passed WebSockets RxServer with it's own lifecycle.
static KaryonServer	forWebSocketServer(io.reactivex.netty.server.RxServer<? extends io.netty.handler.codec.http.websocketx.WebSocketFrame,? extends io.netty.handler.codec.http.websocketx.WebSocketFrame> server, com.google.inject.Module... modules) Creates a new KaryonServer which combines lifecycle of the passed WebSockets RxServer with it's own lifecycle.
static com.netflix.governator.guice.BootstrapModule	toBootstrapModule(java.lang.Class<? extends com.google.inject.Module>... moduleClasses)
static com.netflix.governator.guice.BootstrapModule	toBootstrapModule(java.lang.Class<? extends com.google.inject.Module> moduleClass)
static com.netflix.governator.guice.BootstrapModule	toBootstrapModule(com.google.inject.Module... modules)

Methods inherited from class java.lang.Object

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

Method Detail

forRequestHandler

public static KaryonServer forRequestHandler(int port,
                             io.reactivex.netty.protocol.http.server.RequestHandler<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> handler,
                             com.google.inject.Module... modules)

Creates a new KaryonServer that has a single HTTP server instance which delegates all request handling to RequestHandler. The HttpServer is created using KaryonTransport.newHttpServer(int, HttpRequestHandler)

Parameters:

port - Port for the server.

handler - Request Handler

modules - Additional modules if any.

Returns:

KaryonServer which is to be used to start the created server.

forRequestHandler

public static KaryonServer forRequestHandler(int port,
                             io.reactivex.netty.protocol.http.server.RequestHandler<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> handler,
                             com.netflix.governator.guice.BootstrapModule... bootstrapModules)

Creates a new KaryonServer that has a single HTTP server instance which delegates all request handling to RequestHandler. The HttpServer is created using KaryonTransport.newHttpServer(int, HttpRequestHandler)

Parameters:

port - Port for the server.

handler - Request Handler

bootstrapModules - Additional bootstrapModules if any.

Returns:

KaryonServer which is to be used to start the created server.

forTcpConnectionHandler

public static KaryonServer forTcpConnectionHandler(int port,
                                   io.reactivex.netty.channel.ConnectionHandler<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> handler,
                                   com.google.inject.Module... modules)

Creates a new KaryonServer that has a single TCP server instance which delegates all connection handling to ConnectionHandler. The RxServer is created using RxNetty.newTcpServerBuilder(int, ConnectionHandler)

Parameters:

port - Port for the server.

handler - Connection Handler

modules - Additional modules if any.

Returns:

KaryonServer which is to be used to start the created server.

forTcpConnectionHandler

public static KaryonServer forTcpConnectionHandler(int port,
                                   io.reactivex.netty.channel.ConnectionHandler<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> handler,
                                   com.netflix.governator.guice.BootstrapModule... bootstrapModules)

Creates a new KaryonServer that has a single TCP server instance which delegates all connection handling to ConnectionHandler. The RxServer is created using RxNetty.newTcpServerBuilder(int, ConnectionHandler)

Parameters:

port - Port for the server.

handler - Connection Handler

bootstrapModules - Additional bootstrapModules if any.

Returns:

KaryonServer which is to be used to start the created server.

forUdpConnectionHandler

public static KaryonServer forUdpConnectionHandler(int port,
                                   io.reactivex.netty.channel.ConnectionHandler<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> handler,
                                   com.google.inject.Module... modules)

Creates a new KaryonServer that has a single UDP server instance which delegates all connection handling to ConnectionHandler. The RxServer is created using RxNetty.newUdpServerBuilder(int, ConnectionHandler)

Parameters:

port - Port for the server.

handler - Connection Handler

modules - Additional modules if any.

Returns:

KaryonServer which is to be used to start the created server.

forUdpConnectionHandler

public static KaryonServer forUdpConnectionHandler(int port,
                                   io.reactivex.netty.channel.ConnectionHandler<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> handler,
                                   com.netflix.governator.guice.BootstrapModule... bootstrapModules)

Creates a new KaryonServer that has a single UDP server instance which delegates all connection handling to ConnectionHandler. The RxServer is created using RxNetty.newUdpServerBuilder(int, ConnectionHandler)

Parameters:

port - Port for the server.

handler - Connection Handler

bootstrapModules - Additional bootstrapModules if any.

Returns:

KaryonServer which is to be used to start the created server.

forTcpServer

public static KaryonServer forTcpServer(io.reactivex.netty.server.RxServer<?,?> server,
                        com.google.inject.Module... modules)

Creates a new KaryonServer which combines lifecycle of the passed RxServer with it's own lifecycle.

Parameters:

server - TCP server

modules - Additional modules if any.

Returns:

KaryonServer which is to be used to start the created server.

forTcpServer

public static KaryonServer forTcpServer(io.reactivex.netty.server.RxServer<?,?> server,
                        com.netflix.governator.guice.BootstrapModule... bootstrapModules)

Creates a new KaryonServer which combines lifecycle of the passed RxServer with it's own lifecycle.

Parameters:

server - TCP server

bootstrapModules - Additional bootstrapModules if any.

Returns:

KaryonServer which is to be used to start the created server.

forHttpServer

public static KaryonServer forHttpServer(io.reactivex.netty.protocol.http.server.HttpServer<?,?> server,
                         com.google.inject.Module... modules)

Creates a new KaryonServer which combines lifecycle of the passed HttpServer with it's own lifecycle.

Parameters:

server - HTTP server

modules - Additional bootstrapModules if any.

Returns:

KaryonServer which is to be used to start the created server.

forHttpServer

public static KaryonServer forHttpServer(io.reactivex.netty.protocol.http.server.HttpServer<?,?> server,
                         com.netflix.governator.guice.BootstrapModule... bootstrapModules)

Creates a new KaryonServer which combines lifecycle of the passed HttpServer with it's own lifecycle.

Parameters:

server - HTTP server

bootstrapModules - Additional bootstrapModules if any.

Returns:

KaryonServer which is to be used to start the created server.

forWebSocketServer

public static KaryonServer forWebSocketServer(io.reactivex.netty.server.RxServer<? extends io.netty.handler.codec.http.websocketx.WebSocketFrame,? extends io.netty.handler.codec.http.websocketx.WebSocketFrame> server,
                              com.google.inject.Module... modules)

Creates a new KaryonServer which combines lifecycle of the passed WebSockets RxServer with it's own lifecycle.

Parameters:

server - WebSocket server

modules - Additional bootstrapModules if any.

Returns:

KaryonServer which is to be used to start the created server.

forWebSocketServer

public static KaryonServer forWebSocketServer(io.reactivex.netty.server.RxServer<? extends io.netty.handler.codec.http.websocketx.WebSocketFrame,? extends io.netty.handler.codec.http.websocketx.WebSocketFrame> server,
                              com.netflix.governator.guice.BootstrapModule... bootstrapModules)

Creates a new KaryonServer which combines lifecycle of the passed WebSockets RxServer with it's own lifecycle.

Parameters:

server - WebSocket server

bootstrapModules - Additional bootstrapModules if any.

Returns:

KaryonServer which is to be used to start the created server.

forUdpServer

public static KaryonServer forUdpServer(io.reactivex.netty.protocol.udp.server.UdpServer<?,?> server,
                        com.google.inject.Module... modules)

Creates a new KaryonServer which combines lifecycle of the passed UdpServer with it's own lifecycle.

Parameters:

server - UDP server

modules - Additional modules if any.

Returns:

KaryonServer which is to be used to start the created server.

forUdpServer

public static KaryonServer forUdpServer(io.reactivex.netty.protocol.udp.server.UdpServer<?,?> server,
                        com.netflix.governator.guice.BootstrapModule... bootstrapModules)

Creates a new KaryonServer which combines lifecycle of the passed UdpServer with it's own lifecycle.

Parameters:

server - UDP server

bootstrapModules - Additional bootstrapModules if any.

Returns:

KaryonServer which is to be used to start the created server.

forServer

public static KaryonServer forServer(KaryonServer server,
                     com.google.inject.Module... modules)

Creates a new KaryonServer which combines lifecycle of the passed KaryonServer with it's own lifecycle. This is useful when a KaryonServer is already present and the passed Modules are to be added to that server.

Parameters:

server - An existing karyon server

modules - Additional modules.

Returns:

KaryonServer which is to be used to start the created server.

forServer

public static KaryonServer forServer(KaryonServer server,
                     com.netflix.governator.guice.BootstrapModule... bootstrapModules)

Creates a new KaryonServer which combines lifecycle of the passed KaryonServer with it's own lifecycle. This is useful when a KaryonServer is already present and the passed BootstrapModules are to be added to that server.

Parameters:

server - An existing karyon server

bootstrapModules - Additional bootstrapModules.

Returns:

KaryonServer which is to be used to start the created server.

forApplication

public static KaryonServer forApplication(java.lang.Class<?> mainClass,
                          com.google.inject.Module... modules)

Creates a new KaryonServer which uses the passed class to detect any modules.

Parameters:

mainClass - Any class/interface containing governator's Bootstrap annotations.

modules - Additional modules if any.

Returns:

KaryonServer which is to be used to start the created server.

forApplication

public static KaryonServer forApplication(java.lang.Class<?> mainClass,
                          com.netflix.governator.guice.BootstrapModule... bootstrapModules)

Creates a new KaryonServer which uses the passed class to detect any modules.

Parameters:

mainClass - Any class/interface containing governator's Bootstrap annotations.

bootstrapModules - Additional bootstrapModules if any.

Returns:

KaryonServer which is to be used to start the created server.

forModules

public static KaryonServer forModules(com.google.inject.Module... modules)

Creates a new KaryonServer from the passed modules.

Parameters:

modules - Modules to use for the server.

Returns:

KaryonServer which is to be used to start the created server.

forSuites

public static KaryonServer forSuites(com.netflix.governator.guice.BootstrapModule... bootstrapModules)

Creates a new KaryonServer from the passed bootstrapModules.

Parameters:

bootstrapModules - Bootstrap modules to use for the server.

Returns:

KaryonServer which is to be used to start the created server.

toBootstrapModule

public static com.netflix.governator.guice.BootstrapModule toBootstrapModule(com.google.inject.Module... modules)

toBootstrapModule

@SafeVarargs
public static com.netflix.governator.guice.BootstrapModule toBootstrapModule(java.lang.Class<? extends com.google.inject.Module>... moduleClasses)

toBootstrapModule

public static com.netflix.governator.guice.BootstrapModule toBootstrapModule(java.lang.Class<? extends com.google.inject.Module> moduleClass)