Public JAX-RS Application Implementation

Public JAX-RS Application Implementation

Overview

This article will explain how to create a JAX-RS REST application, which will be publicly accessible. 

Prerequisites 

Create a Liferay Gradle Workspace with a Target Platform enabled.


JAX-RS Module Implementation

Create a new ‘rest’ module:


Created module structure:

 

bnd.bnd file:

Bundle-Name: liferay-jax-rs-sample
Bundle-SymbolicName: com.liferay.jax.rs.sample
Bundle-Version: 1.0.0
Liferay-Configuration-Path: /configuration


build.gradle file:

dependencies {
  compileOnly group: "javax.ws.rs", name: "javax.ws.rs-api"
  compileOnly group: "org.osgi", name: "org.osgi.service.component.annotations"
  compileOnly group: "org.osgi", name: "org.osgi.service.jaxrs"
}

Once you deploy sample generated JAX-RS application, and try to access it by URL http://localhost:8080/o/greetings - you’ll see the “Access denied” error:

  

Fixing Access Denied Error


There are two ways to make the JAX-RS application work without authentication. 

1. Configuration approach. 

Go to Control Panel > Configuration > Service Access Policy:

Edit the “SYSTEM_DEFAULT” access policy.

Click “Switch to Advanced Mode”:

Add the JAX-RS application class methods signature to configuration:

Now the REST URL should work:

2. Programmatic approach

To make the JAX-RS application publicly available - you may set the following properties:

"auth.verifier.guest.allowed=true",
"liferay.access.control.disable=true"

Sample:

@Component(
  property = {
     JaxrsWhiteboardConstants.JAX_RS_APPLICATION_BASE + "=/greetings",
     JaxrsWhiteboardConstants.JAX_RS_NAME + "=Greetings.Rest",
     "auth.verifier.guest.allowed=true",
     "liferay.access.control.disable=true"
  },
  service = Application.class
)
public class JaxRSSampleAppApplication extends Application {
//
}

With these properties the JAX-RS application will be available without the additional configuration.

Enjoy 😏

Comments

Post a Comment

Popular posts from this blog

Liferay Search Container Example

Or how to implement a custom search container in Liferay Overview   Search Containers are used in Liferay to display the table data. This article shows a simple example of how to implement a custom search container.  Example < liferay-portlet :renderURL varImpl ="iteratorURL" /> < liferay-ui :search-container total =" <%= ProjectLocalServiceUtil. getProjectsCount (scopeGroupId) %> "                              delta ="10"                              emptyResultsMessage ="no-projects-found"                              iteratorURL =" <%= iteratorURL %> " >     < liferay-ui :search-container-results             results =" <%= ProjectLocalServiceUtil. getProjects (scopeGroupId, searchContainer.getStart(), searchContainer.getEnd()) %> " />     < liferay-ui :search-container-row className ="com.sample.sb.model.Project" modelVar ="project" keyP
Read more

Liferay DXP - max upload file size

Image
Liferay DXP - increase Maximum Upload Request Size By default, Liferay has limit to 100 MB for file upload. Sometimes you need to upload larger files, and this restriction can be changed in configuration. Go to Control Panel -> Configuration -> System Settings -> Infrastructure. Click on "Upload Servlet Request". Modify " Overall Maximum Upload Request Size"  value and set which you need: Save the configuration. Now you should be able to upload large files to your Liferay DXP instance.
Read more

Liferay Keycloak integration

Image
Liferay Keycloak integration using OpenID Overview This tutorial explains how to configure OpenID SSO between Liferay 7.2 and Keycloak 7.0.1 Installation instructions KeyCloak Configuration 1. Install and startup Keycloak server Download latest Keycloak server:  https://www.keycloak.org/downloads.html Unzip keycloak-7.0.1.zip folder. Run  keycloak-7.0.1/bin/standalone.sh  (or  keycloak-7.0.1/bin/standalone.bat ) file. Keycloak should be started on 8080 port:  http://localhost:8080 2. Create default admin user: and sign in to Admin Console. 3. Check OpenID configuration Click on "OpenID Endpoint Configuration": JSON configuration should appear, like this: { "issuer": "http://localhost:8080/auth/realms/master", "authorization_endpoint": "http://localhost:8080/auth/realms/master/protocol/openid-connect/auth", "token_endpoint": "http://localhost:8080/auth/realms/master/protocol/openid-con
Read more