LIGHT

  • News
  • Docs
  • Community
  • Reddit
  • GitHub
Star
CONCERNS

Body Parser

Body parser is a middleware handler designed for light-rest-4jonly. It will parse the body to a list or map according to the content-type in the HTTP header for POST, PUT and PATCH HTTP methods. The content-type can be parsed includes application/json, multipart/form-data and application/x-www-form-urlencoded. The application/json type is parsed into list or map depending on the first character of the body while the others is parsed into map by using FormParserFactory provided by io.undertow. After the body is parsed, it will be attached to the exchange so that subsequent handlers can use it directly.

Introduction

In order for this handler to work, the content-type in header must be started with “application/json”, “multipart/form-data” or “application/x-www-form-urlencoded”. If the content type is correct, it will parse it to List or Map and put it into REQUEST_BODY exchange attachment.

If content type is missing or if it is not started as “application/json”, “multipart/form-data” or “application/x-www-form-urlencoded”. the bodywon’t be parsed and this handler will just call next handler in the chain.

Sanitizer, Openapi Validator and Swagger Validator depend on this middleware.

Configuration

Here is an example of configuration body.yml which has a flag to enable or disable it.

# Enable body parse flag
enabled: true

Parser

Here is the parsing logic.

                    if (contentType != null && contentType.startsWith("application/json")) {
                        if (exchange.isInIoThread()) {
                            exchange.dispatch(this);
                            return;
                        }
                        exchange.startBlocking();
                        InputStream is = exchange.getInputStream();
                        try {
                            Object body;
                            String s = StringUtils.inputStreamToString(is, StandardCharsets.UTF_8);
                            if (s != null) {
                                s = s.trim();
                                if (s.startsWith("{")) {
                                    body = Config.getInstance().getMapper().readValue(s, new TypeReference<HashMap<String, Object>>() {});
                                } else if (s.startsWith("[")) {
                                    body = Config.getInstance().getMapper().readValue(s, new TypeReference<List<Object>>() {});
                                } else {
                                    // error here. The content type in head doesn't match the body.
                                    setExchangeStatus(exchange, CONTENT_TYPE_MISMATCH, contentType);
                                    return;
                                }
                                exchange.putAttachment(REQUEST_BODY, body);
                            }
                        } catch (IOException e) {
                            logger.error("IOException: ", e);
                            setExchangeStatus(exchange, CONTENT_TYPE_MISMATCH, contentType);
                            return;
                        }
                        // parse the body to form-data if content type is multipart/form-data or application/x-www-form-urlencoded
                    } else if (contentType != null &&
                            (contentType.startsWith("multipart/form-data") || contentType.startsWith("application/x-www-form-urlencoded"))) {
                        if (exchange.isInIoThread()) {
                            exchange.dispatch(this);
                            return;
                        }
                        exchange.startBlocking();
                        try {
                            Object data;
                            FormParserFactory formParserFactory = FormParserFactory.builder().build();
                            FormDataParser parser = formParserFactory.createParser(exchange);
                            if (parser != null) {
                                FormData formData = parser.parseBlocking();
                                data = BodyConverter.convert(formData);
                                exchange.putAttachment(REQUEST_BODY, data);
                            }
                        } catch (Exception e) {
                            logger.error("IOException: ", e);
                            setExchangeStatus(exchange, CONTENT_TYPE_MISMATCH, contentType);
                            return;
                        }
                    }

Example

Here is the code example that get the boby object(Map or List) from exchange.

                    Object body = exchange.getAttachment(BodyHandler.REQUEST_BODY);
                    if(body == null) {
                        exchange.getResponseSender().send("nobody");
                    } else {
                        if(body instanceof List) {
                            exchange.getResponseSender().send("list");
                        } else {
                            exchange.getResponseSender().send("map");
                        }
                    }
  • About Light Platform
    • Overview
    • What is Light
    • Features
    • Benefits
    • Principles
    • Roadmap
    • Articles
    • Videos
    • License
  • Getting Started
    • Get Started Overview
    • Environment
    • Light Codegen Tool
    • Light Rest 4j
    • Light Tram 4j
    • Light Graphql 4j
    • Light Hybrid 4j
    • Light Eventuate 4j
    • Light Oauth2
    • Light Portal Service
    • Light Proxy Server
    • Light Router Server
    • Light Config Server
    • Light Saga 4j
    • Light Session 4j
    • Webserver
    • Websocket
  • Architecture
    • Architecture Overview
    • API Category
    • API Gateway
    • Architecture Patterns
    • CQRS
    • Eco System
    • Event Sourcing
    • Fail Fast vs Fail Slow
    • Integration Patterns
    • JavaEE declining
    • Key Distribution
    • Microservices Architecture
    • Microservices Monitoring
    • Microservices Security
    • Microservices Traceability
    • Modular Monolith
    • Platform Ecosystem
    • Plugin Architecture
    • SOA
    • Scalability and Performance
    • Serverless
    • Service Collaboration
    • Service Mesh
    • Spring is bloated
    • Stages of API Adoption
    • Transaction Management
    • Microservices Cross-cutting Concerns Options
    • Service Mesh Plus
    • Service Discovery
  • Design
    • Design Overview
    • Design First vs Code First
    • Desgin Pattern
    • Service Evolution
    • Consumer Contract and Consumer Driven Contract
    • Handling Partial Failure
    • Idempotency
    • Environment Segregation
    • Multi-Tenancy
    • Why check token expiration
    • WebServices to Microservices
  • Cross-Cutting Concerns
    • Concerns Overview
    • Configs References
  • API Styles
    • Style Overview
    • Distributed session on IMDG
    • Eventuate - Event Sourcing and CQRS
    • Hybrid - Modularized Monolithic
    • REST - Representational state transfer
    • Saga - Distributed Transactions
    • Tram - Transactional Messaging
    • Web Server with Light Platform
    • Websocket with light platform
    • Single Page Application
    • GraphQL - A query language for your API
  • Infrastructure Services
    • Service Overview
    • Light Proxy
    • Light Router
    • Introduction
    • Architecture
    • Light Portal
    • Messaging Infrastructure
    • Centralized Logging
    • Light OAuth2
    • Services
    • Metrics and Alerts
    • Reference
    • Config Server
    • Tokenization
  • Tool Chain
    • Tool Chain Overview
    • Hugo Docs
    • Hugo Site
    • Hugo Netlify
    • Java keytool
    • Memory Monitoring
    • OpenAPI Parser
    • Minikube
    • Wrk
    • Light Bot
    • Light Codegen Reference
    • Kubernetes
  • Utility Library
  • Service Consumer
    • Service Consumer
  • Development
    • Development Overview
    • Best Practices
    • Development Flow
    • Platform Developer
    • Develop Build
    • Application
    • Service Provider Developer
    • Service Consumer Developer
  • Deployment
    • Deployment Overview
    • Frontend Backend
    • Linux Service
    • Windows Service
    • Install Eventuate on Windows
    • Secure API
    • Client vs light-router
    • Memory Limit
    • Deploy to Kubernetes
  • Example
    • Example Overview
  • Tutorial
    • Tutorial Overview
    • Client Tutorial
    • Common Tutorial
    • Registry and Discovery
    • Middleware Handlers
    • OpenAPI 3.0 Petstore
    • Security Tutorial
    • Swagger 2.0 Petstore
    • Test light service
    • Light Codegen Tutorial
    • Restful Database Access
    • Light Oauth2 Tutorial
    • Microservices Chain Pattern
    • GraphQL Tutorial
    • Handler Routing Tutorial
    • Microservices Aggregate Pattern
    • Restful Tutorial
    • Hybrid Tutorial
    • Light Bot Tutorial
    • Microservices Branch Pattern
    • Tram Tutorial
    • Eventuate Tutorial
    • Light Portal Tutorial
    • Light Proxy Tutorial
    • Light Router Tutorial
  • Benchmark
    • Benchmark Overview
  • Troubleshooting
    • Troubleshoot
  • FAQ
    • FAQ Overview
  • Milestones
  • Contribute
    • Contribute to Light
    • Development
    • Documentation
    • Example
    • Tutorial
“Body Parser” was last updated: December 10, 2018: Update body.md (561ae3e)
Improve this page
  • News
  • Docs
  • Community
  • Reddit
  • GitHub
  • About Light Platform
  • Getting Started
  • Architecture
  • Design
  • Cross-Cutting Concerns
  • API Styles
  • Infrastructure Services
  • Tool Chain
  • Utility Library
  • Service Consumer
  • Development
  • Deployment
  • Example
  • Tutorial
  • Benchmark
  • Troubleshooting
  • FAQ
  • Milestones
  • Contribute