Setting a proxy in tomcat, that will bypass the CORS problem using Rest API

Knowledge Article

Article Number

000321503

Old Article Number

000129250

Article Type

Solutions to a Product Problem

Title

Setting a proxy in tomcat, that will bypass the CORS problem using Rest API

Summary

When creating a web application using REST API , browsers will have a restriction based on the CORS security. Setting up a proxy application on the same domain as your web application would prevent this problem

Product

Remedy AR System Server

Component

Remedy AR System Server

Applies to

AR server 9.x

Problem

When creating a web application using REST API , browsers will have a restriction based on the CORS security.

Setting up a proxy application on the same domain as your web application would prevent this problem

In this case, the application is hosted on Tomcat and AR server is hosted on another machine

Cause

CORS limitation on browsers and the embedded jetty server on AR sever does not allow CORS headers configuration

Solution

This knowledge article may contain information that does not apply to version 21.05 or later which runs in a container environment. Please refer to Article Number 000385088 for more information about troubleshooting BMC products in containers.

NOTE: The J2ep Proxy is not recommended neither supported for production environments, Instead of, a Centralized configuration parametters can be used,
for more detail please check the KA: 000253769

Setting a proxy in tomcat to Remedy RESTAPI

Download J2ep from http://j2ep.sourceforge.net/
Shutdown tomcat
Unzip the downloaded file and copy the .war file to your Tomcat/webapps folder
Startup tomcat
Go to Tomcat/webapps/j2ep-1.0/WEB-INF/config directory and edit the file, data.xml
Edit the file as below

<?xml version="1.0" encoding="UTF-8"?>
<config>

       <server className="net.sf.j2ep.servers.BaseServer"
              domainName="jettyserver:port" <-- replace this with your ARservername:jettyport
              isRewriting="true">

              <rule className="net.sf.j2ep.rules.DirectoryRule"
                   directory="/rest"
            />
       </server>

       <server className="net.sf.j2ep.servers.BaseServer"
              domainName="jakarta.apache.org"
              isRewriting="true">

              <rule className="net.sf.j2ep.rules.AcceptEverythingRule"/>
     </server>

</config>

Restart tomcat

This will do the redirect from tomcat to REST
To test it, go to your browser and type hostname:port/j2ep/rest. You should get something like this:

The message, Powered by jetty, means that the call was successfully redirected to your jetty server and it is responding to your request.

Attachment(s):