io.cdap.http

Class NettyHttpService

java.lang.Object

io.cdap.http.NettyHttpService

public final class NettyHttpService
extends Object

Webservice implemented using the netty framework. Implements Guava's Service interface to manage the states of the webservice.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NettyHttpService.Builder Builder to help create the NettyHttpService.

Method Summary

Modifier and Type	Method and Description
static NettyHttpService.Builder	builder(String serviceName) Creates a NettyHttpService.Builder for creating new instance of NettyHttpService.
InetSocketAddress	getBindAddress()
String	getServiceName()
boolean	isSSLEnabled()
void	start() Starts the HTTP service.
void	stop() Stops the HTTP service gracefully and release all resources.
void	stop(long quietPeriod, long timeout, TimeUnit unit) Stops the HTTP service gracefully and release all resources.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static NettyHttpService.Builder builder(String serviceName)

Creates a NettyHttpService.Builder for creating new instance of NettyHttpService.

Parameters:

serviceName - name of the http service. The name will be used to name threads created for the service.

Returns:

builder for creating a NettyHttpService

start

public void start()
           throws Exception

Starts the HTTP service.

Throws:

Exception - if the service failed to started

getBindAddress

public InetSocketAddress getBindAddress()

Returns:

port where the service is running.

getServiceName

public String getServiceName()

Returns:

the name of the HTTP service.

isSSLEnabled

public boolean isSSLEnabled()

Returns:

true if SSL is enabled for this service.

stop

public void stop()
          throws Exception

Stops the HTTP service gracefully and release all resources. Same as calling stop(long, long, TimeUnit) with 0 second quiet period and 5 seconds timeout.

Throws:

Exception - if there is exception raised during shutdown.

stop

public void stop(long quietPeriod,
                 long timeout,
                 TimeUnit unit)
          throws Exception

Stops the HTTP service gracefully and release all resources.

Parameters:

quietPeriod - the quiet period as described in the documentation of EventExecutorGroup

timeout - the maximum amount of time to wait until the executor is EventExecutorGroup.shutdown() regardless if a task was submitted during the quiet period

unit - the unit of quietPeriod and timeout

Throws:

Exception - if there is exception raised during shutdown.