Apache POI library can be used to create Excel Sheet, Word Document and PowerPoint. In this post, we will be totally focusing on Excel Sheet using “XSSF (XML Spreadsheet Format)” component.

Prerequisite :
Add all jar files downloaded from Apache POI download site in Java Program’s build path.

Demo Code :

package in.shivasoft;

import java.awt.Desktop;
import java.io.File;
import java.io.FileOutputStream;

import org.apache.poi.hssf.util.CellRangeAddress;
import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.CellStyle;
import org.apache.poi.ss.usermodel.IndexedColors;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.util.CellReference;
import org.apache.poi.xssf.streaming.SXSSFWorkbook;

/**
* @author Jitendra Zaa
*
*/
public class CreateExcelSheet {

	static SXSSFWorkbook  wb ;
	static Sheet sh ;

	/**
	 * This method demonstrates how to Auto resize Excel column
	 */
	private static void autoResizeColumns()
	{
		for(int colIndex = 0; colIndex < 10 ; colIndex++)
		{
			sh.autoSizeColumn(colIndex);
		}
	}

	/**
	 * This method will return Style of Header Cell
	 * @return
	 */
	private static CellStyle getHeaderStyle()
	{
		CellStyle style = wb.createCellStyle();
	    style.setFillForegroundColor(IndexedColors.ORANGE.getIndex());
	    style.setFillPattern(CellStyle.SOLID_FOREGROUND);

	    style.setBorderBottom(CellStyle.BORDER_THIN);
	    style.setBottomBorderColor(IndexedColors.BLACK.getIndex());
	    style.setBorderLeft(CellStyle.BORDER_THIN);
	    style.setLeftBorderColor(IndexedColors.BLACK.getIndex());
	    style.setBorderRight(CellStyle.BORDER_THIN);
	    style.setRightBorderColor(IndexedColors.BLACK.getIndex());
	    style.setBorderTop(CellStyle.BORDER_THIN);
	    style.setTopBorderColor(IndexedColors.BLACK.getIndex());
	    style.setAlignment(CellStyle.ALIGN_CENTER);

	    return style;
	}

	/**
	 * This method will return style for Normal Cell
	 * @return
	 */
	private static CellStyle getNormalStyle()
	{
		CellStyle style = wb.createCellStyle();

	    style.setBorderBottom(CellStyle.BORDER_THIN);
	    style.setBottomBorderColor(IndexedColors.BLACK.getIndex());
	    style.setBorderLeft(CellStyle.BORDER_THIN);
	    style.setLeftBorderColor(IndexedColors.BLACK.getIndex());
	    style.setBorderRight(CellStyle.BORDER_THIN);
	    style.setRightBorderColor(IndexedColors.BLACK.getIndex());
	    style.setBorderTop(CellStyle.BORDER_THIN);
	    style.setTopBorderColor(IndexedColors.BLACK.getIndex());
	    style.setAlignment(CellStyle.ALIGN_CENTER);

	    return style;
	}

	/**
	 * @param args
	 */
	public static void main(String[] args) throws Exception {

		 wb =  new SXSSFWorkbook(100); // keep 100 rows in memory, exceeding rows will be flushed to disk
		sh = wb.createSheet("Sample sheet");

	    CellStyle headerStle= getHeaderStyle();
	    CellStyle normalStyle = getNormalStyle();

		 for(int rownum = 0; rownum < 1000; rownum++){
	            Row row = sh.createRow(rownum);
	            for(int cellnum = 0; cellnum < 10; cellnum++){

	                Cell cell = row.createCell(cellnum);
	                String address = new CellReference(cell).formatAsString();
	                cell.setCellValue(address);

	                if(rownum == 0)
	                {

	                	cell.setCellStyle(headerStle);
	                }
	                else
	                {
	                	cell.setCellStyle(normalStyle);
	                }
	            }

	        }

		 //Below code Shows how to merge Cell
		 sh.addMergedRegion(new CellRangeAddress(
		            0, //first row (0-based)
		            0, //last row  (0-based)
		            0, //first column (0-based)
		            5  //last column  (0-based)
		    ));

		 autoResizeColumns();

		 /**
		  * To Auto-resize Row, We have to follow two steps
		  * 1. Set WordWrap property in CellStyle to true
		  * 2. Set setHeightInPoints of row likw this :
		  *  	row.setHeightInPoints((totalHtmlLineBreak * sh.getDefaultRowHeightInPoints()));
		  *  	Where totalHtmlLineBreak is total lines for auto height
		  */

	        File f = new File("c:/DeleteThis/2/Example2.xlsx");

	        if(!f.exists())
	        {
	        	//If directories are not available then create it
	        	File parent_directory = f.getParentFile();
	        	if (null != parent_directory)
	        	{
	        	    parent_directory.mkdirs();
	        	}

	        	f.createNewFile();
	        }

	        FileOutputStream out = new FileOutputStream(f,false);
	        wb.write(out);
	        out.close();

	        // dispose of temporary files backing this workbook on disk
	        wb.dispose();
	        System.out.println("File is created");
	        //Launch Excel File Created
	        Desktop.getDesktop().open(f);
	}
}

Code Written above is very simple and self Explanatory. This is the Output of above code,

I have collected few common Questions asked on Apache POI, lets discuss it.

1. How to Auto Re-size Column in Generated Excel Sheet?
Ans : We can use “autoSizeColumn(int ColumnNumber)” method of Sheet Object.

2. How to add Styles in Cell or Column in Excel Sheet ?
Ans : As shown in above code, We have Object named “CellStyle” used in method “getHaderStyle()”. We can set Background Color as well and all other stuff.

3. How to merge Columns in Excel ?
Ans : Using below code snippet

//Below code Shows how to merge Cell
		 sh.addMergedRegion(new CellRangeAddress(
		            0, //first row (0-based)
		            0, //last row  (0-based)
		            0, //first column (0-based)
		            5  //last column  (0-based)
		    ));

4. How to Auto – Re-size row in Generated Excel Sheet ?
Ans: To Auto-re-size row, we have to follow two steps:

• Set Word Wrap property to true in CellStyle
• Call method setHeightInPoints on row object

Sample Code :

            /**
		  * To Auto-resize Row, We have to follow to steps
		  * 1. Set WordWrap property in CellStyle to true
		  * 2. Set setHeightInPoints of row likw this :
		*/
		    	row.setHeightInPoints((totalHtmlLineBreak * sh.getDefaultRowHeightInPoints()));
		  /**
		    *  	Where totalHtmlLineBreak is total lines for auto height
		  */

I am waiting for your feedback and suggestions on this post. Happy Coding !!! 🙂

!Deprecated!

This tool / blog post is deprecated. Please follow this guide to deploying applications to Heroku from Eclipse. If you still want to follow this post, then download Eclipse plugin for Heroku from here.

Prerequisites:

• Heroku Account, you can sign up here – https://api.heroku.com/signup/devcenter
• Eclipse 3.7 or Higher
• E-Git Plugin , more information on set up of E-Git – https://jitendrazaa.com/blog/salesforce/salesforce-git-eclipse-egit-better-and-distributed-source-control/

Installation and Set up:
First we will need to Install Heroku Plugin in Eclipse. To install it, Navigate to “Help | Install New Software” and click on “Add” button.

Give any name in website like “Heroku Plugin” and enter this URL in Location https://eclipse-plugin.herokuapp.com/install and click on “Ok” and Finish Installation. It will install the Heroku Plugin required to start your first Plugin.

Next step is setting up your Credentials for Heroku :

Navigate to “Window | Preferences | Heroku”, Here either enter your UserName and Password of Heroku Account and click on “Login” or enter you API key, which you can find by logging into your Heroku Account.

Creating SSH Key :

Heroku uses Git to push and pull code from Heroku. For this you can use E-Git plugin of Eclipse. You can also visit this article for complete tutorial. So, for communication between Heroku and Git we need SSH. Navigate to “Windows | Preferences |General | Network Connections | SSH2 “. Navigate to “Key Management“ tab and click on “Generate RSA Key”. After Generation of key click on “Save Private Key”.

Now, after generation of RSA key Navigate to “Heroku” and click on “Load SSH Key” and select file which you have saved recently.

Now, till this we have done all the configurations. Start with creating our first “Hello World” program from Template using Jetty.
Navigate to “New | Project | Heroku | Create Heroku App from Template” and click on Next.

On Next screen select “Embedded Jetty-Servlet application” and click on Finish. After creation of sample project, open “Main.java” file and run it.

Now open browser with URL http://localhost:8080/ and you should able to see Jetty Page. If you are able to see the Jetty Startup page, means everything is good. Now navigate to http://localhost:8080/hello , you will see text “Hello Heroku” just like below screen.

You can make modifications in “HelloServlet.java” by replacing below line with some other Text.

<br />out.write("Hello Heroku".getBytes());<br />

Deploying Modifications to Heroku from Local System:

Now, as we are done with making modifications in local code, commit the changes in Git by “Right Click on Project | Team | Commit”. You need to Enter Commit Message like this:

After Committing the Changes, Navigate to “Right Click on Project | Team | Push to Upstream”.

Now, if everything is good, Heroku will receive all you local Changes and build application again on its server.

Now you can run this application by logging into Heroku and make modifications that’s suits you like Salesforce Integration or any other.

You can also visit this official Heroku tutorial, which explains in very detail about Heroku Deployment using Eclipse and other important Configurations.

If you are getting an error “eclipse SSH key is not matching the SSH key(s) that is associated with your Heroku account“, then follow this article to resolve this.

First we will need to setup the OAuth permission so that our local J2EE application can interact with Salesforce. For this login to Salesforce account and Navigate to “Set up | App Set up | Develop | Remote Access” and enter the information. Be careful about the “Callback URL”. It must match in your code. After creating the “Remote Access”, note “Consumer Key” and “Consumer Secret” which will be needed in your code.

Update : “Remote Access” is renamed to Connected App. So throughout this article, if you see image of “Remote Access” then please consider it as Connected App.

So, we will start with setting up the Log4j for our project. Copy below code in “log4j.properties” file. you will need Apache commons logging jar, which you can find in this article’s source code.

# A default log4j configuration for log4j users.
#
# To use this configuration, deploy it into your application's WEB-INF/classes
# directory.  You are also encouraged to edit it as you like.

# Configure the console as our one appender
log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%d{HH:mm:ss,SSS} %-5p [%c] - %m%n

# tighten logging on the DataNucleus Categories
log4j.category.DataNucleus.JDO=WARN, A1
log4j.category.DataNucleus.Persistence=WARN, A1
log4j.category.DataNucleus.Cache=WARN, A1
log4j.category.DataNucleus.MetaData=WARN, A1
log4j.category.DataNucleus.General=WARN, A1
log4j.category.DataNucleus.Utility=WARN, A1
log4j.category.DataNucleus.Transaction=WARN, A1
log4j.category.DataNucleus.Datastore=WARN, A1
log4j.category.DataNucleus.ClassLoading=WARN, A1
log4j.category.DataNucleus.Plugin=WARN, A1
log4j.category.DataNucleus.ValueGeneration=WARN, A1
log4j.category.DataNucleus.Enhancer=WARN, A1
log4j.category.DataNucleus.SchemaTool=WARN, A1

Now, create a Servlet with name “StartServet” and following code:

package com.sfdc.pdfmerge.sample;

import java.io.IOException;
import java.io.InputStreamReader;
import java.net.URLEncoder;
import java.util.ArrayList;
import java.util.List;
import java.util.logging.Logger;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.NameValuePair;
import org.apache.http.client.entity.UrlEncodedFormEntity;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.message.BasicNameValuePair;
import org.json.JSONObject;
import org.json.JSONTokener;

/**
* Servlet implementation class TestOAuth
*/
public class StartServet extends HttpServlet {
	private static final long serialVersionUID = 1L;
	/**
	 * @see HttpServlet#HttpServlet()
	 */
	public StartServet() {
		super();
		// TODO Auto-generated constructor stub
	}

	public static final String ACCESS_TOKEN = "ACCESS_TOKEN";
	public static final String INSTANCE_URL = "INSTANCE_URL";
	String oauthURL = "";

	private static final Logger log = Logger.getLogger(StartServet.class.getName());

	protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
		String sfdcInstance = "https://ap1.salesforce.com";

		String accessToken = (String) request.getSession().getAttribute(ACCESS_TOKEN);
		String code = request.getParameter("code");

		String consumerKey = "3MVG9Y6d_Btp4xp7hZ1hn287sIMQ56.b_dOEBDrKHRbtwByFvFJz0A4ETmj_TbTuu4CsCkknL3ZgoWIzUTBnh";
		String consumerSecret = "4972968186270851852";
		String redirectUri = "https://localhost:8443/PDFMerge_J2EE/TestOAuth?isCallBack=1";

		oauthURL = sfdcInstance + "/services/oauth2/authorize?response_type=code&client_id=" + consumerKey + "&redirect_uri="
				+ URLEncoder.encode(redirectUri, "UTF-8");

		if (accessToken == null) {

			try {
				String isCallBack = request.getParameter("isCallBack");
					log.info("Starting OAuth");
					log.info("Is CallBack = "+isCallBack);

					/**
					 * Initiate HTTP request to get the Authorization code
					 */
					DefaultHttpClient httpclient = new DefaultHttpClient();
					HttpPost httpPost = new HttpPost(oauthURL);
					HttpResponse response1 = httpclient.execute(httpPost);

					/**
					 * If HTTP status code is 302, means Salesforce trying to redirect to authorize the Local System
					 */
					if(response1.getStatusLine().getStatusCode() == 302 && isCallBack == null)
					{
						httpclient.getConnectionManager().shutdown();
						log.info("Got 302 request from Salesforce so redirect it");
						response.sendRedirect(oauthURL);
						return;
					}
					else
					{
						log.info("Got Callback, Now get the Access Token");

						httpclient = new DefaultHttpClient();
						String tokenUrl = sfdcInstance + "/services/oauth2/token";

						log.info("Code - "+code);

						List qparams = new ArrayList();
						qparams.add(new BasicNameValuePair("code", code));
						qparams.add(new BasicNameValuePair("grant_type", "authorization_code"));
						qparams.add(new BasicNameValuePair("client_id", consumerKey));
						qparams.add(new BasicNameValuePair("client_secret", consumerSecret));
						qparams.add(new BasicNameValuePair("redirect_uri", redirectUri));

						HttpPost httpPost2 = new HttpPost(tokenUrl);
						httpPost2.setEntity(new UrlEncodedFormEntity(qparams));

						/**
						 * Always set this Header to explicitly to get Authrization code else following error will be raised
						 * unsupported_grant_type
						 */
						httpPost2.setHeader("Content-Type", "application/x-www-form-urlencoded");

						HttpResponse response2 = httpclient.execute(httpPost2);

						HttpEntity entity2 = response2.getEntity();
						System.out.println(entity2.getContent().toString());

						JSONObject authResponse = new JSONObject(new JSONTokener(new InputStreamReader(entity2.getContent())));
						System.out.println(authResponse.toString());
						accessToken = authResponse.getString("access_token");
						String instanceUrl = authResponse.getString("instance_url");

						request.getSession().setAttribute(ACCESS_TOKEN, accessToken);

						// We also get the instance URL from the OAuth response, so set it
						// in the session too
						request.getSession().setAttribute(INSTANCE_URL, instanceUrl);

						log.info("Response is : "+authResponse);
						log.info("Got access token: " + accessToken);

						/**
						In Below line of code, provide the attachment Ids to merge
						*/
						String pdfUrl = "/PDFMerge_J2EE/pdfmerge?ids=00P900000038KTm&parentId=00690000007GLNj&mergedDocName=MergedDoc.pdf";
						response.sendRedirect(pdfUrl);
				}
			} catch (Exception e) {
					e.printStackTrace();
			} finally {
			}
		}
	}
	/**
	 * @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse
	 *      response)
	 */
	protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
		// TODO Auto-generated method stub
	}
}

Above servlet is starting/landing servlet and authenticate your application with Salesforce using Consumer Key and Consumer Secret. After Authentication using OAuth it will call another servlet to merge PDF and save back in Salesforce.

Now, create a new Servlet which will actually read the attachment Ids from parameter and merge PDF using “iTextPDF” jar and save back again in Salesforce.

package com.sfdc.pdfmerge.sample;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;
import java.util.logging.Logger;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@SuppressWarnings("serial")
public class PDFMergeServlet extends HttpServlet {
	private String accessToken;
	private String instanceURL;

	private static final Logger log = Logger.getLogger(PDFMergeServlet.class.getName());

	public void doGet(HttpServletRequest req, HttpServletResponse resp)
			throws IOException {
	    log.severe("PDF Merge Servlet Called");
		String sfdcInstance = req.getParameter("instanceURL");

		accessToken = (String)req.getSession().getAttribute(StartServet.ACCESS_TOKEN);
		instanceURL = (String)req.getSession().getAttribute(StartServet.INSTANCE_URL);

		if (accessToken == null)
			return;

		String ids = req.getParameter("ids");
		String parentId = req.getParameter("parentId");
		String mergedDocName = req.getParameter("mergedDocName");

		List pdfs = new ArrayList();
		ByteArrayOutputStream o = null;
		if (accessToken != null && ids != null && parentId != null)
		{
			Salesforce sfdc = new Salesforce(instanceURL, accessToken);
			for (String id : ids.split(","))
			{
				pdfs.add(sfdc.getAttachment(id));
			}

			o = new ByteArrayOutputStream();
			MergePDF.concatPDFs(pdfs, o, false);

			sfdc.saveAttachment(parentId, mergedDocName, o, "application/pdf");
		}

		try
		{
			if (o != null)
			{
				o.flush();
				o.close();
			}

			for (InputStream pdf : pdfs)
			{
				pdf.close();
			}
		}
		catch (Exception e){e.printStackTrace();}

		resp.setContentType("text/plain");
		resp.getWriter().println("Documents merged successfully");
	}

}

Create a utility Java Class “MergePDF” which is used in above servlet:

package com.sfdc.pdfmerge.sample;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import com.itextpdf.text.Document;
import com.itextpdf.text.pdf.BaseFont;
import com.itextpdf.text.pdf.PdfContentByte;
import com.itextpdf.text.pdf.PdfImportedPage;
import com.itextpdf.text.pdf.PdfReader;
import com.itextpdf.text.pdf.PdfWriter;

public class MergePDF {

    public static void concatPDFs(List<InputStream> streamOfPDFFiles,
            OutputStream outputStream, boolean paginate) {

        Document document = new Document();
        try {
            List<InputStream> pdfs = streamOfPDFFiles;
            List<PdfReader> readers = new ArrayList<PdfReader>();
            int totalPages = 0;
            Iterator<InputStream> iteratorPDFs = pdfs.iterator();

            // Create Readers for the pdfs.
            while (iteratorPDFs.hasNext()) {
                InputStream pdf = iteratorPDFs.next();
                PdfReader pdfReader = new PdfReader(pdf);
                readers.add(pdfReader);
                totalPages += pdfReader.getNumberOfPages();
            }
            // Create a writer for the outputstream
            PdfWriter writer = PdfWriter.getInstance(document, outputStream);

            document.open();
            BaseFont bf = BaseFont.createFont(BaseFont.HELVETICA,
                    BaseFont.CP1252, BaseFont.NOT_EMBEDDED);
            PdfContentByte cb = writer.getDirectContent(); // Holds the PDF
            // data

            PdfImportedPage page;
            int currentPageNumber = 0;
            int pageOfCurrentReaderPDF = 0;
            Iterator<PdfReader> iteratorPDFReader = readers.iterator();

            // Loop through the PDF files and add to the output.
            while (iteratorPDFReader.hasNext()) {
                PdfReader pdfReader = iteratorPDFReader.next();

                // Create a new page in the target for each source page.
                while (pageOfCurrentReaderPDF < pdfReader.getNumberOfPages()) {
                    document.newPage();
                    pageOfCurrentReaderPDF++;
                    currentPageNumber++;
                    page = writer.getImportedPage(pdfReader,
                            pageOfCurrentReaderPDF);
                    cb.addTemplate(page, 0, 0);

                    // Code for pagination.
                    if (paginate) {
                        cb.beginText();
                        cb.setFontAndSize(bf, 9);
                        cb.showTextAligned(PdfContentByte.ALIGN_CENTER, ""
                                + currentPageNumber + " of " + totalPages, 520,
                                5, 0);
                        cb.endText();
                    }
                }
                pageOfCurrentReaderPDF = 0;
            }
            outputStream.flush();
            document.close();
            outputStream.close();
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            if (document.isOpen())
                document.close();
            try {
                if (outputStream != null)
                    outputStream.close();
            } catch (IOException ioe) {
                ioe.printStackTrace();
            }
        }
    }
}

you will also need to map the Servlet URL in “web.xml” file, which you can find in source code attached.
To run above application, enter this URL in address bar “https://localhost:8443/PDFMerge_J2EE/“.

After running above code, first time it will ask you to enter the username and password of salesforce account to allow access to your local application and then it will get all the attachments specified in code and after merging it will again attach it to parent id passed in parameter.

jar files needed to run above code:

• commons-codec-1.1.jar
• commons-codec-1.6.jar
• commons-lang3-3.1.jar
• commons-lang3-3.1-javadoc.jar
• commons-lang3-3.1-sources.jar
• commons-lang3-3.1-tests.jar
• commons-logging-1.1.1.jar
• fluent-hc-4.2.1.jar
• httpclient-4.2.1.jar
• httpclient-cache-4.2.1.jar
• httpcore-4.2.1.jar
• httpmime-4.2.1.jar
• itextpdf-5.1.0.jar

Also, please note that Salesforce OAuth can be run only on “https” protocol. Below articles are also recommended to read :

Simple guide to setup SSL in Tomcat
Digging Deeper into OAuth 2.0 on Force.com

Download Complete Source code for – Merging PDF Using ITextPDF and OAuth2 on Salesforce using Servlet

Step 1:

Run tool “Keytool“ provided by the JRE to create a “keystore file”.
The command to run tool is:

keytool -genkey -alias tomcat -keyalg RSA -keystore D:/.keyStore

Where “D:/.keystore” is the path where file should be created.
Instead of alias “tomcat” any other name can be used.
After running above command, you will be asked many questions, so answer them correctly as shown in below image:

Remember the password provided, as it will be needed in next step.

Step 2:

Now, in next step go to “conf” folder of tomcat, and open file “server.xml”.
There you will find lines of code something like:

<-- Define a SSL Coyote HTTP/1.1 Connector on port 8443 -->
<!--
<Connector
           port="8443" minProcessors="5" maxProcessors="75"
           enableLookups="true" disableUploadTimeout="true"
           acceptCount="100" debug="0" scheme="https" secure="true";
           clientAuth="false" sslProtocol="TLS"/>
-->

So, to enable the SSL, uncomment above code and tweek like below:

<Connector
	protocol="org.apache.coyote.http11.Http11Protocol"
	port="8443" maxHttpHeaderSize="8192"
    maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
    enableLookups="true" disableUploadTimeout="true"
    acceptCount="100" scheme="https" secure="true"
    clientAuth="false" sslProtocol="TLS"
	keystoreFile="F:eclipseFrameworksapache-tomcat-5.5.31 - SSL Configured.keyStore"
	keystorePass="YOURpwd"/>

As you can see, I have added few more attributes like:

Protocol : If the APR (Apache Portable Runtime) is enabled in tomcat (maximum time it is enabled by default), then this approach will not work. so configure tomcat that we want to use Java (JSSE) connector, regardless of whether the APR library is loaded or not.
keystoreFile : Full path of the keystore file creates in step 1.
keystorePass: Password used while creating file in step1.

After these changes, save Server.xml and navigate to: https://localhost:8443/ , As you can see in below image, SSL is enabled.

Now, as you can see, although we have created SSL certificate for local server, browser is showing that it is not secured.

SSL verifies the authenticity of a site’s certificate by using something called a “chain of trust,” which basically means that during the handshake, SSL initiates an additional handshake with the Certificate Authority (CA) specified in your site’s certificate, to verify that you haven’t simply made up your own CA (Which actually we have done in our case ).

If you want to remove error, you have to get certificate from some Certificate Authority so that during handshake, accuracy of your certificate can be validated.
If you have valid certificates then please read this article.

1. Change sets (From Salesforce site)
2. Eclipse (Using “Deploy to force.com server” option in Eclipse)
3. ANT (Java based tool)

We are going to discuss the ANT based migration, step by step:

Prerequisite:
JDK 1.5 or above

Step 1:
Download ANT distribution from – “http://ant.apache.org/bindownload.cgi”

Step 2:
Set Environment variable “ANT_HOME“. The path should be of parent folder of “bin”. Also add the “bin” folder to your path.

Step 3:
Check whether ANT is installed or not properly by running command “ant -version“. It might be possible that you receive message something like unable to find tools.jar. You can copy this jar from “JDK_HOME/lib/tools.jar” to “JRE/lib” folder.

In above screen you can see that before copying tools.jar I was getting warning.

Step 4:

Login to salesforce and navigate to “Your Name |Setup | Develop | Tools” and download “Force.com Migration tool”.

Unzip the downloaded file to the directory of your choice. Copy the “ant-salesforce.jar” file from the unzipped file into the ant lib directory.

To start with deployment using ANT, we will need “build.xml” and “build.properties” file. As there is no need of “build.properties” however its good to have it so that the configuration related settings are in different file. You can copy both files from “sample” folder of unzipped content from salesforce. Following is the structure of “build.properties” file.

# build.properties
# Specify the login credentials for the desired Salesforce organization
sf.username = <SFDCUserName>
sf.password = <SFDCPasswrd>
#sf.pkgName = <Insert comma separated package names to be retrieved>
#sf.zipFile = <Insert path of the zipfile to be retrieved>
#sf.metadataType = <Insert metadata type name for which listMetadata or bulkRetrieve operations are to be performed>
# Use 'https://login.salesforce.com' for production or developer edition (the default if not specified).
# Use 'https://test.salesforce.com for sandbox.
sf.serverurl = https://test.salesforce.com

Step 5:
Copy all folders with source code from source organization using eclipse. Lets say the root folder name is “test1”.
Create “build.properties” from above code snippet or copy it from unzipped folder. Now create “build.xml” needed by ANT. Following is the example of build.xml file:

<project name="Shivasoft ANT Tutorial" default="deployCode" basedir="." xmlns:sf="antlib:com.salesforce">
    <property file="build.properties"/>
    <property environment="env"/>
    <!-- Shows deploying code &amp;amp;amp;amp; running tests for code in directory -->
    <target name="deployCode" depends="proxy">
      <sf:deploy username="${sf.username}" password="${sf.password}" serverurl="${sf.serverurl}" deployRoot="test1">
        <runTest>TestClassName</runTest>
      </sf:deploy>
    </target>
    <!-- Shows removing code; only succeeds if done after deployCode -->
    <target name="undeployCode">
      <sf:deploy username="${sf.username}" password="${sf.password}" serverurl="${sf.serverurl}" deployRoot="removecodepkg"/>
    </target>
	<target name="proxy">
		<property name="proxy.host" value=" ProxyURL " />
		<property name="proxy.port" value="1234" />
		<property name="proxy.user" value="UserName" />
		<property name="proxy.pwd" value="Password" />
		<setproxy proxyhost="${proxy.host}" proxyport="${proxy.port}" proxyuser="${proxy.user}" proxypassword="${proxy.pwd}" />
	</target>
</project>

Attribute “deployRoot” means the root folder from which the code should be copied and tag  means the testclasses which should run after the deployment. At last, go to the folder “test1” from command line and run command “ant deployCode”.

Checking the status of the task:
To know the status of task you can run command:
Ant targetName -Dsf.asyncRequestId=requestID

Using Proxy in ANT migration tool:
If your organization uses the proxy then add below target in “build.xml” and specify this target as dependent.

<target name="proxy">
		<property name="proxy.host" value=" ProxyURL " />
		<property name="proxy.port" value="1234" />
		<property name="proxy.user" value="UserName" />
		<property name="proxy.pwd" value="Password" />
		<setproxy proxyhost="${proxy.host}" proxyport="${proxy.port}" proxyuser="${proxy.user}" proxypassword="${proxy.pwd}" />
	</target>

Retrieve content from Salesforce Organization:
create “package.xml” for the list of component to be retrieved and add following task in “build.xml”.

<!-- Retrieve an unpackaged set of metadata from your org -->
<!-- The file unpackaged/package.xml lists what is to be retrieved -->
<target name="test" depends="proxy">
  <mkdir dir="retrieveUnpackaged"/>
  <!-- Retrieve the contents into another directory -->
  <sf:retrieve username="${sf.username}" password="${sf.password}" serverurl="${sf.serverurl}" retrieveTarget="retrieveUnpackaged" unpackaged="unpackaged/package.xml" unzip="false" />
</target>

“Unzip” attribute specifies that the code retrieved should be in Zip format or not. By default the value is true means it will not in zip format.

Delete components from Salesforce Organization using “destructiveChanges.xml” :
In some cases, we may want to delete some components like Object or fields from Salesforce Organization. In this case, Only “package.xml” will not work. We need to create “destructiveChanges.xml” file also. Syntax for this file is exactly same as of “package.xml”, except that here we cannot define wildcards. So, to undeploy anything from Salesforce org, we need two xml files – “package.xml” and “destructiveChanges.xml“.

Below is complete code of build.xml, which includes retrieve, Undeploy and Deploy commands.

<project name="Shivasoft Demo Org" default="deployCode" basedir="." xmlns:sf="antlib:com.salesforce">
	<!-- Get all settings like Server Path, username and passwords from "build.properties" file -->
    <property file="build.properties"/>
    <property environment="env"/>
	<!-- Sequence 1 - Get All information from Source, Retrieve the contents into Src directory -->
	<target name="SFDCFetch">
	  <!-- -->
	  <sf:retrieve username="${sf.username}" password="${sf.password}" serverurl="${sf.serverurl}" retrieveTarget="src" unpackaged="package.xml"/>
	</target>

	<!-- Sequence 3 - Deploy to Target System, Package.xml is present in Src folder -->
	<target name="deploy">
      <sf:deploy username="${sf1.username}" password="${sf1.password}" serverurl="${sf.serverurl}" deployroot="Src">
      </sf:deploy>
    </target> 

	<!-- Sequence 2 - If you want to remove some components, destructiveChanges.xml and Package.xml present in Delete Folder -->
	<target name="unDeploy">
      <sf:deploy username="${sf1.username}" password="${sf1.password}" serverurl="${sf.serverurl}" deployroot="Delete">
      </sf:deploy>
    </target>
</project>

You may also be interested to check how to automate daily Salesforce backup.

How to Create Change set from Package.xml

Step 1 : Create Empty Changeset, lets say its name is changeset2
Step 2 : add fullname tag in package.xml. Fullname needs to be the name of changeset created in Step 1

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<fullName>Changeset2</fullName>
    <types>
        <members>AdditionalQuestionTriggerHandler</members>
...
...
</package>

Step 3 : src folder name which contains package.xml needs to have changeset name, in our case changeset2

How to Create Package.xml from Change set

Use below ANT script

<target name="retrieveChangeset">  
  <sf:retrieve 
username="${sf.username}" 
password="${sf.password}" 
serverurl="${sf.serverurl}" 
retrieveTarget="changesetfolder" 
packageNames="changesetname" /> 
</target>

Update [03-Apr-2017]

Question : Why Salesforce ANT Migration tool is giving wrong Username, Security token or password error, even when everything is correct ?
Ans : If your password contains “$”, then ANT tool ignores this characters. So, to correct this, we need to add one more “$”.

Question : I am getting unable to find tools.jar files error. I don’t have access to server so cannot place tools.jar manually. Can I fix this error using build.xml by placing jar files in relative folder?

Ans : You can include any jar file to be in class path. Add below lines in build.xml. All jar files are placed in lib folder.

<path id="class.path">
<pathelement location="${build}"/>
<fileset dir="./lib">
<include name="**/*.jar" />
</fileset>
</path>

<taskdef resource="com/salesforce/antlib.xml" uri="antlib:com.salesforce" classpathref="class.path"/>

Question : Why I am getting error like java.lang.OutOfMemoryError: Java heap space while retrieving metadata from Salesforce. 

Ans : It is possible that you are retrieving metadata of some big organization with lots of changes. In this case, Java JVM running on system needs more memory (RAM) in order to process it. It can be done in two ways

1. Before running ANT command, run below command which will set the RAM allocated for JVM to 1GB. If you are not a Windows user, then use export instead of set in below command.

set ANT_OPTS=-Xmx1g

2. Problem in above solution is that, you would need to execute set command every time before using ANT. For permanent solution, open ant.bat file in bin folder of ANT installation (Same installation folder referred in ANT_HOME). And, at very first line, write below command and save it.

set ANT_OPTS=-Xmx1g

I hope this article will help newbie to learn ant migration tool.

Before moving ahead let’s have a summary on what is pass by value and pass by reference.

Pass by value means when a method is called, a second copy of the parameter variable is made in memory, and this copy is passed to the method as a parameter. This copy can be modified in the method, but the original variable in the caller is unchanged, and the changes to the copy are lost upon return.

Pass by reference means when a method is called, that actual variable is passed to the method.

Million dollar question: parameters in method are passed by value or pass by reference?
Most of answers: primitive data types like Integer, Double are pass by value and Objects are pass by reference.

However, the above statement is not 100% true. I know I just invited controversy on this post. Be Patient with me and I would prove with actual example, feel free to run these examples in your Developer Console.

Correct Answer: parameters are passed by value in Apex as well as in Java. Where, in case of object the copy of reference is first made and then passed, therefore we can change the fields of object inside method however we cannot change the Object itself.

Take a pause here and think what I just said. I’m saying, new variable copy created which points to same Object. So, it seems reference but variable technically itself is storing value which is address or reference of object.

Let’s discuss this in more detail. I am going to explain two scenarios in which I will try to change the field value and in second example I will try to change Object itself.

Example 1

Account a = new Account(); 
a.Name = 'Shivasoft'; 
a.Website = 'www.JitendraZaa.com'; 
changeWebsite(a); 
System.debug('Website - '+a.Website); 

public void changeWebsite(Account b) { 
    b.Website = 'www.salesforce.com'; 
}  

Output of above code is

Website - www.salesforce.com

What just happened in Example 1

Explanation:
As per code snippet, the object a is supplied in method changeWebsite(). The parameter is actually passed by value, where the copy of value a is passed to object b which is memory address (aka reference). As we can see that both variable have reference of same object and hence whatever changes done by variable b on that object it will be applicable for variable a also.

If you are still not convinced and think I’m wrong, wait for example 2.

Example 2

Account a = new Account(); 
a.Name = 'Shivasoft'; 
a.Website = 'www.JitendraZaa.com'; 
changeWebsite(a); 
System.debug('Website - '+a.Website); 

public void changeWebsite(Account b) { 
    //Create New Object and try to replace old 
    b = new Account();
    b.Website = 'www.salesforce.com'; 
}  

Before I go further and reveal answer, let’s think what would be output ?

If you assumed method parameters are passed by reference then output should be

Website - www.salesforce.com

However actual output is

Website - www.JitendraZaa.com

What just happened in example 2 ?

Explanation:
As per code snippet, the object a is supplied in method changeWebsite(). Like I said, the parameter itself is actually passed by value, where the copy of value a is passed to object b which was reference. As we can see that both variable had reference of same object initially. However, inside the method new object is created and reference assigned to b and just now important event occurred. Refer above image for clear explanation

Previously b was pointing to old object, if it was really reference then it should impact object a. However now a and b variables point to different object. Whatever the changes done inside method, it will not be reflected outside as object a still have old reference. And hence after method execution when we check the value of object a, it is not affected because of method execution.

Salesforce documentation says :

“In Apex, all primitive data type arguments, such as Integer or String, are passed into methods by value. This means that any changes to the arguments exist only within the scope of the method. When the method returns, the changes to the arguments are lost.
Non-primitive data type arguments, such as sObjects, are also passed into methods by value. This means that when the method returns, the passed-in argument still references the same object as before the method call, and can’t be changed to point to another object. However, the values of the object’s fields can be changed in the method.”

Time for Best Practice

Because of behavior of parameters are passed as a value, it is always best practice to return object back to calling method. JUST DON’T ASSUME that object is passed by reference and whatever happened inside method will reflect calling method.

So code would become

Account a = new Account(); 
a.Name = 'Shivasoft'; 
a.Website = 'www.JitendraZaa.com'; 
a = changeWebsite(a); 
System.debug('Website - '+a.Website); 

public Account changeWebsite(Account b) { 
    //Create New Object and try to replace old 
    b = new Account();
    b.Website = 'www.salesforce.com'; 
    return b ;
}  

1. declare class as final
2. declare all variables as final
3. provide constructor to set the values
4. provide getter

Source code:

package in.shivasoft.demo;

final class Immutable
{
	private final int val1;
	private final String val2;

	public Immutable(int a, String s)
	{
		val1 = a;
		val2 = s;
	}
	public int getVal1()
	{
		return val1;
	}
	public String getVal2()
	{
		return val2;
	}
}

public class ImmutableClassDemo {
	public static void main(String[] args) {
		Immutable obj = new Immutable(10, "ShivaSoft ...the supreme solution");
		System.out.println(obj.getVal1());
		System.out.println(obj.getVal2());
	}
}

Output :

10
ShivaSoft …the supreme solution

SOAP Message consist of following three parts:

1. SOAP-ENV:Envelope
2. SOAP-ENV:Header
3. SOAP-ENV:Body

To create the SOAP, first we will need to create the object of “javax.xml.soap.MessageFactory“, then create object of “javax.xml.soap.SOAPMessage“. This object of “SOAPMessage” will have all the messages inside it in “javax.xml.soap.SOAPEnvelope” object. Every “Envelope” will have the “Header” and “Body” as shown in below program:

package com.service.SOAPMain;

import java.io.FileOutputStream;

import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPBody;
import javax.xml.soap.SOAPBodyElement;
import javax.xml.soap.SOAPEnvelope;
import javax.xml.soap.SOAPHeader;
import javax.xml.soap.SOAPMessage;
import javax.xml.soap.SOAPPart;

public class CreateSOAPMessage {

	/**
	 * @param args
	 */
	public static void main(String[] args) {
		try{
			MessageFactory factory = MessageFactory.newInstance();
			SOAPMessage soapMsg = factory.createMessage();
			SOAPPart part = soapMsg.getSOAPPart();

			SOAPEnvelope envelope = part.getEnvelope();
			SOAPHeader header = envelope.getHeader();
			SOAPBody body = envelope.getBody();

			header.addTextNode("Training Details");

			SOAPBodyElement element = body.addBodyElement(envelope.createName("JAVA", "training", "https://jitendrazaa.com/blog"));
			element.addChildElement("WS").addTextNode("Training on Web service");

			SOAPBodyElement element1 = body.addBodyElement(envelope.createName("JAVA", "training", "https://jitendrazaa.com/blog"));
			element1.addChildElement("Spring").addTextNode("Training on Spring 3.0");

			soapMsg.writeTo(System.out);

			FileOutputStream fOut = new FileOutputStream("SoapMessage.xml");
			soapMsg.writeTo(fOut);

			System.out.println();
			System.out.println("SOAP msg created");

		}catch(Exception e){
			e.printStackTrace();
		}

	}

}

As the output, one xml file of named “SoapMessage.xml” will be created and also printed on the console.

Quartz is a job scheduling system that can be integrated with, or used along side virtually any other software system. The term “job scheduler” seems to conjure different ideas for different people. As you read this tutorial, you should be able to get a firm idea of what we mean when we use this term, but in short, a job scheduler is a system that is responsible for executing (or notifying) other software components when a pre-determined (scheduled) time arrives.
Quartz is quite flexible, and contains multiple usage paradigms that can be used separately or together, in order to achieve your desired behavior, and enable you to write your code in the manner that seems most ‘natural’ to your project.
Quartz is very light-weight, and requires very little setup/configuration – it can actually be used ‘out-of-the-box’ if your needs are relatively basic.
Quartz is fault-tolerant, and can persist (‘remember’) your scheduled jobs between system restarts.
Although Quartz is extremely useful for simply running certain system processes on given schedules, the full potential of Quartz can be realized when you learn how to use it to drive the flow of your application’s business processes.

Why not just use java.util.Timer?
Since JDK 1.3, Java has “built-in” timer capabilities, through the java.util.Timer and java.util.TimerTask classes – why would someone use Quartz rather than these standard features?
There are many reasons! Here are a few:

1. Timers have no persistence mechanism.
2. Timers have inflexible scheduling (only able to set start-time & repeat interval, nothing based on dates, time of day, etc.)
3. Timers don’t utilize a thread-pool (one thread per timer)
4. Timers have no real management schemes – you’d have to write your own mechanism for being able to remember, organize and retrieve your tasks by name, etc.

Download the jar files for Quartz from here.

jar files neede are:

quartz-2.0.2.jar
slfj-log4j12-1.6.1.jar
sl4j-api-1.6.1.jar
log4j-1.2.14.jar

Example with Source code:

DisplayCurrentTime.java

package in.shivasoft.quartz;

import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Date;
import java.util.GregorianCalendar;

import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;

public class DisplayCurrentTime implements Job {
	Calendar c;
	Date d;
	SimpleDateFormat sdf;

	public DisplayCurrentTime()
	{}

	@Override
	public void execute(JobExecutionContext context) throws JobExecutionException {
		c = new GregorianCalendar();
		d = c.getTime();
		sdf = new SimpleDateFormat("d MMMMM yyyy - HH:mm:ss aaa");
		String msg = String.format("Job Name - %s, Current Time - %s", context.getJobDetail().getKey(), sdf.format(d));
		System.out.println(msg);
	}
}

Create a class which should be executed by the quartz scheduler. The class must implement the interface “Job“. The Job interface has only one method “execute()“. The logic which should be executed must be written in this method. There must be the default constructor in class, as scheduler will create the object of that class at runtime.

SimpleQuartzDemo.java

package in.shivasoft.quartz;

import java.text.ParseException;
import java.util.Date;

import org.quartz.CronScheduleBuilder;
import org.quartz.CronTrigger;
import org.quartz.DateBuilder;
import org.quartz.JobBuilder;
import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SchedulerException;
import org.quartz.SchedulerFactory;
import org.quartz.SimpleScheduleBuilder;
import org.quartz.SimpleTrigger;
import org.quartz.Trigger;
import org.quartz.TriggerBuilder;
import org.quartz.impl.StdSchedulerFactory;

public class SimpleQuartzDemo {

	/**
	 * @param args
	 */
	public static void main(String[] args) {
		SimpleQuartzDemo obj = new SimpleQuartzDemo();
		obj.runDemo();
	}

	public void runDemo() {
		try {

			// First we must get a reference to a scheduler
	        SchedulerFactory sf = new StdSchedulerFactory();
	        Scheduler sched = sf.getScheduler();

	        /**
	         * Job 1 using Trigger
	         */
			JobDetail job1 = JobBuilder.newJob(DisplayCurrentTime.class)
					.withIdentity("currentTime-Job-1", "group1")
					.build();

			//This trigger will run every minute in infinite loop
			Trigger trigger1 = TriggerBuilder.newTrigger()
					.withIdentity("everyMinuteTrigger", "group1")
					.startAt(new Date(System.currentTimeMillis()))
					.withSchedule( CronScheduleBuilder.cronSchedule( "0 0/1 * 1/1 * ? *"))
					.build();

			Date ft = sched.scheduleJob(job1, trigger1);
			sched.start();

			System.out.println(job1.getKey() + " has been scheduled to run at: " + ft);

			/**
			 * Job 2 using SimpleTrigger
			 */
			JobDetail job2 = JobBuilder.newJob(DisplayCurrentTime.class)
			.withIdentity("currentTime-Job-2", "group1")
			.build();

			// get a "nice round" time a few seconds in the future....
			Date startTime = DateBuilder.nextGivenSecondDate(null, 10);

			//This trigger will run every 10 sec for 4 times
			SimpleTrigger trigger2 = TriggerBuilder.newTrigger()
            .withIdentity("fourTimesTrigger", "group1")
            .startAt(startTime)
            .withSchedule( SimpleScheduleBuilder.simpleSchedule()
                    .withIntervalInSeconds(10)
                    .withRepeatCount(4))
            .build();

	ft = sched.scheduleJob(job2, trigger2);
	sched.start();

	System.out.println(job1.getKey() + " has been scheduled to run at: " + ft);

	/**
	* Job 3 Using CronTrigger
	*/
	JobDetail job3 = JobBuilder.newJob(DisplayCurrentTime.class)
		.withIdentity("currentTime-Job-3", "newGroup")
		.build();

	//run every 20 seconds
	CronTrigger trigger3 = TriggerBuilder.newTrigger()
            .withIdentity("twentySec", "group2")
            .withSchedule( CronScheduleBuilder.cronSchedule( "0/20 * * * * ?"))
            .build();

	ft = sched.scheduleJob(job3, trigger3);
	sched.start();

		} catch (SchedulerException e) {
			e.printStackTrace();
		}
		catch (ParseException e) {
			e.printStackTrace();
		}
	}
}

As you can see in above program, we have created the object of “StdSchedulerFactory“, which will schedule the job.
Then we have created the job and trigger to be executed by quartz framework.

In above example we have created three jobs and triggers.
While creating job, we specify that which class (implements interface Job) will be executed by framework. And the “JobName” and “Thread group” in which it will be executed.

We have used three types of trigger in above example:

1. Trigger
2. SimpleTrigger
3. CronTrigger

• First trigger will execute every minute in infinite loop.
• Second trigger will execute in every 10 sec for 4 times.
• Third trigger will execute every 20 sec in infinite loop.

As you can observe, Trigger 1 and Trigger 3 are scheduled using “Cron Expressions“.
To create the Cron Expression easily or explain the cron expression, please refer this website.

Read more about Cron Expression at WIKI.

The output of the program will be like :

group1.currentTime-Job-1 has been scheduled to run at: Thu Sep 22 18:35:00 IST 2011
group1.currentTime-Job-1 has been scheduled to run at: Thu Sep 22 18:34:40 IST 2011
Job Name – group1.currentTime-Job-2, Current Time – 22 September 2011 – 18:34:40 PM
Job Name – newGroup.currentTime-Job-3, Current Time – 22 September 2011 – 18:34:40 PM
Job Name – group1.currentTime-Job-2, Current Time – 22 September 2011 – 18:34:50 PM
Job Name – group1.currentTime-Job-1, Current Time – 22 September 2011 – 18:35:00 PM
Job Name – group1.currentTime-Job-2, Current Time – 22 September 2011 – 18:35:00 PM
Job Name – newGroup.currentTime-Job-3, Current Time – 22 September 2011 – 18:35:00 PM
Job Name – group1.currentTime-Job-2, Current Time – 22 September 2011 – 18:35:10 PM
Job Name – group1.currentTime-Job-2, Current Time – 22 September 2011 – 18:35:20 PM
Job Name – newGroup.currentTime-Job-3, Current Time – 22 September 2011 – 18:35:20 PM

Download Quartz Source code and change extension from txt to rar

In this example, we will create a simple login application using hibernate tool of eclipse. We will use eclipse WTP (Web Tools Platform), to install “Hibernate Tools”. Follow below steps :

In Eclipse IDE, menu bar, select “Help” >> “Install New Software …” put the Eclipse update site URL “http://download.jboss.org/jbosstools/updates/stable/helios”

Select the tool and click on “Next”. Do not select all the tools; it will install all the unnecessary tools. We just need hibernate tools.

After installation, restart the eclipse.

If you don’t have the internet connection and want the offline method to add hibernate tools in eclipse. To install the Hibernate Tools, extract the HibernateTools-3.X.zip file and move all the files inside the features folder into the features folder of the eclipse installation directory and move all the files inside the plugins folder into the plugins folder of the ecilpse installation directory.

After restart, Go to Window | Open Perspective | Other, the following dialog box appears, select Hibernate and click the Ok button.

Now let’s see how to define the object/relational mapping using the XML document. This document has .hbm.xml extension. We will now create the mapping between table and object of entity “user” which hold the data from database. So create the package "in.shivasoft.pojo" in src folder.
Right click on project folder and select “Hibernate XML Mapping file (hbm.xml)“.

Then one popup will appear, click on “Next”.

Select the pojo folder and give name “Users.hbm.xml” and click on finish.

Now, either you can configure the settings from the UI like below snap:

Or, write below code :

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN" "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd">
<hibernate-mapping>
 <class entity-name="Users" name="in.shivasoft.pojo.Users" table="Users">
  <meta attribute="description">This class is used to save the info about users</meta>
  <id column="UserId" name="UserId" type="long"/>
  <property column="FName" name="FName" type="string"/>
  <property column="LName"  name="LName" type="string"/>
  <property column="UserTypeId" name="UserTypeId" type="long"/>
  <property column="UserName" name="UserName" type="string"/>
  <property column="Email" name="Email" type="string"/>
  <property column="Pwd" name="Pwd" type="string"/>
  <property column="Note" name="Note" type="string"/>
  <property column="IsActive" name="IsActive" type="boolean"/>
 </class>
</hibernate-mapping>

Now right click and select “hibernate configuration file”. One window will open, there select the “src” folder and click on next.

Enter detail like below screen and click on finish button.

After this add the Users.hbm.xml file to the newly generated xml configuration.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE hibernate-configuration PUBLIC
		"-//Hibernate/Hibernate Configuration DTD 3.0//EN"
		"http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd">
<hibernate-configuration>
    <session-factory>
        <property name="hibernate.connection.driver_class"> org.gjt.mm.mysql.Driver </property>
        <property name="hibernate.connection.password"> root </property>
        <property name="hibernate.connection.url"> jdbc:mysql://localhost/test </property>
        <property name="hibernate.connection.username"> root </property>
        <property name="hibernate.dialect"> org.hibernate.dialect.MySQL5InnoDBDialect </property>
        <mapping resource="in/shivasoft/pojo/Users.hbm.xml"/>
    </session-factory>
</hibernate-configuration>

After the entire configuration, in the toolbar you can select “hibernate code generation tool”.

Now select the Exporters tab and select “Use Java 5 Syntax”.

In refresh tab, select “The Project containing the selected resource“.

Now click the run button to finish java code generation. Following code will be generated:

package in.shivasoft.pojo;

// Generated Aug 1, 2011 7:02:59 PM by Hibernate Tools 3.4.0.CR1

/**
 * Users generated by hbm2java
 */
public class Users implements java.io.Serializable {

	private long UserId;
	private String FName;
	private String LName;
	private long UserTypeId;
	private String UserName;
	private String Email;
	private String Pwd;
	private String Note;
	private boolean IsActive;

	public Users() {
	}

	public Users(long UserId) {
		this.UserId = UserId;
	}

	public Users(long UserId, String FName, String LName, long UserTypeId,
			String UserName, String Email, String Pwd, String Note,
			boolean IsActive) {
		this.UserId = UserId;
		this.FName = FName;
		this.LName = LName;
		this.UserTypeId = UserTypeId;
		this.UserName = UserName;
		this.Email = Email;
		this.Pwd = Pwd;
		this.Note = Note;
		this.IsActive = IsActive;
	}

	public long getUserId() {
		return this.UserId;
	}

	public void setUserId(long UserId) {
		this.UserId = UserId;
	}

	public String getFName() {
		return this.FName;
	}

	public void setFName(String FName) {
		this.FName = FName;
	}

	public String getLName() {
		return this.LName;
	}

	public void setLName(String LName) {
		this.LName = LName;
	}

	public long getUserTypeId() {
		return this.UserTypeId;
	}

	public void setUserTypeId(long UserTypeId) {
		this.UserTypeId = UserTypeId;
	}

	public String getUserName() {
		return this.UserName;
	}

	public void setUserName(String UserName) {
		this.UserName = UserName;
	}

	public String getEmail() {
		return this.Email;
	}

	public void setEmail(String Email) {
		this.Email = Email;
	}

	public String getPwd() {
		return this.Pwd;
	}

	public void setPwd(String Pwd) {
		this.Pwd = Pwd;
	}

	public String getNote() {
		return this.Note;
	}

	public void setNote(String Note) {
		this.Note = Note;
	}

	public boolean isIsActive() {
		return this.IsActive;
	}

	public void setIsActive(boolean IsActive) {
		this.IsActive = IsActive;
	}

}

Now create the

HibernateUtil

class. The HibernateUtil class helps in creating the SessionFactory from the Hibernate configuration file. The SessionFactory is threadsafe, so it is not necessary to obtain one for each thread. Here the static singleton pattern is used to instantiate the SessionFactory. The implementation of the HibernateUtil class is shown below.

package in.shivasoft.util;

import org.hibernate.SessionFactory;

import org.hibernate.cfg.Configuration;

public class HibernateUtil {

	private static final SessionFactory sessionFactory;

	static {

		try {

			sessionFactory = new Configuration().configure()
			.buildSessionFactory();

		} catch (Throwable ex) {

			System.err.println("Initial SessionFactory creation failed." + ex);

			throw new ExceptionInInitializerError(ex);

		}

	}

	public static SessionFactory getSessionFactory() {

		return sessionFactory;

	}
}

Now, create the test application having main method which will demonstrate that how data is saved:

package in.shivasoft.test;

import in.shivasoft.pojo.Users;
import in.shivasoft.util.HibernateUtil;

import java.util.List;

import org.hibernate.Session;
import org.hibernate.Transaction;

public class TestMain {

	/**
	 * @param args
	 */
	public static void main(String[] args) {
		TestMain obj = new TestMain();
		//obj.saveRecord();
		obj.updateUser(12);
		obj.deleteUser(13);
		obj.getList();
	}

	public void saveRecord()
	{
		Users u = new Users(0, "Jitendra", "Zaa", 1, "jitendra.zaa", "jitendra.zaa@JitendraZaa.com", "test", "this is note", true);
		Session session = HibernateUtil.getSessionFactory().openSession();
		Transaction transaction = null;
		try
		{
			transaction = session.beginTransaction();
			session.save(u);
			transaction.commit();
			System.out.println("Data Saved");
		}catch(Exception e)
		{
			e.printStackTrace();
		}finally{session.close();}

	}
	public void deleteUser(long UserId)
	{
		Session session = HibernateUtil.getSessionFactory().openSession();
		Transaction transaction = null;
		try
		{
			transaction = session.beginTransaction();
			Users u = (Users)session.get(Users.class,UserId);
			session.delete(u);
			transaction.commit();
			System.out.println("Data Deleted");
		}
		catch(Exception e)
		{
			e.printStackTrace();
		}
		finally{
			session.close();
		}
	}
	public void updateUser(long UserId)
	{
		Session session = HibernateUtil.getSessionFactory().openSession();
		Transaction transaction = null;
		try
		{
			transaction = session.beginTransaction();
			Users u = (Users)session.get(Users.class,UserId);
			u.setFName("ShivaSoft");
			transaction.commit();
			System.out.println("Data Updated");
		}
		catch(Exception e)
		{
			e.printStackTrace();
		}
		finally{
			session.close();
		}
	}

	public void getList()
	{
		Session session = HibernateUtil.getSessionFactory().openSession();
		Transaction transaction = null;
		try
		{
			transaction = session.beginTransaction();
			List<Users> uList = session.createQuery("from Users").list();
			for(Users u : uList)
			{
				System.out.println("First Name - "+u.getFName());
			}
		}
		catch(Exception e)
		{
			e.printStackTrace();
		}
		finally{
			session.close();
		}
	}
}

Needed jar files :

antlr-2.7.6.jar
commons-collections-3.1.jar
dom4j-1.6.1.jar
hibernate-core.3.3.1.GA.jar
javassist-3.9.0.GA.jar
jta-1.1.jar
mysql-connector-java-5.1.1.17-bin.jar
slf4j-api-1.6.1.jar
slf4j-api-1.6.1-tests.jar
slf4j-slf4j-simple-2.0.jar