Hazelcast IMDG ${project.version} Readme

Table of Contents

• What's Included
• Getting Started
• Management Center
• Getting Clients and Language APIs
• Hazelcast IMDG Plugins
• Training, Tutorials and Events
• Hazelcast Community
• Support

What's Included:

Folders

• /bin
  • hazelcast.xml — the configuration file for Hazelcast IMDG.
  • hazelcast-full-example.xml — Complete Hazelcast IMDG XML configuration file that includes all the configuration elements and attributes with their descriptions.
  • hazelcast-full-example.yaml — Complete Hazelcast IMDG YAML configuration file that includes all the configuration elements and attributes with their descriptions.
  • hazelcast-client-full-example.xml — Complete Hazelcast IMDG Java client XML configuration file that includes all the configuration elements and attributes with their descriptions.
  • hazelcast-client-full-example.yaml — Complete Hazelcast IMDG Java client YAML configuration file that includes all the configuration elements and attributes with their descriptions.
  • hazelcast-client-failover-full-example.xml — Complete XML configuration file for Hazelcast IMDG Java client failover which includes all Hazelcast client failover configuration elements and attributes with their descriptions.
  • hazelcast-client-failover-full-example.yaml — Complete YAML configuration file for Hazelcast IMDG Java client failover which includes all the configuration elements and attributes with their descriptions.
  • start.bat — Starts a Hazelcast IMDG member for Windows users.
  • start.sh — Starts a Hazelcast IMDG member for Linux users.
  • stop-all.bat — Stops all of the running Hazelcast IMDG member for Windows users.
  • stop-all.sh — Stops all of the running Hazelcast IMDG member for Linux users.
  • cp-subsystem.sh — Provides access to the CP subsystem management APIs using the REST interface.
  • cluster.sh — Provides basic functionalities for cluster management such as getting and changing the cluster state, shutting down the cluster or forcing the cluster to clean its persisted data and make a fresh start.
  • healthcheck.sh — Provides basic information about your cluster and member (on which you run this script) .
• /code-samples — Hazelcast IMDG code samples to learn from and include in your projects. Please refer to the code samples readme for more information.
• /demo
  • clientConsole.bat — Starts a sample client application for Windows users. You can perform, for example, usual map operations using command line interface. This application requires an up and running Hazelcast IMDG cluster.
  • clientConsole.sh — Starts a sample client application for Linux users. You can perform, for example, usual map operations using command line interface. This application requires an up and running Hazelcast IMDG cluster.
  • console.bat — Starts a sample Hazelcast IMDG member application for Windows users.
  • console.sh — Starts a sample Hazelcast IMDG member application for Linux users.
• /docs
  • /javadoc — Hazelcast IMDG Javadoc.
  • /manual — Hazelcast IMDG Reference Manual, also available in single page and pdf formats.
• /lib
  • hazelcast.jar — The core Hazelcast IMDG JAR which also includes the Java native client library.
  • hazelcast-all.jar — Includes all of the libraries here in one JAR file.
  • hazelcast-spring.jar — This is the library to integrate Hazelcast with Spring based applications.
  • further-modules.txt — This text file includes the list of other modules and plugins provided/supported by Hazelcast and the community, along with the information on how you can reach them.
• /license
  • apache-v2-license.txt — Hazelcast IMDG license.
  • minimal-json-license.txt — Minimal JSON parser and writer's license.
  • notice.txt — NOTICE file corresponding to the section 4 (d) of the Apache License.
• /management-center
  • changelog.txt — Shows the main changes performed for each Hazelcast Management Center release.
  • /docs — Includes the HTML and PDF versions of Hazelcast Management Center Reference Manual.
  • hazelcast-management-center-${project.version}.war — File to be deployed when starting the tool.
  • license.txt — Hazelcast Management Center license.
  • mc-conf.bat/mc-conf.sh — Command line tool that allows you to update certain parts of the Management Center configuration by using its built-in commands.
  • release_notes.txt — Lists the new features, enhancements and fixes for this Hazelcast Management Center release.
  • start.bat/start.sh — Script to start a Hazelcast Management Center instance for Windows and Linux users, respectively.
  • ThirdPartyNotices.txt — License and copyright notices for 3rd-party libraries used in Hazelcast Management Center.

TXT Files

• changelog.txt — Shows the main changes performed for each Hazelcast IMDG release.
• release_notes.txt — Lists the new features, enhancements and fixes for this Hazelcast IMDG release.

Getting Started

First, go through the included Getting Started guide to get Hazelcast IMDG up and running. Don't miss the sections on starting a Hazelcast IMDG member and client and configuring Hazelcast.

The online Getting Started guide includes video tutorials to guide you through building your first Hazelcast IMDG application and running your cluster.

Hazelcast Management Center

Besides the /management-center folder in the Hazelcast IMDG package, you can have the Hazelcast Management Center also from the downloads page.

See the Hazelcast Management Center Reference Manual for installation and detailed usage instructions.

Getting Clients and Language APIs

All of the following clients and language APIs are open source and supported by Hazelcast. Click on a client or language, and you will be directed to its release page.

• Java Client ${project.version}
• .NET Client 3.12.2
• C++ Client 3.12.1
• Node.js Client 3.12.3
• Python Client 3.12.3
• Go Client 0.6.0
• Scala Client Binding 3.12.1
• Scala Member Binding 3.12.1

See Clients & Languages page to see the client/language feature comparison table.

Hazelcast IMDG Plugins

You can extend Hazelcast IMDG's functionality by adding its plugins. Please see Plugins page to learn about Hazelcast IMDG plugins you can use.

Training, Tutorials and Events

• Hazelcast.org/Learn is the hub for online training, tutorials and learning resources.
• Hazelcast.com/Events will connect you with live training classes, user groups, meetups and events.

Hazelcast Community

Get your questions answered and share your knowledge on Stack Overflow and our Google Group.

Support

For information on professional support subscriptions, please visit Hazelcast.com/Support.