| Package | Description | 
|---|---|
| com.hazelcast.cache | 
     This package contains the public API extension for Hazelcast JCache,
     the Hazelcast implementation of the JSR-107 commonly referred to as JCache. | 
| com.hazelcast.client | Contains classes/interfaces related to Client | 
| com.hazelcast.console | This package contains classes related to ConsoleApp | 
| com.hazelcast.core | Provides core API interfaces/classes. | 
| com.hazelcast.jet | Hazelcast Jet is a distributed computation engine running on top of
 Hazelcast IMDG technology. | 
| com.hazelcast.jet.core | Jet's Core API. | 
| com.hazelcast.jet.core.test | Utilities for writing tests of Core API Processors. | 
| com.hazelcast.map | Contains Hazelcast map module classes. | 
| com.hazelcast.mapstore | Implementation of  MapStoreinterface based on Hazelcast SQL engine | 
| com.hazelcast.osgi | This package contains the OSGI functionality contract points for Hazelcast. | 
| com.hazelcast.security | Provides interfaces/classes for Hazelcast security implementation. | 
| com.hazelcast.spring.cache | Contains Hazelcast cache classes related to Spring. | 
| com.hazelcast.spring.transaction | Contains Hazelcast transaction classes for Spring Transaction API. | 
| Modifier and Type | Method and Description | 
|---|---|
| HazelcastInstance | HazelcastCacheManager. getHazelcastInstance()Gets the underlying  HazelcastInstanceimplementation. | 
| Modifier and Type | Method and Description | 
|---|---|
| static Properties | HazelcastCachingProvider. propertiesByInstanceItself(HazelcastInstance instance)Create the  Propertieswith the provided instance itself. | 
| Modifier and Type | Method and Description | 
|---|---|
| static HazelcastInstance | HazelcastClient. getHazelcastClientByName(String instanceName)Returns an existing HazelcastClient with instanceName. | 
| static HazelcastInstance | HazelcastClient. getOrCreateHazelcastClient()Gets or creates a new HazelcastInstance (a new client in a cluster) with the default XML configuration looked up in:
 
     
         System property: Hazelcast will first check if "hazelcast.client.config" system property is set to a file or a
          classpath:...path. | 
| static HazelcastInstance | HazelcastClient. getOrCreateHazelcastClient(ClientConfig config)Gets or creates a new HazelcastInstance (a new client in a cluster) with a certain name. | 
| static HazelcastInstance | HazelcastClient. newHazelcastClient()Creates a new HazelcastInstance (a new client in a cluster). | 
| static HazelcastInstance | HazelcastClient. newHazelcastClient(ClientConfig config)Creates a new HazelcastInstance (a new client in a cluster). | 
| static HazelcastInstance | HazelcastClient. newHazelcastFailoverClient()Creates a client with cluster switch capability. | 
| static HazelcastInstance | HazelcastClient. newHazelcastFailoverClient(ClientFailoverConfig clientFailoverConfig)Creates a client with cluster switch capability. | 
| Modifier and Type | Method and Description | 
|---|---|
| static Collection<HazelcastInstance> | HazelcastClient. getAllHazelcastClients()Gets an immutable collection of all client HazelcastInstances created in this JVM. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | ClientOutOfMemoryHandler. onOutOfMemory(OutOfMemoryError oome,
             HazelcastInstance[] hazelcastInstances) | 
| static void | HazelcastClient. shutdown(HazelcastInstance instance)Shutdown the provided client and remove it from the managed list | 
| Modifier and Type | Method and Description | 
|---|---|
| void | SimulateLoadTask. setHazelcastInstance(HazelcastInstance hazelcastInstance) | 
| void | Echo. setHazelcastInstance(HazelcastInstance hazelcastInstance) | 
| Constructor and Description | 
|---|
| ConsoleApp(HazelcastInstance hazelcast,
          PrintStream outOrig) | 
| Modifier and Type | Method and Description | 
|---|---|
| static HazelcastInstance | Hazelcast. bootstrappedInstance()Returns either a local Hazelcast instance or a "bootstrapped" Hazelcast
 client for a remote Hazelcast cluster, depending on the context. | 
| static HazelcastInstance | Hazelcast. getHazelcastInstanceByName(String instanceName)Returns an existing HazelcastInstance with instanceName. | 
| static HazelcastInstance | Hazelcast. 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 | Hazelcast. getOrCreateHazelcastInstance(Config config)Gets or creates the HazelcastInstance with a certain name. | 
| static HazelcastInstance | Hazelcast. newHazelcastInstance()Creates a new HazelcastInstance (a new node in a cluster). | 
| static HazelcastInstance | Hazelcast. newHazelcastInstance(Config config)Creates a new HazelcastInstance (a new node in a cluster). | 
| Modifier and Type | Method and Description | 
|---|---|
| static Set<HazelcastInstance> | Hazelcast. getAllHazelcastInstances()Returns all active/running HazelcastInstances on this JVM. | 
| Modifier and Type | Method and Description | 
|---|---|
| abstract void | OutOfMemoryHandler. onOutOfMemory(OutOfMemoryError oome,
             HazelcastInstance[] hazelcastInstances)When an  OutOfMemoryErroris caught by Hazelcast threads,
 this method is called for ALLHazelcastInstances
 knows by current JVM (actually ClassLoader). | 
| void | HazelcastInstanceAware. setHazelcastInstance(HazelcastInstance hazelcastInstance)Gets the HazelcastInstance reference when submitting a Runnable/Callable using Hazelcast ExecutorService. | 
| protected void | OutOfMemoryHandler. tryCloseConnections(HazelcastInstance hazelcastInstance)Tries to close the server socket and connections to other  HazelcastInstances. | 
| protected void | OutOfMemoryHandler. tryShutdown(HazelcastInstance hazelcastInstance)Tries to shutdown  HazelcastInstanceforcefully;
 including closing sockets and connections, stopping threads, etc. | 
| Modifier and Type | Method and Description | 
|---|---|
| HazelcastInstance | JetInstance. getHazelcastInstance()Deprecated. 
 since 5.0
 Because we first access to  HazelcastInstanceand thenJetServicefrom the product's entry point -Hazelcast-,
 we don't need to this back reference anymore. This class made
 sense when the entry point wasJet. | 
| Constructor and Description | 
|---|
| JobStateSnapshot(HazelcastInstance instance,
                String name,
                com.hazelcast.jet.impl.SnapshotValidationRecord record)This constructor is a private API, use  JetService.getJobStateSnapshot(String)instead. | 
| Modifier and Type | Method and Description | 
|---|---|
| HazelcastInstance | ProcessorMetaSupplier.Context. hazelcastInstance()Returns the current Hazelcast instance. | 
| Modifier and Type | Method and Description | 
|---|---|
| HazelcastInstance | TestProcessorMetaSupplierContext. hazelcastInstance() | 
| Modifier and Type | Method and Description | 
|---|---|
| TestSupport | TestSupport. hazelcastInstance(HazelcastInstance hazelcastInstance)Use the given instance for  ProcessorMetaSupplier.Context.hazelcastInstance() | 
| TestProcessorSupplierContext | TestProcessorSupplierContext. setHazelcastInstance(HazelcastInstance instance) | 
| TestProcessorContext | TestProcessorContext. setHazelcastInstance(HazelcastInstance instance) | 
| TestProcessorMetaSupplierContext | TestProcessorMetaSupplierContext. setHazelcastInstance(HazelcastInstance instance)Sets the Hazelcast instance. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | MapLoaderLifecycleSupport. init(HazelcastInstance hazelcastInstance,
    Properties properties,
    String mapName)Initializes this MapLoader implementation. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | GenericMapStore. init(HazelcastInstance instance,
    Properties properties,
    String mapName) | 
| Modifier and Type | Interface and Description | 
|---|---|
| interface  | HazelcastOSGiInstanceContract point for  HazelcastInstanceimplementations based on OSGi service. | 
| Modifier and Type | Method and Description | 
|---|---|
| HazelcastInstance | HazelcastOSGiInstance. getDelegatedInstance()Gets the delegated (underlying)  HazelcastInstance. | 
| Modifier and Type | Method and Description | 
|---|---|
| HazelcastInstance | HazelcastInstanceCallback. getHazelcastInstance() | 
| Modifier and Type | Method and Description | 
|---|---|
| void | HazelcastInstanceCallback. setHazelcastInstance(HazelcastInstance hazelcastInstance) | 
| Modifier and Type | Method and Description | 
|---|---|
| HazelcastInstance | HazelcastCacheManager. getHazelcastInstance() | 
| Modifier and Type | Method and Description | 
|---|---|
| static javax.cache.CacheManager | SpringHazelcastCachingProvider. getCacheManager(HazelcastInstance instance,
               String uriString,
               Properties props)Creates a  CacheManageron an existing HazelcastInstance. | 
| void | HazelcastCacheManager. setHazelcastInstance(HazelcastInstance hazelcastInstance) | 
| Constructor and Description | 
|---|
| HazelcastCacheManager(HazelcastInstance hazelcastInstance) | 
| Modifier and Type | Method and Description | 
|---|---|
| static TransactionContext | HazelcastTransactionManager. getTransactionContext(HazelcastInstance hazelcastInstance)Returns the transaction context for the given Hazelcast instance bounded to the current thread. | 
| Constructor and Description | 
|---|
| HazelcastTransactionManager(HazelcastInstance hazelcastInstance) | 
Copyright © 2023 Hazelcast, Inc.. All rights reserved.