.hazelcast-all.3.8.source-code.readme.html Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hazelcast-all Show documentation
There is a newer version: 5.0-BETA-1



	
	Hazelcast Readme
	
	
	
	
	



	
		
	
	
		Hazelcast Readme
		
		Table of Contents
		
			What's Included
			Getting Started
			Management Center
			Getting Clients and Language APIs
			Hazelcast Plugins
			Training, Tutorials and Events
			Hazelcast Community
			Support									
			
		
		
		What's Included:
		
		
		
		Folders	
			
			/bin
				
				hazelcast.xml — the configuration file for Hazelcast.
				hazelcast-full-example.xml — It is the Hazelcast configuration file that includes all the configuration elements and attributes with their descriptions.
				start.bat — Starts a Hazelcast member for Windows users.
				start.sh —  Starts a Hazelcast member for Linux users.
                stop.bat — Stops the current running Hazelcast member for Windows users.
                stop.sh — Stops the current running Hazelcast member for Linux users.
                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.
				
			
			
			/code-samples — Hazelcast 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 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 cluster.
					console.bat — Starts a sample Hazelcast member application for Windows users.
					console.sh — Starts a sample Hazelcast member application for Linux users.				
							
			
			
			/docs
				
				/javadoc — Hazelcast Javadoc.
				/manual — Hazelcast Reference Manual, also available in single page and pdf formats.
							
			
			
			/lib
				
					hazelcast.jar — The core hazelcast JAR.
					hazelcast-all.jar — Includes all of the libraries here in one JAR file.
					hazelcast-client.jar — The Java native client library to be included on classpath for Hazelcast client. This library contains clients which use the new Hazelcast Binary Client Protocol, introduced in the Hazelcast 3.5 Release.
					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 license.
					mancenter-license.txt — Management Center 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.
					README.txt — License README.
							
			
			
			/mancenter
				
					mancenter–version.war — Hazelcast Management Center. This WAR file is executable (double click on it) to start Management Center or can be deployed as a web application. Please see the Management Center chapter for more information.
					startManCenter.bat — Starts the management center for Windows users.
					startManCenter.sh — Starts the management center for Linux users.
				
			
			

					
		
		
		TXT Files
                                
				changelog.txt — Shows the documentation revision history for Hazelcast Reference Manual.
				release_notes.txt — Lists the new features, enhancements and fixes for this Hazelcast release.
				
	
		
		Getting Started
		First, go through the included Getting Started guide to get Hazelcast up and running. Don't miss the sections on starting a Hazelcast member and client and 
		configuring Hazelcast.

		
The online Getting Started guide includes video tutorials to guide you through building your first Hazelcast application and running your cluster.
		
		
		Management Center
		See the included Management Center chapter for installation instructions and an overview of Management Center.

		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 3.6.3
				.NET Client 3.6.3
				C++ Client 3.6.3
				Node.js Client 0.3.0
				Python Client 0.3
				Scala Client Binding 0.0.1.12
				Scala Member Binding 0.0.1.12
				

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

		Hazelcast Plugins
		You can extend Hazelcast's functionality by adding its plugins. Please see Plugins page to learn about Hazelcast 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.