Package com.hazelcast.core
Class Hazelcast
java.lang.Object
com.hazelcast.core.Hazelcast
public final class Hazelcast extends Object
Factory for
HazelcastInstance
's, a node in a cluster.-
Method Summary
Modifier and Type Method Description static Set<HazelcastInstance>
getAllHazelcastInstances()
Returns all active/running HazelcastInstances on this JVM.static HazelcastInstance
getHazelcastInstanceByName(String instanceName)
Returns an existing HazelcastInstance with instanceName.static HazelcastInstance
getOrCreateHazelcastInstance()
Gets or creates a HazelcastInstance with the default XML configuration looked up in: System property: Hazelcast will first check if "hazelcast.config" system property is set to a file or aclasspath:...
path.static HazelcastInstance
getOrCreateHazelcastInstance(Config config)
Gets or creates the HazelcastInstance with a certain name.static HazelcastInstance
newHazelcastInstance()
Creates a new HazelcastInstance (a new node in a cluster).static HazelcastInstance
newHazelcastInstance(Config config)
Creates a new HazelcastInstance (a new node in a cluster).static void
setOutOfMemoryHandler(OutOfMemoryHandler outOfMemoryHandler)
SetsOutOfMemoryHandler
to be used when anOutOfMemoryError
is caught by Hazelcast threads.static void
shutdownAll()
Shuts down all memberHazelcastInstance
s running on this JVM.
-
Method Details
-
shutdownAll
public static void shutdownAll()Shuts down all memberHazelcastInstance
s running on this JVM. It doesn't shutdown all members of the cluster but just the ones running on this JVM.- See Also:
newHazelcastInstance(Config)
-
newHazelcastInstance
Creates a new HazelcastInstance (a new node in a cluster). This method allows you to create and run multiple instances of Hazelcast cluster members on the same JVM.To shutdown all running HazelcastInstances (all members on this JVM) call
shutdownAll()
.- Parameters:
config
- Configuration for the new HazelcastInstance (member)- Returns:
- the new HazelcastInstance
- See Also:
shutdownAll()
,getHazelcastInstanceByName(String)
-
newHazelcastInstance
Creates a new HazelcastInstance (a new node in a cluster). This method allows you to create and run multiple instances of Hazelcast cluster members on the same JVM.To shutdown all running HazelcastInstances (all members on this JVM) call
shutdownAll()
. Hazelcast will look into two places for the configuration file:-
System property: Hazelcast will first check if "hazelcast.config" system property is set to a file or a
classpath:...
path. Examples: -Dhazelcast.config=C:/myhazelcast.xml , -Dhazelcast.config=classpath:the-hazelcast-config.xml , -Dhazelcast.config=classpath:com/mydomain/hazelcast.xml - "hazelcast.xml" file in current working directory
- Classpath: Hazelcast will check classpath for hazelcast.xml file.
- Returns:
- the new HazelcastInstance
- See Also:
shutdownAll()
,getHazelcastInstanceByName(String)
-
System property: Hazelcast will first check if "hazelcast.config" system property is set to a file or a
-
getHazelcastInstanceByName
Returns an existing HazelcastInstance with instanceName.To shutdown all running HazelcastInstances (all members on this JVM) call
shutdownAll()
.- Parameters:
instanceName
- Name of the HazelcastInstance (member)- Returns:
- an existing HazelcastInstance
- See Also:
newHazelcastInstance(Config)
,shutdownAll()
-
getOrCreateHazelcastInstance
Gets or creates a HazelcastInstance with the default XML configuration looked up in:-
System property: Hazelcast will first check if "hazelcast.config" system property is set to a file or a
classpath:...
path. Examples: -Dhazelcast.config=C:/myhazelcast.xml , -Dhazelcast.config=classpath:the-hazelcast-config.xml , -Dhazelcast.config=classpath:com/mydomain/hazelcast.xml - "hazelcast.xml" file in current working directory
- Classpath: Hazelcast will check classpath for hazelcast.xml file.
IllegalArgumentException
will be thrown. If a Hazelcast instance with the same name as the configuration exists, then it is returned, otherwise it is created.- Returns:
- the HazelcastInstance
- Throws:
IllegalArgumentException
- if the instance name of the config is null or empty or if no config file can be located.
-
System property: Hazelcast will first check if "hazelcast.config" system property is set to a file or a
-
getOrCreateHazelcastInstance
Gets or creates the HazelcastInstance with a certain name. If a Hazelcast instance with the same name as the configuration exists, then it is returned, otherwise it is created. Ifconfig
isnull
, then an XML configuration file is looked up in the following order:-
System property: Hazelcast will first check if "hazelcast.config" system property is set to a file or a
classpath:...
path. Examples: -Dhazelcast.config=C:/myhazelcast.xml , -Dhazelcast.config=classpath:the-hazelcast-config.xml , -Dhazelcast.config=classpath:com/mydomain/hazelcast.xml - "hazelcast.xml" file in current working directory
- Classpath: Hazelcast will check classpath for hazelcast.xml file.
- Parameters:
config
- the Config.- Returns:
- the HazelcastInstance
- Throws:
IllegalArgumentException
- if the instance name of the config is null or empty or if no config file can be located.
-
System property: Hazelcast will first check if "hazelcast.config" system property is set to a file or a
-
getAllHazelcastInstances
Returns all active/running HazelcastInstances on this JVM.To shutdown all running HazelcastInstances (all members on this JVM) call
shutdownAll()
.- Returns:
- all active/running HazelcastInstances on this JVM
- See Also:
newHazelcastInstance(Config)
,getHazelcastInstanceByName(String)
,shutdownAll()
-
setOutOfMemoryHandler
SetsOutOfMemoryHandler
to be used when anOutOfMemoryError
is caught by Hazelcast threads.Warning:
OutOfMemoryHandler
may not be called although JVM throwsOutOfMemoryError
. Because error may be thrown from an external (user thread) thread and Hazelcast may not be informed aboutOutOfMemoryError
.- Parameters:
outOfMemoryHandler
- set when anOutOfMemoryError
is caught by Hazelcast threads- See Also:
OutOfMemoryError
,OutOfMemoryHandler
-