WaveMaker Docs

WaveMaker Docs

  • Get started
  • Widgets
  • Mobile
  • How-to
  • Enterprise
  • Releases
  • Blog
  • Sign-in

›Web services

How-to-documents

  • How-to Wiki
  • WaveMaker Best Practices

App solution

  • Creating a Registration Page
  • Support for Password Encryption
  • Error Handling in WaveMaker App
  • Leaving Page with Unsaved Changes
  • Micro frontend using iframes
  • Enabling PWA

UI design

  • Passing Parameters to Pages
  • Passing Parameters to Partial Page
  • Accessing Script
  • Use Static Variable to pass data between pages
  • Customise Login Page
  • Incorporating Additional Icons
  • Change Icon Color on Condition
  • Change Icon for the Global Spinner
  • Changing Default Favicon
  • Changing App Logo
  • Changing Page Title
  • Customise App Style
  • How to use Conditional Class Property
  • How to use Conditional Style Property
  • Customize an Existing Theme
  • Adjust Left Navigation Width
  • Customizing Theme
  • Enable SPA
  • Choose Widget Template and Layout
  • Widget Template and Icons
  • Custom Template for Widgets
  • Apply Custom Data Formatter

Nav & Dropdown

  • Dynamic Menu based on User Role
  • Restricting Menu Items based on the User Role
  • Localization for Dropdown Menu

Localization

  • Localization in WaveMaker Apps
  • Setting Language and Date Format
  • Localization Using Select Locale
  • Localization of Error Messages

Security

  • SAML Integration - OneLogin
  • SAML Integration - ADFS
  • OpenID Integration - Azure AD
  • Custom Security using Google OAuth Prefab
  • Multiple Security Provider Implementation
  • Customizing Post Authentication Handlers
  • Configuring Content-Security-Policy
  • Configuring MTLS

Databases

  • Queries with Dynamic Where Clause
  • Connect To Azure SQL Server
  • Recommended JDBC Driver Versions for Databases
  • How to fetch more than the default number(100) of records from database?
  • How To: One-to-Many Relationship
  • Working with Temporals
  • Connect To AWS Redshift Database
  • Connect To SAP Hana Cloud Database
  • Transactional History of Entity
  • Row-Level Security using DB Event Listeners
  • Validations using CRUD Listeners
  • Custom Logic DB Event Listeners
  • Connect to MySQL database using SSL
  • How to Switch MariaDB to MySQL Connector

Web services

  • Using App Environment Properties
  • Consuming an Existing WaveMaker API
  • Using POST method to send data to a REST API
  • Request-Response Processing for REST Services
  • How to Intercept Request and Response of all API Calls in One Place
  • WebSocket Usage - Chatroom App
  • UI for API Server-side Pagination
  • Working with API with different pagination formats

Java services

  • Sending Email using WaveMaker Connector
  • Implementing Forgot Password feature using Java Service
  • Accessing REST APIs from Java Service
  • Scheduling a Java Service
  • Integrating JUnit Tests for WaveMaker Application
  • ORM Artifacts
  • Pre-Post Processing for Database Service APIs
  • Accessing Logged-in User Details using Java Service
  • Design a workflow in Camunda BPM and integrate into a WaveMaker app
  • Integrate Azure File Storage
  • Insert Data from Excel into Database
  • Integrate Amazon S3 into WaveMaker App
  • Integrate Twilio Connector
  • Integrate OTP (One-Time Passcode) Verification with WaveMaker App

Variables

  • Using Filter Conditions on Variable
  • Using Live Variable APIs
  • Using Notification Actions
  • Using Navigation Action
  • Using Variables for Queries and Procedure
  • Using Service Variable in a Form
  • Using Filter Criteria for a Data and Live Widgets
  • Using Filter Criteria for a Database CRUD Variable

JavaScript

  • Using JavaScript in Binding
  • Using JavaScript from External URL
  • Using JavaScript to loop a command
  • Using function for evaluating conditions

Developer options

  • Synchronizing WaveMaker Apps with IDEs
  • Synchronizing Java Services Controller
  • Integrating Amazon Cognito for User Authentication
  • Integrating Sample Jasper Report in WaveMaker Application
  • How to generate PDF File using Jasper Reports
  • Upgrading an App from WaveMaker 9.x to WaveMaker 10.0
  • App Migration from WaveMaker 9x to 10x
  • Setup Fusion Reactor for Debugging Issues

Deployment

  • SSL Termination in LoadBalancer

Mobile App Solutions

  • Notify users about new update

Mobile gesture

  • Setting Swipe Gestures on a List Widget
  • Working with Pull to Refresh

Mobile widgets

  • Using Search Widget within the Navbar

Mobile UI design

  • Setting Splashscreen Images and App Icons
  • Using Cordova Plugins
  • Designing Tablet Views in Mobile Project
  • Sliding left navigation for Mobile App
  • Mobile App using Bar code
  • Custom Date Picker in Mobile

Cards

  • Capturing Card Items

DataTable

  • Customising Data Table Row Action
  • How to Configure Row Expansion in a Data Table
  • Using Widgets to represent Data Table Columns
  • View Master-Detail Data Records using Data Table
  • Add Master-Detail records using Data Table
  • Export Data from Data Table
  • Export Data from Data Table - 2
  • Setting Blob Filename
  • Dynamic Data Tables
  • Customize Dynamic Datatable
  • Data Table Column bound to Query
  • Combining Columns in Data Table
  • Custom Styling Data Table Columns & Rows
  • Formatting Data Table Columns
  • Concurrency and Record Locking in WaveMaker
  • Edit DataTable records bound to Query API

List

  • Creating an Employee List grouped by City
  • Creating an Employee List grouped by Birth Month and City
  • OnRender Event
  • Including a Data Table within a List
  • Building an Editable List
  • Building Cascading Lists
  • Accessing List Items
  • Localization of Data Table Column Headings

Forms

  • Using Live Form
  • How Tos: Form
  • Building Tabbed Live Form
  • How Tos: Live Form
  • Linking Live Form with another Widget for Input
  • Handling Related Fields in a Live Form
  • How to Get Validation Messages from a Form
  • Adding Master-Detail records in the same transaction
  • Submit Parent and Child Records in a Single Transaction
  • Submit Parent and Child Records in a Single Transaction using Form and Data Table
  • Using Cascading Select & Autocomplete for Live Form Fields
  • Using Cascading Select within Live Form
  • Using cascading Filter to populate Live Form
  • Using Wizard for Master-Detail Live Form
  • Copy to Clipboard
  • Create a form with multiple wizard steps
  • Smart Forms: Conditional Flows for form Widget

Calendar

  • How Tos: Calendar
  • Calendar Usage - Create an Event
  • Calender Usage - Google Calendar Integration

CheckboxSet

  • CheckboxSet to Filter List data

FileUpload

  • FileUpload - Basic Usage
  • File Upload Widget Operations
  • Upload File & Save in Database
  • File Upload & Blob Data
  • File Upload - Custom Directory
  • Accessing File Upload from Java Code
  • Upload Files from Live Form & Form

Radioset

  • Radioset to Filter a List

Rating

  • Building Rating Widget using Static Data
  • Building Rating Widget using Static Variable
  • Build Rating Widget using Model Variable
  • Building an Interactive Rating Widget

Select

  • Configuring Select Widget from a Static List of Values
  • Configuring Select Widget from a Static Variable
  • Configuring Select Widget from a Variable
  • Configuring Select Widget using Display and Data Fields
  • Configuring Select Widget from Database Fields
  • Configuring Cascading Select
  • Selection Widgets - Use Case

Progress Circle

  • Using Progress Circle Widget

Charts

  • Working with Charts
  • Display User Selection in another Widget
  • Handling Dynamic Data
  • Custom Data

Richtext Editor

  • Adding Custom Fonts to Richtext Editor

Live filter

  • Applying Live Filter to a Data Table or a Chart
  • Building a Multiple Selection Live Filter
  • Building a Range Live Filter

Container

  • Setting partial page content for Accordion within a List
  • Setting partial page content for Panel within a List using JavaScript
  • How Tos: Wizard
  • Dynamic Tabs and Accordions

Tree

  • Tree using Static Variable
  • Tree using Java Service
  • Tree using Dynamic Tree

Prefabs

  • Creating Partials in a Prefab
  • Create Prefab using Third Party UI Widgets
  • Create a Simple Prefab
  • Create Prefab Using D3 & NVD3 Charts
  • Create Prefab Using D3 Library DataMaps
  • Create Prefab using JQuery Plugin
  • Create Prefab using Angular Module
  • Create Prefab using Angular, React Components
  • Azure OAuth Prefab Integration

Team Poral Configure Vcs

  • Configure Azure Repos In CodeRepository
Edit

Request-Response Processing for REST Services


Introduction

This document will go through the steps in adding Request-Response processing for REST services integrated with a WaveMaker application.

Overview

HttpRequest and HttpReponse processors are available for all REST Services with proxy enabled. They are used to process the request and response of the REST Service at runtime.

HttpRequestProcessor: This is used to process the request before sending it to the server. Processing of request can be used to add/delete/modify request headers or update request body before hitting the Service End Point.

HttpResponseProcessor: This is used to process the response sent by the server before sending it to the client. Processing of response includes adding/removing/modifying response headers or modifying the response body.

Following is the Request life cycle for a REST Service in a WaveMaker app: Screenshot showing request responseThe following request and response processors are provided, by default, for every REST service integrated into WaveMaker Apps.

PassDefaultHeadersRequestProcessor

This process parses the defaultHeaders from the incoming request if present and passes it onto the target endpoint. This processor takes a set of defaultHeaders as the input parameters. Eg: User-Agent, Content-Type, Accept etc.

PrefixHttpResponseHeadersResponseProcessor

This processor is used to add a headerPrefix to all response headers returned by the server. A set of response headers can be excluded from getting prefixed by giving excludeList as input to the processor.

HttpResponseCookieProcessor

This processor can be used to configure whether to include or exclude the cookies sent by the server to the client. The PersistenceStrategy property can be set to:

  • NONE - removes all cookies.
  • USER_SESSION - persists cookies in the user session with attribute “wm.cookieStore“
  • CLIENT - sends all response cookies to the client.

A RestRuntimeConfigBean is generated by WaveMaker wherein a list of Request-Response processors, as mentioned above, are injected. Sample restRuntimeConfigBean looks as shown below.

Each HttpRequestProcessor will be called sequentially in the input http request and each HttpResponseProcessor will be called sequentially before writing the response to WaveMaker client.

<bean class="com.wavemaker.runtime.rest.processor.RestRuntimeConfig" id="restRuntimeConfig">
   <property name="httpRequestProcessorList">
       <list>
           <bean class="com.wavemaker.runtime.rest.processor.request.PassDefaultHeadersRequestProcessor">
               <property name="enabled" value="true"/>
               <property name="defaultHeaders">
                   <list>
                       <value>User-Agent</value>
                       <value>Content-Type</value>
                       <value>Accept</value>
                       <value>Accept-Charset</value>
                       <value>Accept-Language</value>
                   </list>
               </property>
           </bean>
       </list>
   </property>
   <property name="httpResponseProcessorList">
       <list>
           <bean class="com.wavemaker.runtime.rest.processor.response.HttpResponseCookieProcessor">
               <property name="enabled" value="true"/>
               <property name="persistenceStrategy" value="CLIENT || USER_SESSION || NONE"/>
           </bean>
           <bean class="com.wavemaker.runtime.rest.processor.response.PrefixHttpResponseHeadersResponseProcessor">
               <property name="enabled" value="true"/>
               <property name="headerPrefix" value="X-WM-"/>
               <property name="excludeList">
                   <list>
                       <value>Content-Disposition</value>
                       <value>Content-Type</value>
                       <value>Set-Cookie</value>
                   </list>
               </property>
           </bean>
       </list>
   </property>
</bean>

Configuring Request and Response Processor properties in WaveMaker

In order to configure the request and response processors:

  1. From File Explorer, open <serviceId>.spring.xml file (services/serviceName/src/serviceId.spring.xml) of the REST Service you wish to configure.
  2. You can configure properties of the request and response processors by editing property values of bean with id: “serviceId+RestRuntimeConfig”.
  3. All the Request-Response processors are enabled by default. In order to disable a processor set enabled flag to false.

Custom Request-Response Processors

You can add your own custom Request-Response Processors. In order to create custom HttpRequestProcessor/HttpResponseProcessor:

  1. Create a Java Service that implements the HttpRequestProcessor/HttpResponseProcessor. You can also import the Java Class directly into src/main/Java/<package_path>. (Note this <package_path> needs to be created and should be given when adding the Java Class Bean in the next step.)
  2. Add the Java Class Bean to httpRequestProcessorList/httpResponseProcessorList of restRuntimeConfigBean, in the above mentioned <serviceId>.spring.xml file (services/serviceName/src/serviceName.spring.xml) of the REST Service you wish to customize.

Interface to implement for creating custom request processor

package com.wavemaker.runtime.rest.processor.request;

public interface HttpRequestProcessor {

   void process(HttpRequestProcessorContext httpRequestProcessorContext);
}

Use Case: Consider the case where the logged in user tenant id values need to be added to the request header, the following is the Java implementation:

public class DefaultHeaderRequestProcessor implements HttpRequestProcessor {
   @Override
   public void process(HttpRequestProcessorContext httpRequestProcessorContext) {
       Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
       if (authentication != null && authentication.getPrincipal() instanceof WMUserDetails) {
           WMUserDetails principal = (WMUserDetails) authentication.getPrincipal();
           int tenantId = principal.getTenantId();
           httpRequestProcessorContext.getHttpRequestDetails().getHttpHeaders().add("tenantId", Integer.toString(tenantId));
       }
   }
}

Ensure that proper classes are imported, for example for the above example:

import org.springframework.security.core.Authentication;
import org.springframework.security.core.context.SecurityContextHolder;

import com.wavemaker.runtime.rest.processor.request.HttpRequestProcessor;
import com.wavemaker.runtime.rest.processor.request.HttpRequestProcessorContext;
import com.wavemaker.runtime.security.WMUserDetails;

Interface to implement for creating custom response processor

package com.wavemaker.runtime.rest.processor.response;

public interface HttpResponseProcessor {

   void process(HttpResponseProcessorContext httpResponseProcessorContext);
}

HttpRequestProcessorContext

HttpRequestProcessorContext has the following structure:

public class HttpRequestProcessorContext {

   private HttpServletRequest httpServletRequest;

   private HttpRequestDetails httpRequestDetails;

   private HttpRequestData httpRequestData;

   public HttpRequestProcessorContext(HttpServletRequest httpServletRequest, HttpRequestDetails httpRequestDetails, HttpRequestData httpRequestData) {
       this.httpServletRequest = httpServletRequest;
       this.httpRequestDetails = httpRequestDetails;
       this.httpRequestData = httpRequestData;
   }

   public HttpServletRequest getHttpServletRequest() {
       return httpServletRequest;
   }

   public HttpRequestDetails getHttpRequestDetails() {
       return httpRequestDetails;
   }

   public HttpRequestData getHttpRequestData() {
       return httpRequestData;
   }
}

HttpResponseProcessorContext

HttpResponseProcessorContext has the following structure:

public class HttpResponseProcessorContext {

   private HttpServletRequest httpServletRequest;

   private HttpResponseDetails httpResponseDetails;

   private HttpRequestDetails httpRequestDetails;

   private HttpRequestData httpRequestData;

   public HttpResponseProcessorContext(HttpServletRequest httpServletRequest, HttpResponseDetails httpResponseDetails, HttpRequestDetails httpRequestDetails, HttpRequestData httpRequestData) {
       this.httpServletRequest = httpServletRequest;
       this.httpResponseDetails = httpResponseDetails;
       this.httpRequestDetails = httpRequestDetails;
       this.httpRequestData = httpRequestData;
   }

}

HttpRequestData

HttpRequestData has the following structure:

public class HttpRequestData {

   private Map<String, String> pathVariablesMap;

   private MultiValueMap<String, String> queryParametersMap;

   private HttpHeaders httpHeaders = new HttpHeaders();

   private InputStream requestBody;
   public HttpHeaders getHttpHeaders() {
       return httpHeaders;
   }

   public void setHttpHeaders(HttpHeaders httpHeaders) {
       this.httpHeaders = httpHeaders;
   }

   public Map<String, String> getPathVariablesMap() {
       return pathVariablesMap;
   }

   public void setPathVariablesMap(Map<String, String> pathVariablesMap) {
       this.pathVariablesMap = pathVariablesMap;
   }

   public InputStream getRequestBody() {
       return requestBody;
   }

   public void setRequestBody(InputStream requestBody) {
       this.requestBody = requestBody;
   }

   public MultiValueMap<String, String> getQueryParametersMap() {
      return queryParametersMap;
   }

   public void setQueryParametersMap(MultiValueMap<String, String> queryParametersMap) {
      this.queryParametersMap = queryParametersMap;
   }

}

HttpRequestDetails

HttpRequestDetails has the following structure:

public class HttpRequestDetails {

@NotNull
private String endpointAddress;

private String method;

@JsonIgnore
private InputStream body;

private HttpHeaders headers = new HttpHeaders();

private boolean redirectEnabled = true;

//Needed for jackson deserialization
public HttpRequestDetails() {
}

public boolean isRedirectEnabled() {
   return redirectEnabled;
}

public void setRedirectEnabled(final boolean redirectEnabled) {
   this.redirectEnabled = redirectEnabled;
}

public String getEndpointAddress() {
   return endpointAddress;
}

public void setEndpointAddress(String endpointAddress) {
   this.endpointAddress = endpointAddress;
}

public HttpHeaders getHeaders() {
   return headers;
}

public void setHeaders(HttpHeaders headers) {
   this.headers = headers;
}

public String getMethod() {
   return method;
}

public void setMethod(String method) {
   this.method = method;
}

public InputStream getBody() {
   return body;
}

public void setBody(InputStream body) {
   this.body = body;
}

}

HttpResponseDetails

HttpResponseDetails has the following structure:

public class HttpResponseDetails {

   private int statusCode;

   private HttpHeaders headers = new HttpHeaders();

   @JsonIgnore
   private InputStream body;

   public int getStatusCode() {
       return statusCode;
   }

   public void setStatusCode(int statusCode) {
       this.statusCode = statusCode;
   }

   public HttpHeaders getHeaders() {
       return headers;
   }

   public void setHeaders(HttpHeaders headers) {
       this.headers = headers;
   }

   public InputStream getBody() {
       return body;
   }

   public void setBody(InputStream body) {
       this.body = body;
   }

Java Service Use Cases

  1. How to send emails using Java Service
  2. How to implement forgot password feature using Java Service
  3. How to access REST APIs from Java Service
  4. How to schedule a Java Service
  5. How to accomplish Pre-Post Processing for a DB Service APIs
Last updated on 6/1/2020 by Swetha Kundaram
← Using POST method to send data to a REST APIHow to Intercept Request and Response of all API Calls in One Place →
  • Introduction
  • Overview
  • PassDefaultHeadersRequestProcessor
  • PrefixHttpResponseHeadersResponseProcessor
  • HttpResponseCookieProcessor
  • Configuring Request and Response Processor properties in WaveMaker
  • Custom Request-Response Processors
  • Interface to implement for creating custom request processor
  • Interface to implement for creating custom response processor
    • HttpRequestProcessorContext
    • HttpResponseProcessorContext
    • HttpRequestData
    • HttpRequestDetails
    • HttpResponseDetails
WaveMaker
  • PRICING
  • PARTNERS
  • CUSTOMERS
  • ABOUT US
  • CONTACT US
Terms of Use | Copyright © 2013-2023 WaveMaker, Inc. All rights reserved.