Liferay Artical

How To Install Ant

noreply@blogger.com (Seema Pavar) — Fri, 22 Sep 2017 04:30:00 +0000

How to install Ant?

Ant is a Apache project.It is open source software used to compile , assemble and run java application .Before installing Ant it is compulsory to install Java as mention in my previous article How to install Maven step 1.

Lets Start this step by step:-

Step 1:-Down load Apache Ant
First download Apache ant from Here and extract it in c drive. After extracting set the two environment variable as:-

ANT_Home = C:\apache-ant-1.9.4
PATH = C:\apache-ant-1.9.4\bin

PATH is seperated by ;

Step 2:-Test Apache Ant

For Checking that Ant install successfully you can open command prompt(win+r then type cmd) and type ant -version this will give you detail as:-

How to install Maven

noreply@blogger.com (Seema Pavar) — Thu, 21 Sep 2017 23:30:00 +0000

How to install Maven ?

Defining Maven in a single line is not possible .Maven do many things for us like resolving dependencies, create project structure, build a project, creating war/jar etc. By using Maven you can also create portlet, theme, services without any need of sdk. So lets install maven.

Lets Start this step by step:-

Step 1:-Install Java(jdk)
For installing Maven first we need to download jdk from Here and install.Then set the environment variable(User Variable).For setting environment variable in window 7 .
Click start-->right click on computer-->properties-->Advanced system setting-->Advanced-->Environment variable-->New

The two important variables are:-

1)PATH
This environment variable is provide the path of javac otherwise you have to copy paste your java file into bin and then compile your file from inside the bin folder of jdk. Ex-

PATH = C:\Program Files\Java\jdk1.8.0_31\bin

2)JAVA_HOME
This variable is need to run many other software like tomcat and maven.This takes the path till jdk. Ex-

JAVA_HOME = C:\Program Files\Java\jdk1.8.0_31

For Checking that java install successfully you can open command prompt(win+r then type cmd) and type java -version this will give you detail as:-

Step 2:-Install Maven

For installing Maven first we need to download maven from here and extract in C drive .
Then set M2_HOME = C:\apache-maven-3.2.3
Then set PATH = C:\apache-maven-3.2.3\bin

Now your path become:-

PATH = C:\Program Files\Java\jdk1.8.0_31\bin;C:\apache-maven-3.2.3\bin

Seperated by ;

Step 3:-Check Maven
For Checking that Maven install successfully you can open command prompt(win+r then type cmd) and type mvn -version this will give you detail as:-

Many To Many Relationship in Liferay Services

noreply@blogger.com (Seema Pavar) — Thu, 21 Sep 2017 18:16:00 +0000

Today we will discuss Many To Many relationship in Liferay

As discuss earlier Liferay Service Builder create tables with service.xml. But is there any way to provide Many To Many relationship between entities. Yes there is today we will discuss Many To Many relationship in liferay. Before Reading this blog it is highly recommended to read my previous blog on Service Builder in Detail.

Lets Start this step by step:-

Step 1:-Create service.xml
You can create service as mention in my previous article Service Builder in Detail .

service.xml

	<?xml version="1.0" encoding="UTF-8"?>
	<!DOCTYPE service-builder PUBLIC "-//Liferay//DTD Service Builder 6.2.0//EN" "http://www.liferay.com/dtd/liferay-service-builder_6_2_0.dtd">
	<service-builder package-path="com.aditya" auto-namespace-tables="false">
	<author>aditya.bhardwaj</author>
	<namespace>emplo</namespace>

	<entity name="Employee" local-service="true" remote-service="false" table="Employee">
	<column name="eid" type="long" primary="true"></column>
	<column name="name" type="String"></column>
	<column name="address" type="String"></column>
	<column name="deptid" type="Collection" entity="Department" mapping-table="Employee_department"/>
	</entity>

	<entity name="Department" local-service="true" remote-service="false" table="Department">
	<column name="deptid" type="long" primary="true"></column>
	<column name="department" type="String"></column>
	<column name="eid" type="Collection" entity="Employee" mapping-table="Employee_department"/>
	</entity>
	</service-builder>

view raw service.xml hosted with ❤ by GitHub

Just focus on line no 11 and 17:-

<column name="deptid" type="Collection" entity="Department" mapping-table="Employee_department"/>
<column name="eid" type="Collection" entity="Employee" mapping-table="Employee_department"/>

view raw service.xml hosted with ❤ by GitHub

Explanation:-
Here we create a third entity(table) Employee_department Which contain the primary key of both tables.

Step 2:-Check point
Now build the service.xml and open tables.sql inside sql folder.

tables.sql

create table Department (
 deptid LONG not null primary key,
 department VARCHAR(75) null
);
create table Employee (
 eid LONG not null primary key,
 name VARCHAR(75) null,
 address VARCHAR(75) null
);
create table Employee_department (
 deptid LONG not null,
 eid LONG not null,
 primary key (deptid, eid)
);

view raw tables.sql hosted with ❤ by GitHub

As you can see 3 tables are created two for entities and one for mapping.

Step 3:-Calling Services
Just create a doView() method and add data to the tables here we consider a scenario where one employee belong to two department.

public void doView(RenderRequest renderRequest, RenderResponse renderResponse) throws IOException, PortletException {
 try {
  Employee employee;
  employee = EmployeeLocalServiceUtil.createEmployee(CounterLocalServiceUtil.increment());
  employee.setAddress("Delhi");
  employee.setName("Ramesh");
  employee = EmployeeLocalServiceUtil.addEmployee(employee);
  
  
  Department department1,department2;
  department1 = DepartmentLocalServiceUtil.createDepartment(CounterLocalServiceUtil.increment());
  department1.setDepartment("IT");
  department1 =DepartmentLocalServiceUtil.addDepartment(department1);
  
  department2 = DepartmentLocalServiceUtil.createDepartment(CounterLocalServiceUtil.increment());
  department2.setDepartment("Research");
  department2 =DepartmentLocalServiceUtil.addDepartment(department2);
  DepartmentLocalServiceUtil.addEmployeeDepartments(employee.getEid(), new long[]{department1.getDeptid(),department2.getDeptid()});
 } 
 catch (SystemException e) {
  e.printStackTrace();
 }
}

view raw Testing.java hosted with ❤ by GitHub

Thats it just see the tables in database:-

You can Download source code from Many To Many mapping in Liferay

Custom Sql in Liferay

noreply@blogger.com (Seema Pavar) — Wed, 20 Sep 2017 19:49:00 +0000

Today we will discuss Custom Sql/Sql query in Liferay

Liferay Service Builder create basic CRUD method but there are some scenarios when we have to write SQL query. For writing native SQL query we use the concept of Custom Query in Liferay. Before Reading this blog it is highly recommended to read my previous blog on Service Builder in Detail.

Lets Start this step by step:-

Step 1:-Create service.xml
You can create service as mention in my previous article Service Builder in Detail .

service.xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE service-builder PUBLIC "-//Liferay//DTD Service Builder 6.2.0//EN" "http://www.liferay.com/dtd/liferay-service-builder_6_2_0.dtd">
<service-builder package-path="com.aditya">
<author>Aditya</author>
<namespace>pm</namespace>
<entity name="Student" local-service="true" remote-service="false">
<column name="sid" type="long" primary="true"></column>
<column name="name" type="String"></column>
<column name="rollno" type="int"></column>
<column name="mobileno" type="long"></column>
<order by="asc">
<order-column name="mobileno"></order-column>
</order>
<finder name="Mobile" return-type="Collection">
<finder-column name="mobileno"></finder-column>
</finder>
</entity>
</service-builder>
view raw service.xml hosted with ❤ by GitHub

Step 2:-Create xml files for sql Query
Now create a folder custom-sql inside src and create default.xml in it.

default.xml(/WEB-INF/src/custom-sql/default.xml)

<?xml version="1.0" encoding="UTF-8"?>
<custom-sql >
<sql file="custom-sql/student-custom-sql.xml"/>
</custom-sql >

view raw default.xml hosted with ❤ by GitHub

here we can write our sql query but for good maintanability we create seperate file student-custom-sql.xml and include in default.xml.

student-custom-sql.xml

<?xml version="1.0" encoding="UTF-8"?>
<custom-sql>
<sql id="studentBetweenQuery" >
<![CDATA[
SELECT * from pm_student st WHERE st.sid BETWEEN ? AND ?
]]>
</sql>
</custom-sql>

view raw student-custom-sql.xml hosted with ❤ by GitHub

Here we use sql id this is unique for each query.This id is used to fetch the query in method.
No need to write semicolon(;).
You can create one xml file for one entity and then include in default.xml.

Step 3:-Create xxxFinderImpl Class
Now create xxxFinderImpl class inside persistence in our case create StudentFinderImpl that extends BasePersistenceImpl and implements StudentFinder.

StudentFinderImpl.java

package com.aditya.service.persistence;
import com.aditya.model.Student;
import com.liferay.portal.service.persistence.impl.BasePersistenceImpl;
public class StudentFinderImpl extends BasePersistenceImpl<Student> implements StudentFinder{
}

view raw StudentFinderImpl.java hosted with ❤ by GitHub

Initally it shows error because there is no StudentFinder interface.

Run Service builder

After this error is gone and StudentFinder interface is created which is blank.

StudentFinder.java

package com.aditya.service.persistence;
public interface StudentFinder {
}

view raw StudentFinder.java hosted with ❤ by GitHub

One more class StudentFinderUtil is also created .

StudentFinderUtil.java

package com.aditya.service.persistence;
import com.liferay.portal.kernel.bean.PortletBeanLocatorUtil;
import com.liferay.portal.kernel.util.ReferenceRegistry;
/**
 * @author Aditya
 */
public class StudentFinderUtil {
 public static StudentFinder getFinder() {
  if (_finder == null) {
   _finder = (StudentFinder)PortletBeanLocatorUtil.locate(com.aditya.service.ClpSerializer.getServletContextName(),
     StudentFinder.class.getName());
   ReferenceRegistry.registerReference(StudentFinderUtil.class,
    "_finder");
  }
  return _finder;
 }
 public void setFinder(StudentFinder finder) {
  _finder = finder;
  ReferenceRegistry.registerReference(StudentFinderUtil.class, "_finder");
 }
 private static StudentFinder _finder;
}

view raw StudentFinderUtil.java hosted with ❤ by GitHub

Step 4:-Create method in xxxFinderImpl Class
Create method in this class and provide implementation.This is the main task where we fire query and get the result.

StudentFinderImpl.java

package com.aditya.service.persistence;
import java.util.List;
import com.aditya.model.Student;
import com.aditya.model.impl.StudentImpl;
import com.liferay.portal.kernel.dao.orm.QueryPos;
import com.liferay.portal.kernel.dao.orm.QueryUtil;
import com.liferay.portal.kernel.dao.orm.SQLQuery;
import com.liferay.portal.kernel.dao.orm.Session;
import com.liferay.portal.service.persistence.impl.BasePersistenceImpl;
import com.liferay.util.dao.orm.CustomSQLUtil;
public class StudentFinderImpl extends BasePersistenceImpl<Student> implements StudentFinder {
 public List<Student> getStudentBetweenStudentId(int start, int end) {
  Session session = null;
  try {
   session = openSession();
   String sql = CustomSQLUtil.get("studentBetweenQuery");
   SQLQuery queryObject = session.createSQLQuery(sql);
   queryObject.setCacheable(false);
   queryObject.addEntity("Student", StudentImpl.class);
   QueryPos qPos = QueryPos.getInstance(queryObject);
   qPos.add(start);
   qPos.add(end);
   return (List<Student>) queryObject.list();
   
   //return  (List<Student>) QueryUtil.list(queryObject,getDialect(),start, end);// for pagination feature
  } catch (Exception e) {
   e.printStackTrace();
  } finally {
   closeSession(session);
  }
  return null;
 }
}

view raw StudentFinderImpl.java hosted with ❤ by GitHub

Explanation:-

1)CustomSQLUtil.get("studentBetweenQuery");
Here we fetch the sql query from xml file with the help of sql id. For different queries different id and method in this class.

2)queryObject.addEntity("Student", StudentImpl.class);
Here we add our entity to queryObject. If sql query belong to multiple tables than we have to add all the entities to query object.

3)return (List<Student>) queryObject.list();
Here we return List<Student> because our query return all records belong to Student table but if our query contain two or more table like in case of join then we return List<Object[]>.

Step 5:-Expose method to LocalServiceUtil Class
We can't directly call method from StudentFinderImpl or StudentFinderUtil . All method are call from xxxLocalServiceUtil
Class so first we create method in xxxLocalServiceImpl

StudentLocalServiceImpl.java

public class StudentLocalServiceImpl extends StudentLocalServiceBaseImpl {
 
 public  List<Student> getStudentBetweenStudentId(int start, int end) {
  return StudentFinderUtil.getStudentBetweenStudentId(start, end);
 }
}

view raw StudentLocalServiceImpl.java hosted with ❤ by GitHub

Here this show error because StudentFinderUtil has not containgetStudentBetweenStudentId(start, end).

Run Service builder

Now error is gone coz this will create method in StudentFinder interface and StudentFinderUtil Class also.Now StudentFinder and StudentFinderUtil become:-

StudentFinder.java

public interface StudentFinder {
 public java.util.List<com.aditya.model.Student> getStudentBetweenStudentId(
  int start, int end);
}

view raw StudentFinder.java hosted with ❤ by GitHub

StudentFinderUtil.java

public class StudentFinderUtil {
 public static java.util.List<com.aditya.model.Student> getStudentBetweenStudentId(
  int start, int end) {
  return getFinder().getStudentBetweenStudentId(start, end);
 }
 public static StudentFinder getFinder() {
  if (_finder == null) {
   _finder = (StudentFinder)PortletBeanLocatorUtil.locate(com.aditya.service.ClpSerializer.getServletContextName(),
     StudentFinder.class.getName());
   ReferenceRegistry.registerReference(StudentFinderUtil.class,
    "_finder");
  }
  return _finder;
 }
 public void setFinder(StudentFinder finder) {
  _finder = finder;
  ReferenceRegistry.registerReference(StudentFinderUtil.class, "_finder");
 }
 private static StudentFinder _finder;
}

view raw StudentFinderUtil.java hosted with ❤ by GitHub

Now Both Contain getStudentBetweenStudentId(int start, int end).

Note:-
Normally we first create method in interface then provide implementation in Impl class but in Liferay we provide implementation in xxxLocalServiceImpl first and Run service builder which create method in Inteface.

Step 6:-Call method from LocalServiceUtil Class
Now from your doView() or from jsp call your method as:-

public void doView(RenderRequest renderRequest, RenderResponse renderResponse) throws IOException, PortletException {
 try {
  System.out.println("Student==>"+StudentLocalServiceUtil.getStudentBetweenStudentId(101, 104).size());
     } 
  catch (SystemException e) {
  e.printStackTrace();
 }
 super.doView(renderRequest, renderResponse);
}

view raw Test.java hosted with ❤ by GitHub

You can download source code from Custom Sql in Liferay

Adding a Page ,Change Layout, Adding a Portlet on a page Programmatically(via Code) in Liferay.

noreply@blogger.com (Seema Pavar) — Tue, 19 Sep 2017 21:30:00 +0000

Normally we add a page, change layout adding a portlet on a particular page by using drag and drop or by clicking our mouse.Today we will add a page,Change Layout from 2 to 3 and than finally add a portlet on newly created page Programmatically.

Introduction

For doing this we basically focus on two classes:-

1)LayoutLocalServiceUtil

Because page means layout in liferay thats why we use LayoutLocalServiceUtil
For using method of LayoutLocalServiceUtil we need userID , groupID so we also need ThemeDisplay Object.

2)LayoutTypePortlet

Object of this Class is used to programmatically add or remove a portlets from a page.This object can be get in jsp by <liferay-theme:defineObjects />

Ok Lets discuss step by Step

Step 1 :- Create Liferay project and Generic Portlet in it.

Create a liferay project then create a generic portlet in it . Copy this code inside your view.jsp

view.jsp

	<%@ taglib uri="http://java.sun.com/portlet_2_0" prefix="portlet" %>
	<portlet:defineObjects />
	<portlet:actionURL var="addPage" name="addPageAction"></portlet:actionURL>
	<portlet:actionURL var="updatePageLayout" name="updatePageLayout"></portlet:actionURL>
	<portlet:actionURL var="addPortlet" name="addPortlet"></portlet:actionURL>

	<a href="<%=addPage %>">Adding Page</a><br>
	<a href="<%=updatePageLayout %>">Update Page Layout</a><br>
	<a href="<%=addPortlet %>">Add Loan Calculator</a>

view raw view.jsp hosted with ❤ by GitHub

Explanation:-

Here we create just 3 action URL that hit 3 different methods on click.

Step 2 :- Adding a Page.

On Clicking Adding Page addPage method is called which is responsible for adding a page in Liferay.

@ProcessAction(name="addPageAction")
 public void addPageAction(ActionRequest request, ActionResponse response)throws PortletException{
    ThemeDisplay themeDisplay = (ThemeDisplay)request.getAttribute(WebKeys.THEME_DISPLAY)
    long userId = themeDisplay.getUserId();
    long groupId = themeDisplay.getScopeGroupId();
    boolean privateLayout = false;// private page or public page
    long parentLayoutId = 0;
    String name = "Dynamic";
    String title = "Inside SEO HTML Title";
    String description = "Inside SEO Description";
    String type = LayoutConstants.TYPE_PORTLET;
    boolean hidden = false;
    String friendlyURL = "/dynamic";
    ServiceContext serviceContext = new ServiceContext();
     try 
        { 
            LayoutLocalServiceUtil.addLayout(userId, groupId, privateLayout, parentLayoutId,name,title,description, type, hidde,friendRL,serviceContext);
        } 
    catch (PortalException e) 
      {
      e.printStackTrace();
      }
  }

view raw AddPageAction.java hosted with ❤ by GitHub

Explanation:-

Here we use addLayout method of LayoutLocalServiceUtil Class which take parameters as:-

a)UserId:- Current User Id .

b)GroupId:- Group id from which user is belong.

c)Private Layout:- The page added as a public(false) page or private(true) page.

d)name:- Name of the page appears in menu.

e)title:-That is show on tabs of browser.

f)description:- description about the page.

g)type:- type of page .ex- Panel ,embedded etc.

i)hidden:- page is shown in menu bar or not.

j)friendlyUrl:- the friendly Url for the page.

After Clicking the link just Reload the page will appear in menu bar.

Step 3 :-Change Page Layout

By default the page is added with 2 column .If you want to change from 2 column layout to 3 column layout click on update page Layout link.

   @ProcessAction(name="updatePageLayout")
     public void updatePageLayout(ActionRequest request, ActionResponse response)throws PortletException{
     ThemeDisplay themeDisplay = (ThemeDisplay)request.getAttribute(WebKeys.THEME_DISPLAY);
     long groupId = themeDisplay.getScopeGroupId();
     String friendlyURL = "/dynamic";
     boolean privateLayout = false;
     long userId = themeDisplay.getUserId();
     try {
              Layout layout =LayoutLocalServiceUtil.getFriendlyURLLayout(groupId, privateLayout, friendlyURL);
              LayoutTypePortlet layoutTypePortlet = (LayoutTypePortlet) layout.getLayoutType();
              layoutTypePortlet.setLayoutTemplateId(userId, "3_columns");
              LayoutLocalServiceUtil.updateLayout(layout.getGroupId(), layout.getPrivateLayout(),layout.getLayoutId(), layout.getTypeSettings());
         } catch (Exception e) {
               e.printStackTrace();
         } 
     }

view raw ChangeLayout.java hosted with ❤ by GitHub

Explanation:-

>Here first we get the Layout(ie page) Object for which we have to change the layout by providing friendlyUrl and other values.

>Then we get the LayoutTypePortlet Object and then use setLayoutTempelateId method.

>Other values rather than "3_columns" can be found (\ROOT\layouttpl\custom)

Step 4:- Adding Portlet on Page

Now we have a page with 3 Column layout.Now we add Loan Calculator portlet on the page. Just Click the link Add Loan Calculator this will call the addPortlet method.

@ProcessAction(name="addPortlet")
public void addPortlet(ActionRequest request, ActionResponse response)throws PortletException{
   ThemeDisplay themeDisplay = (ThemeDisplay)request.getAttribute(WebKeys.THEME_DISPLAY);
   long groupId = themeDisplay.getScopeGroupId();
   String friendlyURL = "/dynamic";
   boolean privateLayout = false;
   long userId = themeDisplay.getUserId();   
   try {
         Layout layout =LayoutLocalServiceUtil.getFriendlyURLLayout(groupId, privateLayout, friendlyURL);
         LayoutTypePortlet layoutTypePortlet = (LayoutTypePortlet) layout.getLayoutType();
         layoutTypePortlet.addPortletId(userId, "61", "column-1", -1);
         LayoutLocalServiceUtil.updateLayout(layout.getGroupId(), layout.getPrivateLayout() ,layout.getLayoutId() , layout.getTypeSettings());
       } 
catch (Exception e) 
     {
        e.printStackTrace();
     } 
 }

view raw AddPortlet.java hosted with ❤ by GitHub

Explanation:-

>Here first we again get the Layout(ie page) Object on which we have to add the portlet by providing friendlyUrl and other values.

>Then we use the method addPortletId which take 4 parameters as:-

a)UserId:- Current User Id .

b)PortletId:- id of the portlet which is to be added on page.

c)ColoumnId:-In which column you want to add your portlet. Ex- column-1 hence portlet added at LHS if column-1 then portlet added at centre and if column-3 portlet added at RHS.

d)Column Position:- Consider if there is already any other portlet in particular column.

0>=:-Our portlet is added at the top of existing portlet.

-1 :-Our portlet is added at the bottom of existing portlet.

>Finally we update the layout

you can download source code from Here

Finder method for Service Builder in Liferay

noreply@blogger.com (Seema Pavar) — Tue, 19 Sep 2017 19:01:00 +0000

Today we will Discuss Finder method for Service Builder in Liferay

In my Previous article Service Builder in Detail we see that liferay created basic CRUD method automatically but what if we want to add our custom method in Liferay services . There are many ways but creating Finder method is the simplest one.

Lets Start this step by step:-

Step 1:-Create service.xml
You can create service as mention in my previous article Service Builder in Detail .Today we add finder method in my Services:-

Service.xml

	<?xml version="1.0" encoding="UTF-8"?>
	<!DOCTYPE service-builder PUBLIC "-//Liferay//DTD Service Builder 6.2.0//EN" "http://www.liferay.com/dtd/liferay-service-builder_6_2_0.dtd">
	<service-builder package-path="com.aditya">
	<author>Aditya</author>
	<namespace>pm</namespace>
	<entity name="Student" local-service="true" remote-service="false">
	<column name="sid" type="long" primary="true"></column>
	<column name="name" type="String"></column>
	<column name="rollno" type="int"></column>
	<column name="mobileno" type="long"></column>
	<order by="asc">
	<order-column name="mobileno"></order-column>
	</order>
	<finder name="Mobile" return-type="Collection">
	<finder-column name="mobileno"></finder-column>
	</finder>
	</entity>
	</service-builder>

view raw service.xml hosted with ❤ by GitHub

Just Focus on these lines:-

<finder name="Mobile" return-type="Collection">
            <finder-column name="mobileno"></finder-column>
</finder>

view raw finder.xml hosted with ❤ by GitHub

Explanation:-

1) <finder name="Mobile" return-type="Collection">

a) name="Mobile"

This is the name by which method is Created. Our method is Created by name

findByMobile(). findBy is automatically prepended by liferay.

Note=> The name must be Capital otherwise method is created as findBymobile()
which is not follow java camel case convention.

b) return-type="Collection"
return type of our method Collection represent List<T> in this case List<Student>.

2)<finder-column name="mobileno"></finder-column>
Column-name represent on which column you want to apply conditions.

After doing this just build your service and refresh your project.

Step 2:-Check Point

At this point liferay create our method in two places:-

1)StudentPersistence (Interface)
(under web-inf/services/com/aditya/services/persistence)

This interface contain many overloaded method of same name like:-

public java.util.List<com.aditya.model.Student> findByMobile(long mobileno)
  throws com.liferay.portal.kernel.exception.SystemException;
  
public java.util.List<com.aditya.model.Student> findByMobile(
  long mobileno, int start, int end)
  throws com.liferay.portal.kernel.exception.SystemException;
  
public java.util.List<com.aditya.model.Student> findByMobile(
  long mobileno, int start, int end,
  com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
  throws com.liferay.portal.kernel.exception.SystemException;
  
public com.aditya.model.Student findByMobile_First(long mobileno,
  com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
  throws com.aditya.NoSuchStudentException,
   com.liferay.portal.kernel.exception.SystemException;

view raw StudentPersistence.java hosted with ❤ by GitHub

Their are other method also like removeByMobile, countByMobile etc.

2)StudentPersistenceImpl (Class)
(under web-inf/src/com/aditya/services/persistence)
This contain the implementation of StudentPersistence interface.

Step 3:-Expose method to Util Classes

Till now our method is not available to LocalServiceUtil Class.We have to expose it.Open StudentLocalServiceImpl Class. This class is just blank provide implementation of your method here so that it can be available by Util Class.

public List<Student> findByMobile(int mobileno) throws SystemException
{
    return this.studentPersistence.findByMobile(mobileno);
}

view raw StudentLocalServiceImpl.java hosted with ❤ by GitHub

As you see in implementation we just call the method from interface thats it.Now again build services and that it .Your method is now available to StudentLocalServiceUtil Class.

You can download source code from Finder method for service builder in lifeary

Search Container in Liferay 6.2

noreply@blogger.com (Seema Pavar) — Tue, 19 Sep 2017 16:30:00 +0000

Liferay Provide a simple and easy way to show list of Objects in proper tabular format with pagination by using Search Container tag of liferay.

Our goal is to show a list of Student in which:-

1)Column show student name,last name,Class etc.

2)In one column we show address of Student that comes from another jsp.
3)In one column we provide a link .When user click on that link it will go to another jsp that show complete detail of Student.

4)In one column we provide delete row feature.
5)Also we provide pagination among the list.

Step 1:-Create Liferay Portlet and Services

First we create a liferay plugin project than create a portlet in this project. Then create sevice.xml and build services. For details of services you can read my Previous Blog.
Project Structure look like :-

This is my service.xml

service.xml

	<?xml version="1.0" encoding="UTF-8"?>
	<!DOCTYPE service-builder PUBLIC "-//Liferay//DTD Service Builder 6.2.0//EN" "http://www.liferay.com/dtd/liferay-service-builder_6_2_0.dtd">
	<service-builder package-path="com.student.services" auto-namespace-tables="true">
	<author>Aditya</author>
	<namespace>search</namespace>
	<entity name="Student" local-service="true" cache-enabled="false" table="student">
	<column primary="true" name="studentId" type="int" id-type="increment"></column>
	<column name="name" type="String"></column>
	<column name="lastname" type="String"></column>
	<column name="std" type="String"></column>
	<column name="address" type="String"></column>
	<column name="phone" type="String"></column>
	<column name="gender" type="String"></column>
	</entity>
	</service-builder>

view raw service.xml hosted with ❤ by GitHub

This is my database table:-

Step 2:-Change view.jsp
Open view.jsp and paste this :-

view.jsp

	<%@page import="com.liferay.portal.kernel.language.LanguageUtil"%>
	<%@page import="com.student.services.model.Student"%>
	<%@page import="java.util.List"%>
	<%@page import="com.liferay.portal.util.PortalUtil"%>
	<%@page import="com.student.services.service.StudentLocalServiceUtil"%>
	<%@ taglib uri="http://java.sun.com/portlet_2_0" prefix="portlet" %>
	<%@ taglib uri="http://liferay.com/tld/ui" prefix="liferay-ui"%>
	<%@ page import="com.liferay.portal.kernel.util.ListUtil" %>
	<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
	<%@ taglib uri="http://liferay.com/tld/portlet" prefix="liferay-portlet" %>
	<portlet:defineObjects />
	<%
	String currentURL = PortalUtil.getCurrentURL(request);
	List<Student>studentList = StudentLocalServiceUtil.getStudents(0, StudentLocalServiceUtil.getStudentsCount());
	%>
	<h3>Search Container in Liferay</h3>

	<liferay-portlet:renderURL varImpl="iteratorURL">
	<portlet:param name="mvcPath" value="/html/searchcontainer/view.jsp" />
	</liferay-portlet:renderURL>

	<liferay-ui:search-container var="searchContainer" delta="5" deltaConfigurable="true" emptyResultsMessage="Sorry. There are no record to display." iteratorURL="<%=iteratorURL %>">

	<liferay-ui:search-container-results results="<%= ListUtil.subList(studentList, searchContainer.getStart(), searchContainer.getEnd()) %>" total="<%= studentList.size() %>"/>

	<%-- OR
	<liferay-ui:search-container-results
	results="<%= StudentLocalServiceUtil.getStudents(searchContainer.getStart(), searchContainer.getEnd()) %>"
	total="<%= StudentLocalServiceUtil.getStudentsCount() %>"
	/> --%>

	<liferay-ui:search-container-row className="com.student.services.model.Student" modelVar="student" keyProperty="studentId" >

	<portlet:renderURL var="rowURL">
	<portlet:param name="backURL" value="<%=currentURL %>" />
	<portlet:param name="studentId" value="${student.studentId}" />
	<portlet:param name="mvcPath" value="/html/searchcontainer/student_detail.jsp"/>
	</portlet:renderURL>

	<liferay-ui:search-container-column-text property="name" name="Student Name" href="${rowURL}"/>
	<liferay-ui:search-container-column-text name="Sir Name">Mr. ${student.lastname}</liferay-ui:search-container-column-text>
	<liferay-ui:search-container-column-text property="phone" name="<%=LanguageUtil.get(pageContext, \"phone\") %>"/>

	<c:choose>
	<c:when test="${student.studentId <= '4'}">
	<liferay-ui:search-container-column-text cssClass="blue" property="std" name = "Class" />
	</c:when>
	<c:otherwise>
	<liferay-ui:search-container-column-text cssClass="green" property="std" name = "Class" />
	</c:otherwise>
	</c:choose>

	<liferay-ui:search-container-column-text name="Gender" value='<%=(student.getGender().equalsIgnoreCase("M"))?"Male":"Female"%>'/>
	<liferay-ui:search-container-column-jsp name="Address" align="left" path="/html/searchcontainer/address.jsp"/>
	<liferay-ui:search-container-column-text href="${rowURL}" name="Detail" value="Click Here For Detail"/>

	<!-- For Delete URL -->
	<portlet:actionURL var="deleteStudent" name="deleteStudent">
	<portlet:param name="backURL" value="<%=currentURL %>" />
	<portlet:param name="studentId" value="${student.studentId}" />
	</portlet:actionURL>
	<liferay-ui:search-container-column-text name="Delete Student" value="Delete" href="${deleteStudent}"/>

	</liferay-ui:search-container-row>
	<liferay-ui:search-iterator />
	</liferay-ui:search-container>

view raw view.jsp hosted with ❤ by GitHub

Explaination of view.jsp:-

a)String currentURL = PortalUtil.getCurrentURL(request);

By using getCurrentURL we can get the URL of Current Page this url is helpful when we get back from detail page to our current list page.

b)<liferay-ui:search-container >

This tag contain the following attributes:-

-delta:- This attribute is used to set by default how many records per page is shown.

-deltaConfigurable:- This attribute is used so that end user can change no of records per page.
-emptyResultsMessage:- If there is no record then this message is displayed.
-iteratorURL:- If there are multiple tabs and each tab contain a search container then this iteratorURL maintain pagination otherwise after pagination it will go portlet default page irrespective of where your search container.

C)<liferay-ui:search-container-results results=" " total=""/>

This result tag has two main attribute like:-

-results:- This attribute contain records with start index and end index . The start index and end index can be get with the help of searchContainer Object.The object of searchContainer is available as soon as we include the import statement:-

<%@ taglib uri="http://liferay.com/tld/ui" prefix="liferay-ui"%>

Example:-

StudentLocalServiceUtil.getStudents(searchContainer.getStart(), searchContainer.getEnd()) %>"

-total:- This attribute contain total number of records.

d)<liferay-ui:search-container-row className=" " modelVar="" keyProperty="">

This search container row tag contain attribute:-

-className:-This contain the full path of your model Class like Student in this case.

-modelVar:- This contain the current object that is available in the row .You can use this to get values and provide in Urls etc.

-keyProperty:- Primary key of Model Object.

e)<liferay-ui:search-container-column-text property="" name="" href="" value="" cssClass=""/>

This search container column-text property tag is used to set the value in column.For each column their is one tag.This contain attribute:-

-property:- This must be the same as fields mention in Model Class whose getter and setters are available.If this match with instance variables of Model Class(Student) then it get value automatically from current object

-name:- Header name of your column.You can also get this name from Language.properties file.

Example:-
<liferay-ui:search-container-column-text property="phone" name="<%=LanguageUtil.get(pageContext, \"phone\") %>"/>

For this just create a folder(content) inside src and then create a Language.properties inside this:-

Language.properties
phone = Telephone Number

And then provide the entry of Language.properties inside portlet.xml like this:-

portlet.xml
<resource-bundle>content.Language</resource-bundle>

-href:- If you want any action is perform on Clicking of this field then pass Url here.

-Value:- Any specific value you want to show on the basis of value of database or any hardcoded value.Otherwise by property tag it will automatically take from current object.

Example:-

<liferay-ui:search-container-column-text name="Gender" value='<%=(student.getGender().equalsIgnoreCase("M"))?"Male":"Female"%>'/>

Here value is by default is M or F but we use Current Object and get Gender and on the basis of result we change the value to Male or Female.

-cssClass:- You can provide any css and mention in main.css

Example:-
<liferay-ui:search-container-column-text cssClass="blue" property="std" name = "Class" />

paste this inside main.css:-

.blue {
color: blue;
}

f)<liferay-ui:search-container-column-jsp name="" align="left" path=""/>

If you want to show a particular jsp in some column then you can use this tag by providing complete path of your jsp.

g)<liferay-ui:search-iterator />

This is iterator this tag must come after row tag this iterate the list and create rows.

For Detail Explanation watch the video

Step 3:- Create the jsps
Create display_student.jsp inside html/searchcontainer

display_student.jsp

<%@page import="com.student.services.model.Student"%>
<%@page import="com.student.services.service.StudentLocalServiceUtil"%>
<%@page import="com.liferay.portal.kernel.util.ParamUtil"%>
<%
String redirect = ParamUtil.getString(request, "backURL");
int studentId = ParamUtil.getInteger(request, "studentId");
Student student = StudentLocalServiceUtil.getStudent(studentId);
request.setAttribute("student", student);
%>
<h1>Student Information</h1>
<h3>Name : ${student.name}  ${student.lastname} </h3>
<h3>Phone :${student.phone}</h3>
<h3>Class :${student.std}</h3>
<h3>Address :${student.address}</h3>
<br><br>
<a href="<%= redirect %>">Back to All</a>

view raw student_detail.jsp hosted with ❤ by GitHub

Note:-The back to all link use the URL that is captured by PortalUtil.getCurrentURL(request) in view.jsp and send with renderUrl. So that we can go back to view.jsp again.

Now Create address.jsp inside html/searchcontainer:-

address.jsp

<%@page import="com.student.services.model.Student"%>
<%@page import="com.liferay.portal.kernel.util.WebKeys"%>
<%@page import="com.liferay.portal.kernel.dao.search.ResultRow"%>
<%
ResultRow row = (ResultRow)request.getAttribute(WebKeys.SEARCH_CONTAINER_RESULT_ROW);
Student student = (Student)row.getObject();
%>
<%=student.getAddress()%>

view raw address.jsp hosted with ❤ by GitHub

Note:-This Complete jsp is directly put in column(search-container-column-jsp tag)

Step 4:- Change the Controller

SearchContainer.java

package com.search;
import java.io.IOException;
import javax.portlet.ActionRequest;
import javax.portlet.ActionResponse;
import javax.portlet.PortletException;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.util.ParamUtil;
import com.liferay.util.bridges.mvc.MVCPortlet;
import com.student.services.service.StudentLocalServiceUtil;
public class SearchContainer extends MVCPortlet {
 
public void deleteStudent(ActionRequest actionRequest,ActionResponse actionResponse) throws IOException, PortletException {
 String backURL  = ParamUtil.getString(actionRequest, "backURL");
 int studentId = ParamUtil.getInteger(actionRequest, "studentId");
      try {
  StudentLocalServiceUtil.deleteStudent(studentId);
  System.out.println("Successfully Deleted Student of Id =>"+studentId);
  actionResponse.sendRedirect(backURL); 
   } catch (PortalException | SystemException e) {
  e.printStackTrace();
 }
      
  }
}

view raw SearchContainer.java hosted with ❤ by GitHub

Explanation:-
Here we just delete the student on the basis of studentId and after that send to that particular page by using backurl.

Step 5:-Check the Output
Now deploy the portlet and add to page:-

On Click on Student Name or Detail Control goes to another jsp where we show whole data related to student.

Liferay Service Builder in Detail

noreply@blogger.com (Seema Pavar) — Tue, 19 Sep 2017 08:30:00 +0000

Today we will see concept of Service Builder in liferay

Before reading this blog it is highly recommended to read my blog on Service Builder in Liferay .Liferay Service Builder based on hibernate and Spring DI .Service builder create tables automatically as in Hibernate.Service builder generates Services for the entities in two location. These location use the package path describe in service.xml :-

1)docroot/WEB-INF/services/package name
2)docroot/WEB-INF/src/package name

Service Builder divide the source in 2 layers:
1)An interface Layer
2)An implementation Layer

You ’ll never change anything in the interface layer manually.The implementation layer is generated in your src folder and is initially skeleton code that allows you to implement the functionality you need.

Service builder also create src folder inside META-INF folder .This folder contains all the Spring configuration files and Hibernate configuration.

Sample service.xml

<service-builder package-path="com.student.services" auto-namespace-tables="true">

<namespace>Aditya</namespace>

</entity>

</service-builder>

We will discuss each and every tag in detail

1)<service-builder package-path="com.student.services" auto-namespace-tables="true">

a)service-builder package-path

This is the path of package in which all the java file is generated

b)auto-namespace-tables

By default it is false if this is true then table is created in database with a prefix of namespace.

(But if there is no table tag we see it later)

2) <author>monu</author>

This tag is not mandatory.

Service Builder also generates Javadoc, and the name you place in the Author tags winds up in the Javadoc as the author of the code.

You can skip this tag but if you mention all Java classes have author name as mention like in this case monu.

Ex -

* @author seema

* @see StudentModel

* @see com.student.services.model.impl.StudentImpl

* @see com.student.services.model.impl.StudentModelImpl

* @generated

public interface Student extends StudentModel, PersistedModel {

}

3) <namespace>Aditya</namespace>

This tag is mandatory .

By default, tables you define with Service Builder go in the Liferay database. To set them off from the rest of Liferay’s tables, you can prefix them with a namespace. This table, when created, will be called Aditya_Student in the database.

If auto-namespace-tables is true than this name is appended before table name.The entry of this namespace is also mention in database with a table name servicecomponent that contain various columns like build number ,build date.

Ex-

Note :-

a)When ever you want to change the structure of table like number of columns and changes not reflect then delete entry of namespace from this table and build service again.

b)Namespace must be some valid name .Ex- Aditya9 this number 9 will create a problem in build service.

4) <entity name="Student" local-service="true" cache-enabled="false" table="student">

a)entity name="Student"

This name is compulsory but need not to be same as table name.

All Service classes are made by this name like entityLocalServiceUtil etc.

Ex- StudentLocalServiceUtil

b)cache-enabled=""

By using cache-enabled true data base data is cached.

c)table="student"

This tag is not Compulsory

If you skip this tag then table in database is created with same name as entity name. Otherwise table name in database is same as table tag

d)local-service="true"

By using local-service true we can use our services as web services like SOAP

5) <column primary="true" name="studentId" type="int" id-type="increment"></column>

a)primary="true"

Means this field is primary key for database.

b)name="studentId"

Column is created with studentId in database

c)type="int"

Field is of int type. We have many options like int,long,String etc.

d)id-type="increment"

This field is of autoincrement type. Other options are sequence,identity etc.

Some Cases:-

1)<service-builder package-path="com.student.services" auto-namespace-tables="true">

<namespace>Aditya</namespace>

</entity>

</service-builder>

Table name = StudentData

Reason:-Because we provide table tag so namespace has no significance here.

2)<service-builder package-path="com.student.services" auto-namespace-tables="true">

<namespace>Aditya</namespace>

</entity>

</service-builder>

Table name = aditya_student (namespace_entityname)

Reason:-Because auto-namespace-table="true"

3)<service-builder package-path="com.student.services" auto-namespace-tables="false">

<namespace>Aditya</namespace>

</entity>

</service-builder>

Table name = Student

Reason:-Because auto-namespace-table="false" and no table tag so table is created with name same as entity name.

Complsory Fields

1)<namespace>Aditya</namespace> because entry in service component

2)entity name all java files created with this

Optional Fields

1)<author></author>

2)table name="optional"

Classes Created by Service Builder

1)com.student.services.model.impl

a)StudentBaseImpl
b)StudentCacheModel
c)StudentImpl
d)StudentModelImpl

2)com.student.services.service.base

a)StudentLocalServiceBaseImpl
b)StudentLocalServiceClpInvoker
c)StudentServiceBaseImpl
d)StudentServiceClpInvoker

3)com.student.services.service.http

a)StudentServiceSoap

4)com.student.services.service.impl

a)StudentLocalServiceImpl
b)StudentServiceImpl

5)com.student.services.service.persistence

a)StudentPersistenceImpl

Thats it Hope this Help Someone

Liferay Jsp Hook for override login jsp

noreply@blogger.com (Seema Pavar) — Tue, 19 Sep 2017 03:30:00 +0000

Today we write a Hook for overriding default Login Page. Here we remove the openID, Create Account and Forgot Password links

Step 1:- Create a Liferay Plugin project and select Hook

Create a liferay plugin project give project name as LoginProject and select hook then finish.

Step 2:- Create a Login hook in the Project

Right click on the project> New >Liferay Hook Configuration>Select Custom Jsp>Next

Click Add from Liferay

then search for login.jsp >Ok>Finish

Step 3:- Now Override login.jsp

You can Override the jsp as per your need, we can see that the links come from navigation.jsp which is included in login.jsp so we just comment the included part.

Code Snipplet From login.jsp

..........
..........

<aui:button-row>

<aui:button type="submit" value="sign-in" />

</aui:button-row>

</aui:form>

.........
.........

Step 4:- Deploy the Hook and see the output

And Build your build.xml and try to login you see a login page with no links for openID, Create Account and Forgot Password

Note:-

In this way you can override default login page provide by liferay when you deploy your hook it create a ".portal.jsp" file in

(..\tomcat-7.0.42\webapps\ROOT\html\portlet\login) .

So we have 2 file :-

1)login.jsp

2)login.portal.jsp

when you deploy your hook "login.portal.jsp" is in use when you undelpoy your hook "login.portal.jsp" is deleted and again login.jsp is in use.

Liferay Service Hook to override Liferay Existing Service

noreply@blogger.com (Seema Pavar) — Mon, 18 Sep 2017 18:00:00 +0000

Today we will see how to write service wrapper in Liferay 6.2. We override User service getUserCount().Here we create a class that extend the particular wrapper class and just provide the entries of our custom class in liferay-hook.xml so that liferay use our services instead of Original.

Step 1:-Create a liferay Plug project
Right Click in Project Explorer and Click New -> Liferay plugin project. Now give the Project name and select hook in plugin type:-

Step 2:-Create a hook in the project

Right Click on Project ->New->Liferay Hook Configuration->Select Services

Click Next--->Click Add-->Select Service Type(UserLocalService)

For Impl Class

Click New-->Give Package Name and your Impl Class Name

Then Click Finish

This step automatically Create the entry in liferay-hook.xml.

<hook>

<service>

<service-type>com.liferay.portal.service.UserLocalService</service-type>

<service-impl>com.ipg.MyUserLocalService</service-impl>

</service>

</hook>

Step 3:-Override the getUserCount()

Open MyUserLocalService and override getUserCount()

package com.ipg;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.service.UserLocalServiceWrapper;
import com.liferay.portal.service.UserLocalService;
public class MyUserLocalService extends UserLocalServiceWrapper {
public MyUserLocalService(UserLocalService userLocalService) {
super(userLocalService);
}
@Override
public int getUsersCount() throws SystemException {
System.out.println("This text is from getUsersCount ");
return super.getUsersCount();
}
}

view raw MyUserLocalService.java hosted with ❤ by GitHub

Step 4:-Deploy the Hook
Deploy the hook and call getUsersCount() from your portlet .

public void doView(RenderRequest renderRequest,
RenderResponse renderResponse) throws IOException, PortletException {
try {
UserLocalServiceUtil.getUsersCount();
} catch (SystemException e) {
e.printStackTrace();
}
super.doView(renderRequest, renderResponse);
}

view raw Demo.java hosted with ❤ by GitHub

Output:-This text is from getUsersCount

Add Portlet(Custom portlet) to Control Panel

noreply@blogger.com (Seema Pavar) — Mon, 18 Sep 2017 12:00:00 +0000

Today we learn how to move a Custom portlet from Application menu to Control panel.

Step 1:- Create a simple Hello World Portlet

Create a simple Hello World Portlet and provide display Category as HelloWorld so this portlet is available in Category HelloWorld.

liferay-display.xml

<?xml version="1.0"?>
<!DOCTYPE display PUBLIC "-//Liferay//DTD Display 6.2.0//EN" "http://www.liferay.com/dtd/liferay-display_6_2_0.dtd">

<display>
<category name="HelloWorld">
<portlet id="hello-world"></portlet>
</category>
</display>

So this portlet is shown as:-

Step 2:- Search For DTD

Go to the URL mention in liferay-portlet.xml (http://www.liferay.com/dtd/liferay-portlet-app_6_2_0.dtd) and

a)search for tag <control-panel-entry-category>



by using this you can decide in which category you want to display your portlet.

b)search for tag <control-panel-entry-weight>



So we use a) and b) in liferay-portlet.xml as

<portlet>
<portlet-name>hello-world</portlet-name>
<icon>/icon.png</icon>
<control-panel-entry-category>sites</control-panel-entry-category>
<control-panel-entry-weight>1.0</control-panel-entry-weight>
<header-portlet-css>/css/main.css</header-portlet-css>
<footer-portlet-javascript>/js/main.js</footer-portlet-javascript>
<css-class-wrapper>hello-world-portlet</css-class-wrapper>
</portlet>

Deploy it and this portlet shown in sites .

But there is a problem this portlet shown in Control panel as well as in Applicaton so we have to remove it from Application.

Step 3:-Hiding portlet from Application

Find the file liferay-display.xml in server
(\tomcat-7.0.42\webapps\ROOT\WEB-INF\liferay-display.xml)
and search the tag <category name="category.hidden"> use this category in your liferay-display.xml

<display>
<category name="category.hidden">
<portlet id="hello-world"></portlet>
</category>
</display>

Note:-If you use any other Category like category.community or category.finance then this portlet goes to that particlar category.

And thats it Your Portlet is now available in Control panel and not in Application.

In the next blog we learn how to move a Out of box portlet from Application menu to Control panel.

Validation In Liferay

noreply@blogger.com (Seema Pavar) — Mon, 18 Sep 2017 03:30:00 +0000

Validation in Liferay by using Validator Class Provided by Liferay

Validation in Liferay is very simple by using Validator Class. Validator Class give all the usefull method that can be used for validation. You can also use your logic for validation. In this tutorial i use both approach.

Here we create a simple form that contain a text field for phone number we validate that phone number must contain Numbers and not less than 10 digits if error occur again this form is shown with already filled previous value otherwise go to success page.

Step 1 :- Create liferay project in java file paste the content

package com.test;

import java.io.IOException;

import javax.portlet.ActionRequest;

import javax.portlet.ActionResponse;

import javax.portlet.PortletException;

import javax.portlet.PortletRequestDispatcher;

import com.liferay.portal.kernel.portlet.LiferayPortletConfig;

import com.liferay.portal.kernel.servlet.SessionErrors;

import com.liferay.portal.kernel.servlet.SessionMessages;

import com.liferay.portal.kernel.util.ParamUtil;

import com.liferay.portal.kernel.util.Validator;

import com.liferay.portal.util.PortalUtil;

import com.liferay.util.bridges.mvc.MVCPortlet;

public class ValidationDemo extends MVCPortlet {

public void inClass(ActionRequest request,ActionResponse response) throws PortletException, IOException

{

String phoneNumber = ParamUtil.getString(request, "phone");

SessionMessages.add(request, ((LiferayPortletConfig)getPortletConfig()).getPortletId() + SessionMessages. KEY_SUFFIX_HIDE_DEFAULT_ERROR_MESSAGE);

if(!Validator.isDigit(phoneNumber))

{

SessionErrors.add(request, "notNumber");

}

if(phoneNumber.length()!=10)

{

SessionErrors.add(request, "lessLength");

}

request.setAttribute("phoneNumber", phoneNumber);

if(SessionErrors.isEmpty(request))

{

response.setRenderParameter("jspPage","/html/validationdemo/success.jsp");

}

Explanation:-

1)Using Validator Class:-we use Validator.isDigit(String) method to check that Phone number must be between 0-9 and not contain a-z orA-Z.

2)Using Custom Logic:-In (phoneNumber.length()!=10) we check that Phone number must contain 10 digits.

In both we add error key in SessionsError

3)If error occur we send back the Phone number to view.jsp so that it fill in the text box again

request.setAttribute("phoneNumber", phoneNumber);

4)If no error occur we send response to success.jsp

Step 2:- Paste Content to view.jsp

<%@ taglib uri="http://java.sun.com/portlet_2_0" prefix="portlet" %>

<%@ taglib uri="http://liferay.com/tld/ui" prefix="liferay-ui"%>

<portlet:defineObjects />

<portlet:actionURL name="inClass" var="injsp"></portlet:actionURL>

<liferay-ui:error key="notNumber" message="Phone Number not Contain Alphabets"/>

<liferay-ui:error key="lessLength" message="Phone Number Must be of 10 Digit"/>

Phone Number:<input type="text" name="phone" value="${phoneNumber}"><br>

</form>

Explanation:-

1) The Error keys map with Corresponding messages

<liferay-ui:error key="notNumber" message="Phone Number not Contain Alphabets"/>

<liferay-ui:error key="lessLength" message="Phone Number Must be of 10 Digit"/>

2)In input box we set the value of phone number send by request

Step 3:- Paste Content to success.jsp

<h1>Success Fully Submitted</h1>

Step 4:-Deploy your Project and see output

Liferay Message Customization

noreply@blogger.com (Seema Pavar) — Sun, 17 Sep 2017 20:30:00 +0000

Customize liferay Error and Success Messages . Here If user provide hello as name and hello as password success message is shown otherwise error message is shown

Step 1:-Create Liferay Project

In eclipse click File-->New Liferay Plugin Project-->Give Project Name --> Finish

Step 2:-Create Liferay Portlet in the project

Then Right Click on Project-->New Liferay Portlet-->Give the portlet Class-->And select Generic Portlet-->next

then give the Display Category and finish

Step 3:- Add the following code in view.jsp

<%@ taglib uri="http://java.sun.com/portlet_2_0" prefix="portlet" %>

<%@taglib uri="http://liferay.com/tld/ui" prefix="liferay-ui" %>

<portlet:defineObjects />

<portlet:actionURL var="actionUrl" ></portlet:actionURL>

<liferay-ui:success key="success-key" message="Successfully" />

<liferay-ui:error key="error-key" message="error"/>

<form action="<%=actionUrl %>" method="post">

Name:<input type="text" name="name" ><br>

Password:<input type="password" name="pass"><br>

</form>

Explanation of view.jsp

Here we use

<liferay-ui:success key="success-key" message="Successfully" />

<liferay-ui:error key="error-key" message="Error"/>

the success-key and error-key both are set in Java Class

the message Successfully is shown if success-key is found(in green color) and

the message Error is shown if error-key is found(in red color)

Step 4:- Add the following code in your Class

@Override

public void processAction(ActionRequest request, ActionResponse response) throws PortletException, IOException {

String name = ParamUtil.getString(request, "name");

String password = ParamUtil.getString(request, "pass");

if(name.equalsIgnoreCase("hello")&& password.equalsIgnoreCase("hello"))

{

SessionMessages.add(request,"success-key");

}

else{

SessionErrors.add(request, "error-key");

}

Explanation of Class

1) SessionMessages.add(request,"success-key");

This "success-key " is added if user enter hello as name and hello as Password and this must match in view.jsp

<liferay-ui:success key="success-key" message="Successfully" />

2) SessionErrors.add(request, "error-key");

This "error-key" is added if user not added hello as name and hello as password this key must match in view.jsp as

<liferay-ui:error key="error-key" message="Error"/>

Step 5:- Deploy Your Portlet on server

Right click on build.xml --> Run on Ant build

Step 6:- Open Browser and hit http://localhost:8080/

Add your portlet on page and put hello hello

If provide any other value

Step 6:- Disable Liferay Default error message(Your Request Failed to complete)

Add these two lines in your Class

PortletConfig portletConfig = (PortletConfig)request.getAttribute(JavaConstants.JAVAX_PORTLET_CONFIG);

SessionMessages.add(request, ((LiferayPortletConfig)portletConfig).getPortletId() + SessionMessages.KEY_SUFFIX_HIDE_DEFAULT_ERROR_MESSAGE);

and again deploy

As you see only our message is shown

If you want that your Message is not hard Coded and come from properties file

Step:-7 Provide entries of Language.properties in portlet.xml

Their is a Language.properties file is created in content folder (Due to Step 2) provide the entry of this in portlet.xml(actually this is already done by eclipse)

<resource-bundle>content.Language</resource-bundle>

Step:-8 Provide entries in Language.properties

Put entries in Language.properties file

Successfully=This Success Message come from Language.properties file

Error=This Error Message come from Language.properties file

These "Succeessfully" and "Error" must match with message of view.jsp as

<liferay-ui:success key="success-key" message="Successfully" />

<liferay-ui:error key="error-key" message="Error"/>

Step:-9 Deploy Your Portlet

So first Liferay try to find the message in Language.properties if following key is not found then show the normal message described in view.jsp ie if you delete

Successfully=This Success Message come from Language.properties file

from properties file then error message come from Language.properties file but success message is from jsp file

Success message from jsp

Error message from Language.properties file

Add Portlet(Out of Box) to Control Panel

noreply@blogger.com (Seema Pavar) — Sun, 17 Sep 2017 18:51:00 +0000

Today we learn how to move a Out of box portlet from Application menu to Control panel.

Ex- Loan Calculator from Finance category to Control Panel User Section.

This can be done by 2 ways:-

A) Direct change in liferay-display.xml and liferay-portlet.xml in server.
B) By writing EXT

First we discuss

A)Direct change in liferay-display.xml and liferay-portlet.xml in server.

Step1 :- Enter Portlet in control panel

Go to tomcat-7.0.42\webapps\ROOT\WEB-INF and open liferay-portlet.xml and search for loan
and then put the entries of <control-panel-entry-category> and <control-panel-entry-weight>.
Ex-

<portlet>
<portlet-name>61</portlet-name>
<icon>/html/icons/loan_calculator.png</icon>
<struts-path>loan_calculator</struts-path>
<control-panel-entry-category>users</control-panel-entry-category>
<control-panel-entry-weight>1.0</control-panel-entry-weight>
<remoteable>true</remoteable>
<private-request-attributes>false</private-request-attributes>
<private-session-attributes>false</private-session-attributes>
<render-weight>50</render-weight>
<css-class-wrapper>portlet-loan-calculator</css-class-wrapper>
</portlet>

Step2 :- Remove from Application

Go to tomcat-7.0.42\webapps\ROOT\WEB-INF and open liferay-display.xml and search for Finance category and remove portlet id 61 from finance category to hidden category.

Ex-

<category name="category.finance">
<portlet id="16" />
// remove from here
</category>
<category name="category.hidden">
<portlet id="61" /> // enter here
<portlet id="9" />
<portlet id="15" />
.
.
.
</category>

And Restart Server.Thats it see the output:-

As you see their is no Loan Calculator in Finance category.

And Loan Calculator is availabel in Control Panel Users

Now we Discuss the second Approach

B) By writing EXT

Step1:- Create a Ext project in eclipse

Step2 :- Enter Portlet in control panel

Open liferay-portlet-ext.xml and provide entry for control panel. Ex-

<liferay-portlet-app>

<portlet-name>61</portlet-name>

<icon>/html/icons/loan_calculator.png</icon>

<struts-path>loan_calculator</struts-path>

<control-panel-entry-category>users</control-panel-entry-category>

<control-panel-entry-weight>1.0</control-panel-entry-weight>

<private-request-attributes>false</private-request-attributes>

<private-session-attributes>false</private-session-attributes>

<render-weight>50</render-weight>

<css-class-wrapper>portlet-loan-calculator</css-class-wrapper>

</portlet>

</liferay-portlet-app>

Note:-These entries can be copied from liferay-portlet.xml of server.

At this point if we deploy our Ext portlet is available in Control panel but also in application.

Step3 :- Remove from Application

For removing we have to use liferay-display.xml but their is no such file in Ext so just copy from server and paste in Web-INF

and then remove portlet id 61 from finance category to hidden category as:-

<category name="category.finance">
<portlet id="16" />
// remove from here
</category>
<category name="category.hidden">
<portlet id="61" /> // enter here
<portlet id="9" />
<portlet id="15" />
.
.
.
</category>

Step4 :- Deploy the Ext

Then stop server Right Click on build.xml--->Liferay-->SDK--->direct-deploy

and restart server and check the output.

Jasper Report with Eclipse

noreply@blogger.com (Seema Pavar) — Sun, 17 Sep 2017 18:22:00 +0000

Here we learn Step by Step to create jasper Report with eclipse, iReport with the help of java bean

Step 1: First Download iReport-5.5.0-windows-installer and jasperreports-5.5.0 remember both version must be same like in this case both are 5.5.0

Step 2: Extract the jar file after extracting you find

step 3: Open eclipse create java project then create folder with name library and copy all the files

from lib and dist folder and add to the build path.

step 4: Create java bean with setter and getters if there is a field which is a object then create seperate class for the field . If a field is occur more than once then declare that field as a collection
like List.

Address.java

package bean;

public class Address {
private String city;
private String country;
public String getCity() {
return city;
}
public void setCity(String city) {
this.city = city;
}
public String getCountry() {
return country;
}
public void setCountry(String country) {
this.country = country;
}

}

Employee.java

package bean;

import java.util.List;

public class Employee {
private int id;
private String name;
private List<Address> address;

public List<Address> getAddress() {
return address;
}
public void setAddress(List<Address> address) {
this.address = address;
}

public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}

}

step : 5 Create a factory class which contain a static method whose return type is Collection that return objects of your bean class.

EmployeeImpl.java

import java.util.ArrayList;

import java.util.Collection;

import java.util.HashMap;

import java.util.List;

import bean.Address;

import bean.Employee;

public class EmployeeImpl {

public static Collection<Employee> getEmployee()

{

List<Employee>employees = new ArrayList<Employee>();

Employee e= new Employee();

e.setId(1);

e.setName("Aditya");

List<Address> addresses =new ArrayList<Address>();

Address a =new Address();

a.setCity("Ashok Nagar");

a.setCountry("India");

Address a1 =new Address();

a1.setCity("Ashok Nagar");

a1.setCountry("USA");

addresses.add(a);

addresses.add(a1);

e.setAddress(addresses);

employees.add(e);

return employees;

}

step : 5 Export this project as .jar

step :6 Now open ireport click on tools-->options---> classpath-->Add jar Attach your jar file tick and press ok.

step :7 Click on Report Datasources-->New-->java bean set Datasource-->Click next
then give complete name of your factory class and your static method

then click on test a dialog box is open with a successfully message click save.

Step: 8 Click file-->New-->Blank A4-->Open this tempelate-->Give Report Name to Employee

Click next--> Finish.

Step: 9 Click (near Preview)

Click java bean data source give name of your bean class click read attribute then select all except class click add selected field click preview data here you see all your value

Click ok

Step: 10 Then all the fields are come in field add id,name but not Address because it is a object for this we must create a subreport which is to be added in Employee.

Step 11: From Pallette add drag subreport in the details band a dialog box is open check create a new report-->next-->blank A4-->next--->

Data source is same as Employee because it contain the factory method.
Click next-->next-->Give sub report a name ex Employee_Address click finish

Step:12 Click on your Employee report then click on sub report so that on the right side properties of subreport is open change connection type to use a data source expression

Click on data source expression a dialog box is open that contain all the properties id,name,address use
new net.sf.jasperreports.engine.data.JRBeanCollectionDataSource($F{address})

Click Ok.

Step :13 Then repeat step 9 but this time give name of Address Bean and not preview data because if you preview data it gives a error

Step :14 Then attach your Country, City to your subreport compile it but preview your Employee report if you preview your sub report it gives an error

Thats it you can see your report but if you want to call it from your java code then some additional steps need to be done.

Step 15: Change Language of both your report from groovy to java Click on Employee and Employee_Address in Report Inspector then on right hand side their is a language drop down change groovy to java

Step 16: Add both Employee.jrxml and Employee_Address.jrxml to your eclipse project inside jrxml project .And create a Class with main()

public static void main(String[] args) {

HashMap<String, Object> hm = new HashMap<String, Object>();
JRDataSource ds = new JRBeanCollectionDataSource(EmployeeImpl.getEmployee());
JasperReport jasperReport;
JasperPrint jasperPrint;
try {
jasperReport = JasperCompileManager.compileReport("jrxml/Employee.jrxml");
jasperPrint = JasperFillManager.fillReport(jasperReport, hm, ds);
JasperExportManager.exportReportToPdfFile(jasperPrint, "simple_report.pdf");
} catch (JRException e) {
e.printStackTrace();
}

}

Run the class refresh your project and yipeeeee their is a pdf with name simple_report.pdf

Project Structure

	create table Department (
	deptid LONG not null primary key,
	department VARCHAR(75) null
	);

	create table Employee (
	eid LONG not null primary key,
	name VARCHAR(75) null,
	address VARCHAR(75) null
	);

	create table Employee_department (
	deptid LONG not null,
	eid LONG not null,
	primary key (deptid, eid)
	);

	public void doView(RenderRequest renderRequest, RenderResponse renderResponse) throws IOException, PortletException {
	try {
	Employee employee;
	employee = EmployeeLocalServiceUtil.createEmployee(CounterLocalServiceUtil.increment());
	employee.setAddress("Delhi");
	employee.setName("Ramesh");
	employee = EmployeeLocalServiceUtil.addEmployee(employee);


	Department department1,department2;
	department1 = DepartmentLocalServiceUtil.createDepartment(CounterLocalServiceUtil.increment());
	department1.setDepartment("IT");
	department1 =DepartmentLocalServiceUtil.addDepartment(department1);

	department2 = DepartmentLocalServiceUtil.createDepartment(CounterLocalServiceUtil.increment());
	department2.setDepartment("Research");
	department2 =DepartmentLocalServiceUtil.addDepartment(department2);
	DepartmentLocalServiceUtil.addEmployeeDepartments(employee.getEid(), new long[]{department1.getDeptid(),department2.getDeptid()});
	}
	catch (SystemException e) {
	e.printStackTrace();
	}
	}

	<?xml version="1.0" encoding="UTF-8"?>
	<custom-sql >
	<sql file="custom-sql/student-custom-sql.xml"/>
	</custom-sql >

	<?xml version="1.0" encoding="UTF-8"?>
	<custom-sql>
	<sql id="studentBetweenQuery" >
	<![CDATA[
	SELECT * from pm_student st WHERE st.sid BETWEEN ? AND ?
	]]>
	</sql>
	</custom-sql>

	package com.aditya.service.persistence;

	import com.aditya.model.Student;
	import com.liferay.portal.service.persistence.impl.BasePersistenceImpl;

	public class StudentFinderImpl extends BasePersistenceImpl<Student> implements StudentFinder{

	}


	package com.aditya.service.persistence;

	public interface StudentFinder {
	}


	package com.aditya.service.persistence;

	import com.liferay.portal.kernel.bean.PortletBeanLocatorUtil;
	import com.liferay.portal.kernel.util.ReferenceRegistry;

	/**
	* @author Aditya
	*/
	public class StudentFinderUtil {
	public static StudentFinder getFinder() {
	if (_finder == null) {
	_finder = (StudentFinder)PortletBeanLocatorUtil.locate(com.aditya.service.ClpSerializer.getServletContextName(),
	StudentFinder.class.getName());

	ReferenceRegistry.registerReference(StudentFinderUtil.class,
	"_finder");
	}

	return _finder;
	}

	public void setFinder(StudentFinder finder) {
	_finder = finder;

	ReferenceRegistry.registerReference(StudentFinderUtil.class, "_finder");
	}

	private static StudentFinder _finder;
	}

	package com.aditya.service.persistence;

	import java.util.List;

	import com.aditya.model.Student;
	import com.aditya.model.impl.StudentImpl;
	import com.liferay.portal.kernel.dao.orm.QueryPos;
	import com.liferay.portal.kernel.dao.orm.QueryUtil;
	import com.liferay.portal.kernel.dao.orm.SQLQuery;
	import com.liferay.portal.kernel.dao.orm.Session;
	import com.liferay.portal.service.persistence.impl.BasePersistenceImpl;
	import com.liferay.util.dao.orm.CustomSQLUtil;

	public class StudentFinderImpl extends BasePersistenceImpl<Student> implements StudentFinder {
	public List<Student> getStudentBetweenStudentId(int start, int end) {
	Session session = null;
	try {
	session = openSession();
	String sql = CustomSQLUtil.get("studentBetweenQuery");
	SQLQuery queryObject = session.createSQLQuery(sql);
	queryObject.setCacheable(false);
	queryObject.addEntity("Student", StudentImpl.class);
	QueryPos qPos = QueryPos.getInstance(queryObject);
	qPos.add(start);
	qPos.add(end);
	return (List<Student>) queryObject.list();

	//return (List<Student>) QueryUtil.list(queryObject,getDialect(),start, end);// for pagination feature
	} catch (Exception e) {
	e.printStackTrace();
	} finally {
	closeSession(session);
	}
	return null;
	}

	}

	public class StudentLocalServiceImpl extends StudentLocalServiceBaseImpl {

	public List<Student> getStudentBetweenStudentId(int start, int end) {
	return StudentFinderUtil.getStudentBetweenStudentId(start, end);
	}
	}

	public interface StudentFinder {
	public java.util.List<com.aditya.model.Student> getStudentBetweenStudentId(
	int start, int end);
	}

	public class StudentFinderUtil {
	public static java.util.List<com.aditya.model.Student> getStudentBetweenStudentId(
	int start, int end) {
	return getFinder().getStudentBetweenStudentId(start, end);
	}

	public static StudentFinder getFinder() {
	if (_finder == null) {
	_finder = (StudentFinder)PortletBeanLocatorUtil.locate(com.aditya.service.ClpSerializer.getServletContextName(),
	StudentFinder.class.getName());

	ReferenceRegistry.registerReference(StudentFinderUtil.class,
	"_finder");
	}

	return _finder;
	}

	public void setFinder(StudentFinder finder) {
	_finder = finder;

	ReferenceRegistry.registerReference(StudentFinderUtil.class, "_finder");
	}

	private static StudentFinder _finder;
	}

	public void doView(RenderRequest renderRequest, RenderResponse renderResponse) throws IOException, PortletException {
	try {
	System.out.println("Student==>"+StudentLocalServiceUtil.getStudentBetweenStudentId(101, 104).size());
	}
	catch (SystemException e) {
	e.printStackTrace();
	}
	super.doView(renderRequest, renderResponse);
	}

	@ProcessAction(name="addPageAction")
	public void addPageAction(ActionRequest request, ActionResponse response)throws PortletException{
	ThemeDisplay themeDisplay = (ThemeDisplay)request.getAttribute(WebKeys.THEME_DISPLAY)
	long userId = themeDisplay.getUserId();
	long groupId = themeDisplay.getScopeGroupId();
	boolean privateLayout = false;// private page or public page
	long parentLayoutId = 0;
	String name = "Dynamic";
	String title = "Inside SEO HTML Title";
	String description = "Inside SEO Description";
	String type = LayoutConstants.TYPE_PORTLET;
	boolean hidden = false;
	String friendlyURL = "/dynamic";
	ServiceContext serviceContext = new ServiceContext();
	try
	{
	LayoutLocalServiceUtil.addLayout(userId, groupId, privateLayout, parentLayoutId,name,title,description, type, hidde,friendRL,serviceContext);
	}
	catch (PortalException e)
	{
	e.printStackTrace();
	}
	}

	@ProcessAction(name="updatePageLayout")
	public void updatePageLayout(ActionRequest request, ActionResponse response)throws PortletException{
	ThemeDisplay themeDisplay = (ThemeDisplay)request.getAttribute(WebKeys.THEME_DISPLAY);
	long groupId = themeDisplay.getScopeGroupId();
	String friendlyURL = "/dynamic";
	boolean privateLayout = false;
	long userId = themeDisplay.getUserId();
	try {
	Layout layout =LayoutLocalServiceUtil.getFriendlyURLLayout(groupId, privateLayout, friendlyURL);
	LayoutTypePortlet layoutTypePortlet = (LayoutTypePortlet) layout.getLayoutType();
	layoutTypePortlet.setLayoutTemplateId(userId, "3_columns");
	LayoutLocalServiceUtil.updateLayout(layout.getGroupId(), layout.getPrivateLayout(),layout.getLayoutId(), layout.getTypeSettings());
	} catch (Exception e) {
	e.printStackTrace();
	}
	}


	@ProcessAction(name="addPortlet")
	public void addPortlet(ActionRequest request, ActionResponse response)throws PortletException{
	ThemeDisplay themeDisplay = (ThemeDisplay)request.getAttribute(WebKeys.THEME_DISPLAY);
	long groupId = themeDisplay.getScopeGroupId();
	String friendlyURL = "/dynamic";
	boolean privateLayout = false;
	long userId = themeDisplay.getUserId();
	try {
	Layout layout =LayoutLocalServiceUtil.getFriendlyURLLayout(groupId, privateLayout, friendlyURL);
	LayoutTypePortlet layoutTypePortlet = (LayoutTypePortlet) layout.getLayoutType();
	layoutTypePortlet.addPortletId(userId, "61", "column-1", -1);
	LayoutLocalServiceUtil.updateLayout(layout.getGroupId(), layout.getPrivateLayout() ,layout.getLayoutId() , layout.getTypeSettings());
	}
	catch (Exception e)
	{
	e.printStackTrace();
	}
	}

	public java.util.List<com.aditya.model.Student> findByMobile(long mobileno)
	throws com.liferay.portal.kernel.exception.SystemException;

	public java.util.List<com.aditya.model.Student> findByMobile(
	long mobileno, int start, int end)
	throws com.liferay.portal.kernel.exception.SystemException;

	public java.util.List<com.aditya.model.Student> findByMobile(
	long mobileno, int start, int end,
	com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
	throws com.liferay.portal.kernel.exception.SystemException;

	public com.aditya.model.Student findByMobile_First(long mobileno,
	com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
	throws com.aditya.NoSuchStudentException,
	com.liferay.portal.kernel.exception.SystemException;

	public List<Student> findByMobile(int mobileno) throws SystemException
	{
	return this.studentPersistence.findByMobile(mobileno);
	}

	package com.search;

	import java.io.IOException;
	import javax.portlet.ActionRequest;
	import javax.portlet.ActionResponse;
	import javax.portlet.PortletException;
	import com.liferay.portal.kernel.exception.PortalException;
	import com.liferay.portal.kernel.exception.SystemException;
	import com.liferay.portal.kernel.util.ParamUtil;
	import com.liferay.util.bridges.mvc.MVCPortlet;
	import com.student.services.service.StudentLocalServiceUtil;

	public class SearchContainer extends MVCPortlet {

	public void deleteStudent(ActionRequest actionRequest,ActionResponse actionResponse) throws IOException, PortletException {
	String backURL = ParamUtil.getString(actionRequest, "backURL");
	int studentId = ParamUtil.getInteger(actionRequest, "studentId");
	try {
	StudentLocalServiceUtil.deleteStudent(studentId);
	System.out.println("Successfully Deleted Student of Id =>"+studentId);
	actionResponse.sendRedirect(backURL);
	} catch (PortalException \| SystemException e) {
	e.printStackTrace();
	}

	}
	}

	package com.ipg;
	import com.liferay.portal.kernel.exception.SystemException;
	import com.liferay.portal.service.UserLocalServiceWrapper;
	import com.liferay.portal.service.UserLocalService;

	public class MyUserLocalService extends UserLocalServiceWrapper {
	public MyUserLocalService(UserLocalService userLocalService) {
	super(userLocalService);
	}

	@Override
	public int getUsersCount() throws SystemException {
	System.out.println("This text is from getUsersCount ");
	return super.getUsersCount();
	}

	}

	public void doView(RenderRequest renderRequest,
	RenderResponse renderResponse) throws IOException, PortletException {
	try {
	UserLocalServiceUtil.getUsersCount();

	} catch (SystemException e) {
	e.printStackTrace();
	}
	super.doView(renderRequest, renderResponse);
	}