public final class Hazelcast extends Object
HazelcastInstance
's, a node in a cluster.Modifier and Type | Method and 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 a
classpath:... 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)
Sets
OutOfMemoryHandler to be used when an OutOfMemoryError
is caught by Hazelcast threads. |
static void |
shutdownAll()
Shuts down all member
HazelcastInstance s running on this JVM. |
public static void shutdownAll()
HazelcastInstance
s running on this JVM.
It doesn't shutdown all members of the cluster but just the ones running on this JVM.newHazelcastInstance(Config)
public static HazelcastInstance newHazelcastInstance(Config config)
To shutdown all running HazelcastInstances (all members on this JVM)
call shutdownAll()
.
config
- Configuration for the new HazelcastInstance (member)shutdownAll()
,
getHazelcastInstanceByName(String)
public static HazelcastInstance newHazelcastInstance()
To shutdown all running HazelcastInstances (all members on this JVM)
call shutdownAll()
.
Hazelcast will look into two places for the configuration file:
classpath:...
path.
Examples: -Dhazelcast.config=C:/myhazelcast.xml , -Dhazelcast.config=classpath:the-hazelcast-config.xml ,
-Dhazelcast.config=classpath:com/mydomain/hazelcast.xml
shutdownAll()
,
getHazelcastInstanceByName(String)
public static HazelcastInstance getHazelcastInstanceByName(String instanceName)
To shutdown all running HazelcastInstances (all members on this JVM)
call shutdownAll()
.
instanceName
- Name of the HazelcastInstance (member)newHazelcastInstance(Config)
,
shutdownAll()
public static HazelcastInstance getOrCreateHazelcastInstance()
classpath:...
path.
Examples: -Dhazelcast.config=C:/myhazelcast.xml , -Dhazelcast.config=classpath:the-hazelcast-config.xml ,
-Dhazelcast.config=classpath:com/mydomain/hazelcast.xml
IllegalArgumentException
will be thrown.
If a Hazelcast instance with the same name as the configuration exists, then it is returned, otherwise it is created.IllegalArgumentException
- if the instance name of the config is null or empty or if no config file can be
located.public static HazelcastInstance getOrCreateHazelcastInstance(Config config)
config
is null
, then an XML configuration file is looked up in the following order:
classpath:...
path.
Examples: -Dhazelcast.config=C:/myhazelcast.xml , -Dhazelcast.config=classpath:the-hazelcast-config.xml ,
-Dhazelcast.config=classpath:com/mydomain/hazelcast.xml
config
- the Config.IllegalArgumentException
- if the instance name of the config is null or empty or if no config file can be
located.public static Set<HazelcastInstance> getAllHazelcastInstances()
To shutdown all running HazelcastInstances (all members on this JVM)
call shutdownAll()
.
newHazelcastInstance(Config)
,
getHazelcastInstanceByName(String)
,
shutdownAll()
public static void setOutOfMemoryHandler(OutOfMemoryHandler outOfMemoryHandler)
OutOfMemoryHandler
to be used when an OutOfMemoryError
is caught by Hazelcast threads.
Warning: OutOfMemoryHandler
may not be called although JVM throws
OutOfMemoryError
.
Because error may be thrown from an external (user thread) thread
and Hazelcast may not be informed about OutOfMemoryError
.
outOfMemoryHandler
- set when an OutOfMemoryError
is caught by Hazelcast threadsOutOfMemoryError
,
OutOfMemoryHandler
Copyright © 2021 Hazelcast, Inc.. All rights reserved.