Hazelcast | Getting Started

Enterprise quality distributed cache with open source freedom!

Getting Started Tutorial

In this short tutorial, we will create simple Java application using Hazelcast distributed map and queue. Then we will run our application twice to have two nodes (JVMs) clustered and finalize this tutorial with connecting to our cluster from another Java application by using Hazelcast Native Java Client API.

  • Download the latest Hazelcast.
  • Unzip it and add the lib/hazelcast.jar to your class path.
  • Create a Java class and import Hazelcast libraries.

  • Following code will start the first node and create and use customers map and queue. 

    import com.hazelcast.core.Hazelcast;
import java.util.Map;
import java.util.Queue;

public class GettingStarted {

    public static void main(String[] args) {
	Map<Integer, String> mapCustomers = Hazelcast.getMap("customers");
	mapCustomers.put(1, "Joe");
	mapCustomers.put(2, "Ali");
	mapCustomers.put(3, "Avi");

	System.out.println("Customer with key 1: "+ mapCustomers.get(1));
	System.out.println("Map Size:" + mapCustomers.size());

	Queue<String> queueCustomers = Hazelcast.getQueue("customers");
	queueCustomers.offer("Tom");
	queueCustomers.offer("Mary");
	queueCustomers.offer("Jane");
	System.out.println("First customer: " + queueCustomers.poll());
	System.out.println("Second customer: "+ queueCustomers.peek());
	System.out.println("Queue size: " + queueCustomers.size());
    }
}

  • Run this class second time to get the second node started.

  • Have you seen they formed a cluster? You should see something like this: 

    Members [2] {
	Member [127.0.0.1:5701]
	Member [127.0.0.1:5702] this
}

Connecting Hazelcast Cluster with Java Client API

  • Besides hazelcast.jar you should also add hazelcast-client.jar to your classpath.
  • Following code will start a Hazelcast Client, connect to our two node cluster and print the size of our customers map. 

    package com.hazelcast.test;

import com.hazelcast.client.ClientConfig;
import com.hazelcast.client.HazelcastClient;
import com.hazelcast.core.HazelcastInstance;
import com.hazelcast.core.IMap;

public class GettingStartedClient {

    public static void main(String[] args) {
	ClientConfig clientConfig = new ClientConfig();
	clientConfig.addAddress("127.0.0.1:5701");
	HazelcastInstance client = HazelcastClient.newHazelcastClient(clientConfig);
	IMap map = client.getMap("customers");
	System.out.println("Map Size:" + map.size());
    }
}

  • When you run it, you will see the client properly connects to the cluster and print the map size as 3.

What is Next?

  • You can browse documentation and resources for detailed features and examples.
  • You can email your questions to Hazelcast mail group.
  • You can browse Hazelcast source code.

Getting Started Screencast


Hazelcast screencast requires JavaScript to be enabled and the latest version of the Macromedia Flash Player. If you are you using a browser with JavaScript disabled please enable it now. Otherwise, please update your version of the free Flash Player by downloading here.