netty-http

Need for this library

Build the HTTP Library

Setting up an HTTP Service using the Library

// Set up Handlers for PingpublicclassPingHandlerextendsAbstractHttpHandler {@Path("/v1/ping")@GETpublicvoidtestGet(HttpRequestrequest,HttpResponderresponder){responder.sendString(HttpResponseStatus.OK,"OK");  }}// Setup HTTP service and add Handlers// You can either add varargs of HttpHandler or as a list of HttpHanlders as below to the NettyService BuilderList<HttpHandler>handlers =newArrayList<>();handlers.add(newPingHandler());handlers.add(...otherHandler...)NettyHttpServiceservice =NettyHttpService.builder("Name_of_app")                           .setPort(7777)// Optionally set the port. If unset, it will bind to an ephemeral port                           .setHttpHandlers(handlers)                           .build();// Start the HTTP serviceservice.start();

// Set up handlers// Setting up Path annotation on a class level will be pre-pended with@Path("/v1/apps")publicclassApplicationHandlerextendsAbstractHandler {// The HTTP endpoint v1/apps/deploy will be handled by the deploy method given below@Path("deploy")@POSTpublicvoiddeploy(HttpRequestrequest,HttpResponderresponder) {// ..// Deploy application and send status// ..responder.sendStatus(HttpResponseStatus.OK);  }// For deploying larger-size applications we can use the BodyConsumer abstract-class,// we can handle the chunks as we receive it// and handle clean up when we are done in the finished method, this approach is memory efficient@Path("deploybig")@POSTpublicBodyConsumerdeployBig(HttpRequestrequest,HttpResponderresponder) {returnnewBodyConsumer() {@Overridepublicvoidchunk(ChannelBufferrequest,HttpResponderresponder) {// write the incoming data to a file      }@Overridepublicvoidfinished(HttpResponderresponder) {//deploy the app and send responseresponder.sendStatus(HttpResponseStatus.OK);      }@OverridepublicvoidhandleError(Throwablecause) {// if there were any error during this process, this will be called.// do clean-up here.      }    }  }// The HTTP endpoint v1/apps/{id}/start will be handled by the start method given below@Path("{id}/start")@POSTpublicvoidstart(HttpRequestrequest,HttpResponderresponder,@PathParam("id")Stringid) {// The id that is passed in HTTP request will be mapped to a String via the PathParam annotation// ..// Start the application// ..responder.sendStatus(HttpResponseStatus.OK);  }// The HTTP endpoint v1/apps/{id}/stop will be handled by the stop method given below@Path("{id}/stop")@POSTpublicvoidstop(HttpRequestrequest,HttpResponderresponder,@PathParam("id")Stringid) {// The id that is passed in HTTP request will be mapped to a String via the PathParam annotation// ..// Stop the application// ..responder.sendStatus(HttpResponseStatus.OK);  }// The HTTP endpoint v1/apps/{id}/status will be handled by the status method given below@Path("{id}/status")@GETpublicvoidstatus(HttpRequestrequest,HttpResponderresponder,@PathParam("id")Stringid) {// The id that is passed in HTTP request will be mapped to a String via the PathParam annotation// ..// Retrieve status the application// ..JsonObjectstatus =newJsonObject();status.addProperty("status","RUNNING");responder.sendJson(HttpResponseStatus.OK,status.toString());  }}// Setup HTTP service and add Handlers// You can either add varargs of HttpHandler or as a list of HttpHanlders as below to the NettyService BuilderList<HttpHandler>handlers =newArrayList<>();handlers.add(newPingHandler());handlers.add(...otherHandler...)NettyHttpServiceservice =NettyHttpService.builder("Name_of_app")                          .setPort(7777)                          .setHttpHandlers(handlers)                          .build();// Start the HTTP serviceservice.start();

Setting up an HTTPS Service

// Setup HTTPS service and add HandlersNettyHttpServiceservice =NettyHttpService.builder()                           .setPort(7777)                           .addHttpHandlers(newApplicationHandler())                           .enableSSL(SSLConfig.builder(newFile("/path/to/keyStore.jks","keyStorePassword")                                      .setCertificatePassword("certificatePassword").build())                           .build();

References

Contributing to netty-http

License