Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

🧱 MASON

Build Status Maven Central javadoc.io Coverage Status LGPL v2.1 License Gitter

Mason is an open-source, lightweight data access layer for REST resources designed to be used in Java web applications. It handles incoming API requests and routes the parameters to these resources.

<dependency>
  <groupId>com.metamug</groupId>
  <artifactId>mason</artifactId>
  <version>3.4</version>
</dependency>

Motivation

Use JSP tags for editing database queries and request handling. To hot deploy REST APIs without compiling/deploying Java classes. Build REST APIs with JSP tags.

<jsp:directive.include file="../fragments/mason-init.jspf"/>
<%-- customer.jsp --%>
<m:resource>
    <m:request method="GET">
     	<sql:query var="customers" dataSource="${datasource}"> 
		SELECT name, address, phone, type from retail_customer 
    	</sql:query>
     	<c:set target="${output}" property="customers" value="${customers}"/>
    </m:request>
</m:resource>

Sample Project

Taglib Documentation

https://metamug.github.io/mason/

Mason Resources

Mason turns your Plain Old JSPs (with neat tag libraries) into REST Resources. Mason doesn't encourage using scriptlets in Resource JSPs.

You can handle GET, POST, PUT, DELETE requests in your JSP. Mason has been tested with tomcat 9. jstl.jar shipped with tomcat is make jstl work.

Learn more about jsp configurations here. https://tomcat.apache.org/tomcat-9.0-doc/jasper-howto.html

Mason Query

You can write database queries inside the resource JSP files as seen in the above example or you can place them in {webAppDir}/WEB-INF/classes/query.properties file and reference them inside the JSP files for reuse.

Features?

  • Request Processing
  • Mapping resource URI to JSP
  • HTTP BASIC and JWT Authentication
  • Convert SQL Results into JSON/XML based on Accept Header 🌟
  • Make External API Requests
  • Pagination
  • Many more

Mason Jar

Mason Jar

Clone and package the project with mvn

mvn clean package

After that you can find mtg-mason-1.0.jar inside the target folder. You can use this jar as a dependency in your Java webapp.

How to use mason in your Webapp

  1. Place the mason jar file in {webAppDir}/WEB-INF/lib

  2. Download jstl jar file and place it inside {webAppDir}/WEB-INF/lib

  3. Create a folder {webAppDir}/WEB-INF/resources/{resourceVersion} and place your jsp files here. For example, mywebapp/WEB-INF/resources/v1.0/foo.jsp.

  4. Import mtg-mason.tld inside your jsp file. This taglib is present inside the mason jar and enables usage of the mtg prefix. You will also need to import the jstl taglib. Your jsp file should contain the following

<% @taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
<% @taglib uri="http://java.sun.com/jsp/jstl/sql" prefix="sql" %>
<% @taglib uri="mtg-mason.tld" prefix="m" %>
<%@ page trimDirectiveWhitespaces="true" %>
  1. Add the following filter and listener inside {webAppDir}/WEB-INF/web.xml
<filter>
    <filter-name>Router</filter-name>
    <filter-class>com.metamug.mason.Router</filter-class>
</filter>

<filter-mapping>
    <filter-name>Router</filter-name>
    <url-pattern>/*</url-pattern>
    <init-param>
        <param-name>datasource</param-name>
        <param-value>jdbc/mason</param-value>
    </init-param>
</filter-mapping>

All requests made to the jsp resources are routed through this filter.

  1. Configure your data source in {webAppDir}/META-INF/context.xml file.

You can take a look at the sample webapp.

JDBC Drivers

Except for javaee-web-api since that would be present in your application server and any one out of HSQL, MySQL or PostgreSQL dependency. We also support Oracle database but due to its licensing we can't ship oracle jdbc driver along. So in case you are using Oracle database, you'll have to manually install its driver as a dependency in your project.

Instructions regarding how to do the same in below link(s) (You can refer either of them). https://www.mkyong.com/maven/how-to-add-oracle-jdbc-driver-in-your-maven-local-repository/ OR https://stackoverflow.com/a/1074971/4800126

Data Format Support

Mason supports application/xml, applicaton/json and application/json+dataset Read More about how it is used here. https://metamug.com/docs/api-request

Scripting Support

Mason supports groovy for writing scripts. You need to keep the scripts in {webAppDir}/WEB-INF/scripts

Example Script

//test.groovy
def params = _request.getParams()
res['message'] = 'Hello ' + params['name']

The script can be invoked using script tag in jsp resource.

<m:script file="test.groovy" var="res" />

How To Contribute

Fork this repo and submit a PR against the listed issues. Any donations for this project will be paid to individual developers working in their personal capacity on this project. To reward them for their contribution and keeping Mason a community project.

SonarCloud Bugs SonarCloud Vulnerabilities Total alerts Language grade: Java

You can’t perform that action at this time.