Liferay 7 SpringMvc Portlet

Spring Mvc in Liferay7:

1) Create Module Project  in Liferay 7.
2) Create webapp folder under src → main
3) Create WEB-INF folder under webapp
4) Create jsp files in Jsp folder under the WEB-INF folder


            Project Structure shown in below diagram:

spring-context folder Structure 

spring-context(folder) →portlet(folder)

             ↓                                   ↓

             ↓                         NewCandidate-portlet.xml

             ↓

portlet-application-context.xml

xml file configuration:

1)web.xml

<?xml version="1.0"?>

<web-app
version="2.5"
xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/spring-context/portlet-application-context.xml</param-value>
</context-param>
<servlet>
<servlet-name>ViewRendererServlet</servlet-name>
<servlet-class>org.springframework.web.servlet.ViewRendererServlet</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>ViewRendererServlet</servlet-name>
<url-pattern>/WEB-INF/servlet/view</url-pattern>
</servlet-mapping>
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>

</web-app>


2) portlet.xml

<?xml version="1.0"?>

<portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd" version="2.0">
<portlet>
<portlet-name>NewCandidate</portlet-name>
<display-name>NewCandidate</display-name>
<portlet-class>org.springframework.web.portlet.DispatcherPortlet</portlet-class>
<init-param>
<name>contextConfigLocation</name>
<value>/WEB-INF/spring-context/portlet/NewCandidate-portlet.xml</value>
</init-param>
<expiration-cache>0</expiration-cache>
<supports>
<mime-type>text/html</mime-type>
</supports>
<resource-bundle>content/Language</resource-bundle>
<portlet-info>
<title>NewCandidate</title>
<short-title>NewCandidate</short-title>
<keywords>NewCandidate</keywords>
</portlet-info>
<security-role-ref>
<role-name>administrator</role-name>
</security-role-ref>
<security-role-ref>
<role-name>guest</role-name>
</security-role-ref>
<security-role-ref>
<role-name>power-user</role-name>
</security-role-ref>
<security-role-ref>
<role-name>user</role-name>
</security-role-ref>
</portlet>
</portlet-app>


3) liferay-portlet.xml

<?xml version="1.0"?>
<!DOCTYPE liferay-portlet-app PUBLIC "-//Liferay//DTD Portlet Application 7.0.0//EN" "http://www.liferay.com/dtd/liferay-portlet-app_7_0_0.dtd">

<liferay-portlet-app>
<portlet>
<portlet-name>NewCandidate</portlet-name>
<icon>/icon.png</icon>
<requires-namespaced-parameters>false</requires-namespaced-parameters>
<header-portlet-css>/css/main.css</header-portlet-css>
<footer-portlet-javascript>/js/main.js</footer-portlet-javascript>
<css-class-wrapper>NewCandidate-portlet</css-class-wrapper>
</portlet>
<role-mapper>
<role-name>administrator</role-name>
<role-link>Administrator</role-link>
</role-mapper>
<role-mapper>
<role-name>guest</role-name>
<role-link>Guest</role-link>
</role-mapper>
<role-mapper>
<role-name>power-user</role-name>
<role-link>Power User</role-link>
</role-mapper>
<role-mapper>
<role-name>user</role-name>
<role-link>User</role-link>
</role-mapper>
</liferay-portlet-app>


4) Liferay-plugin-package.properties

name=NewCandidate
module-group-id=liferay
module-incremental-version=1
tags=
short-description=
long-description=
change-log=
page-url=http://www.liferay.com
author=Liferay, Inc.
licenses=LGPL
liferay-versions=7.0.0+

5) liferay-display.xml

<?xml version="1.0"?>

<!DOCTYPE display PUBLIC "-//Liferay//DTD Display 7.0.0//EN" "http://www.liferay.com/dtd/liferay-display_7_0_0.dtd">

<display>

<category name="hrms">

<portlet id="NewCandidate" />

</category>

</display>

6)  NewCandidate-portlet.xml

<?xml version="1.0"?>

<beans

xmlns="http://www.springframework.org/schema/beans"

xmlns:context="http://www.springframework.org/schema/context"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd"

>

  

  <bean class="com.newcandidate.portlet.NewCandidatePortlet"></bean>

</beans>

7)portlet-application-context.xml

<?xml version="1.0"?>

<beans

xmlns="http://www.springframework.org/schema/beans"

xmlns:aop="http://www.springframework.org/schema/aop"

xmlns:context="http://www.springframework.org/schema/context"

xmlns:mvc="http://www.springframework.org/schema/mvc"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-3.0.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd">

<context:annotation-config />

<bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">

<property name="contentType" value="text/html;charset=UTF-8" />

<property name="prefix" value="/WEB-INF/jsp/" />

<property name="suffix" value=".jsp" />

<property name="viewClass" value="org.springframework.web.servlet.view.JstlView" />

</bean>

</beans>

view.jsp file

<%@ include file="init.jsp" %>

<h1>Hi this is view.jsp</h1>

NewCandidatePortlet.java 

@Controller("NewCandidatePortlet")

@RequestMapping("view")

public class NewCandidatePortlet {

@RenderMapping

public String render(RenderRequest renderRequest,RenderResponse renderResponse)

{

return "view";

}

}

build.gradle file

apply plugin:'war'

dependencies {

compileOnly group: "com.liferay.portal", name: "com.liferay.portal.kernel", version: "2.0.0"

compileOnly group: "com.liferay.portal", name: "com.liferay.util.taglib", version: "2.0.0"

compileOnly group: "javax.portlet", name: "portlet-api", version: "2.0"

compileOnly group: "javax.servlet", name: "javax.servlet-api", version: "3.0.1"

compileOnly group: "jstl", name: "jstl", version: "1.2"

compileOnly group: "org.osgi", name: "osgi.cmpn", version: "6.0.0"

compile group: 'aopalliance', name: 'aopalliance', version: '1.0'

compile group: 'commons-logging', name: 'commons-logging', version: '1.2'

compile group: 'commons-beanutils', name: 'commons-beanutils', version: '1.2'

compile group: 'commons-fileupload', name: 'commons-fileupload', version: '1.2'

compile group: 'commons-io', name: 'commons-io', version: '1.2'

compile group:"org.osgi", name:"org.osgi.service.component.annotations", version: "1.3.0"

compile group: 'org.springframework', name: 'spring-aop', version: '4.1.9.RELEASE'

compile group: 'org.springframework', name: 'spring-beans', version: '4.1.9.RELEASE'

compile group: 'org.springframework', name: 'spring-context', version: '4.1.9.RELEASE'

compile group: 'org.springframework', name: 'spring-core', version: '4.1.9.RELEASE'

compile group: 'org.springframework', name: 'spring-expression', version: '4.1.9.RELEASE'

compile group: 'org.springframework', name: 'spring-webmvc-portlet', version:'4.1.9.RELEASE'

compile group: 'org.springframework', name: 'spring-webmvc', version: '4.1.9.RELEASE'

compile group: 'org.springframework', name: 'spring-web', version: '4.1.9.RELEASE'

}

Note: Whenever we deployed this module it will generate .war file. It is available 

                 eclipse→windows→show view→navigator→NewCandidate(your module project)→build→libs.