## Uses of Class
org.apache.ignite.configuration.IgniteConfiguration

- Packages that use IgniteConfiguration
  Package | Description
  --- | ---
  org.apache.ignite | Contains entry-point Ignite & HPC APIs.
  org.apache.ignite.configuration | Contains configuration-related classes.
  org.apache.ignite.dump |
  org.apache.ignite.plugin | Contains plugins management API.
  org.apache.ignite.startup | Contains Ignite runtime startup classes.

- - ### Uses of IgniteConfiguration in org.apache.ignite

    Methods in org.apache.ignite that return IgniteConfiguration
    Modifier and Type | Method | Description
    --- | --- | ---
    `IgniteConfiguration` | Ignite.`configuration()` | Gets the configuration of this Ignite instance.
    `IgniteConfiguration` | IgniteSpringBean.`configuration()` | Gets the configuration of this Ignite instance.
    `IgniteConfiguration` | IgniteSpringBean.`getConfiguration()` | Gets the configuration of this Ignite instance.

    Methods in org.apache.ignite with parameters of type IgniteConfiguration
    Modifier and Type | Method | Description
    --- | --- | ---
    `static Ignite` | Ignition.`getOrStart​(IgniteConfiguration cfg)` | Gets or starts new grid instance if it hasn't been started yet.
    `void` | IgniteSpringBean.`setConfiguration​(IgniteConfiguration cfg)` | Sets Ignite configuration.
    `static Ignite` | IgniteSpring.`start​(IgniteConfiguration cfg, @Nullable org.springframework.context.ApplicationContext springCtx)` | Starts grid with given configuration.
    `static Ignite` | Ignition.`start​(IgniteConfiguration cfg)` | Starts grid with given configuration.

  - ### Uses of IgniteConfiguration in org.apache.ignite.configuration

    Methods in org.apache.ignite.configuration that return IgniteConfiguration
    Modifier and Type | Method | Description
    --- | --- | ---
    `IgniteConfiguration` | IgniteConfiguration.`setActiveOnStart​(boolean activeOnStart)` | Deprecated. Use `setClusterStateOnStart(ClusterState)` instead.
    `IgniteConfiguration` | IgniteConfiguration.`setAddressResolver​(AddressResolver addrRslvr)` | Sets address resolver for addresses mapping determination.
    `IgniteConfiguration` | IgniteConfiguration.`setAllSegmentationResolversPassRequired​(boolean allResolversPassReq)` | Sets all segmentation resolvers pass required flag.
    `IgniteConfiguration` | IgniteConfiguration.`setAsyncCallbackPoolSize​(int poolSize)` | Sets async callback thread pool size to use within grid.
    `IgniteConfiguration` | IgniteConfiguration.`setAsyncContinuationExecutor​(Executor asyncContinuationExecutor)` | Sets the continuation executor for cache async APIs.
    `IgniteConfiguration` | IgniteConfiguration.`setAtomicConfiguration​(AtomicConfiguration atomicCfg)` |
    `IgniteConfiguration` | IgniteConfiguration.`setAuthenticationEnabled​(boolean authEnabled)` | Sets flag indicating whether the user authentication is enabled for cluster.
    `IgniteConfiguration` | IgniteConfiguration.`setAutoActivationEnabled​(boolean autoActivation)` | Deprecated. Use `setClusterStateOnStart(ClusterState)` instead.
    `IgniteConfiguration` | IgniteConfiguration.`setBinaryConfiguration​(BinaryConfiguration binaryCfg)` | Sets configuration for Ignite Binary objects.
    `IgniteConfiguration` | IgniteConfiguration.`setBuildIndexThreadPoolSize​(int poolSize)` | Sets index create/rebuild thread pool size to use within grid.
    `IgniteConfiguration` | IgniteConfiguration.`setCacheConfiguration​(CacheConfiguration... cacheCfg)` | Sets cache configurations.
    `IgniteConfiguration` | IgniteConfiguration.`setCacheKeyConfiguration​(CacheKeyConfiguration... cacheKeyCfg)` | Sets cache key configuration.
    `IgniteConfiguration` | IgniteConfiguration.`setCacheSanityCheckEnabled​(boolean cacheSanityCheckEnabled)` | Sets cache sanity check flag.
    `IgniteConfiguration` | IgniteConfiguration.`setCacheStoreSessionListenerFactories​(javax.cache.configuration.Factory<CacheStoreSessionListener>... storeSesLsnrs)` | Cache store session listener factories.
    `IgniteConfiguration` | IgniteConfiguration.`setCheckpointSpi​(CheckpointSpi... cpSpi)` | Sets fully configured instance of `CheckpointSpi`.
    `IgniteConfiguration` | IgniteConfiguration.`setClassLoader​(ClassLoader classLdr)` | Sets loader which will be used for instantiating execution context (`EntryProcessors`, `CacheEntryListeners`, `CacheLoaders` and `ExpiryPolicys`).
    `IgniteConfiguration` | IgniteConfiguration.`setClientConnectorConfiguration​(@Nullable ClientConnectorConfiguration cliConnCfg)` | Sets client connector configuration.
    `IgniteConfiguration` | IgniteConfiguration.`setClientFailureDetectionTimeout​(long clientFailureDetectionTimeout)` | Sets failure detection timeout to use in `TcpDiscoverySpi` and `TcpCommunicationSpi`.
    `IgniteConfiguration` | IgniteConfiguration.`setClientMode​(boolean clientMode)` | Sets client mode flag.
    `IgniteConfiguration` | IgniteConfiguration.`setClusterStateOnStart​(ClusterState state)` | Sets state of cluster on start.
    `IgniteConfiguration` | IgniteConfiguration.`setCollisionSpi​(CollisionSpi colSpi)` | Sets fully configured instance of `CollisionSpi`.
    `IgniteConfiguration` | IgniteConfiguration.`setCommunicationFailureResolver​(CommunicationFailureResolver commFailureRslvr)` |
    `IgniteConfiguration` | IgniteConfiguration.`setCommunicationSpi​(CommunicationSpi commSpi)` | Sets fully configured instance of `CommunicationSpi`.
    `IgniteConfiguration` | IgniteConfiguration.`setConnectorConfiguration​(ConnectorConfiguration connectorCfg)` |
    `IgniteConfiguration` | IgniteConfiguration.`setConsistentId​(Serializable consistentId)` | Sets consistent globally unique node ID which survives node restarts.
    `IgniteConfiguration` | IgniteConfiguration.`setDataStorageConfiguration​(DataStorageConfiguration dsCfg)` | Sets durable memory configuration.
    `IgniteConfiguration` | IgniteConfiguration.`setDataStreamerThreadPoolSize​(int poolSize)` | Set thread pool size that will be used to process data stream messages.
    `IgniteConfiguration` | IgniteConfiguration.`setDefaultQueryTimeout​(long dfltQryTimeout)` | Deprecated. Use `SqlConfiguration.setDefaultQueryTimeout(long)` instead.
    `IgniteConfiguration` | IgniteConfiguration.`setDeploymentMode​(DeploymentMode deployMode)` | Deprecated. Will be replaced with the IgniteClassPath in the next versions.
    `IgniteConfiguration` | IgniteConfiguration.`setDeploymentSpi​(DeploymentSpi deploySpi)` | Deprecated. Will be replaced with the IgniteClassPath in the next versions.
    `IgniteConfiguration` | IgniteConfiguration.`setDiscoverySpi​(DiscoverySpi discoSpi)` | Sets fully configured instance of `DiscoverySpi`.
    `IgniteConfiguration` | IgniteConfiguration.`setDiscoveryStartupDelay​(long discoStartupDelay)` | Deprecated. Not used any more.
    `IgniteConfiguration` | IgniteConfiguration.`setDistributedPropertiesDefaultValues​(Map<String,​String> distrProps)` | Sets default values for distributed properties.
    `IgniteConfiguration` | IgniteConfiguration.`setEncryptionSpi​(EncryptionSpi encryptionSpi)` | Sets fully configured instances of `EncryptionSpi`.
    `IgniteConfiguration` | IgniteConfiguration.`setEventStorageSpi​(EventStorageSpi evtSpi)` | Sets fully configured instance of `EventStorageSpi`.
    `IgniteConfiguration` | IgniteConfiguration.`setExecutorConfiguration​(ExecutorConfiguration... execCfgs)` | Sets custom executors for user compute tasks.
    `IgniteConfiguration` | IgniteConfiguration.`setFailoverSpi​(FailoverSpi... failSpi)` | Sets fully configured instance of `FailoverSpi`.
    `IgniteConfiguration` | IgniteConfiguration.`setFailureDetectionTimeout​(long failureDetectionTimeout)` | Sets failure detection timeout to use in `TcpDiscoverySpi` and `TcpCommunicationSpi`.
    `IgniteConfiguration` | IgniteConfiguration.`setFailureHandler​(FailureHandler failureHnd)` | Sets failure handler.
    `IgniteConfiguration` | IgniteConfiguration.`setGridLogger​(IgniteLogger log)` | Sets logger to use within grid.
    `IgniteConfiguration` | IgniteConfiguration.`setGridName​(String gridName)` | Deprecated. Use `setIgniteInstanceName(String)` instead.
    `IgniteConfiguration` | IgniteConfiguration.`setIgniteHome​(String igniteHome)` | Sets Ignite installation folder.
    `IgniteConfiguration` | IgniteConfiguration.`setIgniteInstanceName​(String instanceName)` | Sets of local instance name.
    `IgniteConfiguration` | IgniteConfiguration.`setIncludeEventTypes​(int... inclEvtTypes)` | Sets array of event types, which will be recorded by `GridEventStorageManager.record(Event)`.
    `IgniteConfiguration` | IgniteConfiguration.`setIncludeProperties​(String... includeProps)` | Sets array of system or environment property names to include into node attributes.
    `IgniteConfiguration` | IgniteConfiguration.`setIndexingSpi​(IndexingSpi indexingSpi)` | Sets fully configured instances of `IndexingSpi`.
    `IgniteConfiguration` | IgniteConfiguration.`setLateAffinityAssignment​(boolean lateAffAssignment)` | Deprecated. Starting from Ignite 2.1 late affinity assignment is always enabled.
    `IgniteConfiguration` | IgniteConfiguration.`setLifecycleBeans​(LifecycleBean... lifecycleBeans)` | Sets a collection of lifecycle beans.
    `IgniteConfiguration` | IgniteConfiguration.`setLoadBalancingSpi​(LoadBalancingSpi... loadBalancingSpi)` | Sets fully configured instance of `LoadBalancingSpi`.
    `IgniteConfiguration` | IgniteConfiguration.`setLocalEventListeners​(Map<IgnitePredicate<? extends Event>,​int[]> lsnrs)` | Sets map of pre-configured local event listeners.
    `IgniteConfiguration` | IgniteConfiguration.`setLocalHost​(String locHost)` | Sets system-wide local address or host for all Ignite components to bind to.
    `IgniteConfiguration` | IgniteConfiguration.`setLongQueryWarningTimeout​(long longQryWarnTimeout)` | Deprecated. Use `SqlConfiguration.setLongQueryWarningTimeout(long)` instead.
    `IgniteConfiguration` | IgniteConfiguration.`setManagementThreadPoolSize​(int poolSize)` | Sets management thread pool size to use within grid.
    `IgniteConfiguration` | IgniteConfiguration.`setMarshalLocalJobs​(boolean marshLocJobs)` | Sets marshal local jobs flag.
    `IgniteConfiguration` | IgniteConfiguration.`setMBeanServer​(MBeanServer mbeanSrv)` | Sets initialized and started MBean server.
    `IgniteConfiguration` | IgniteConfiguration.`setMemoryConfiguration​(MemoryConfiguration memCfg)` | Deprecated. Use `DataStorageConfiguration` instead.
    `IgniteConfiguration` | IgniteConfiguration.`setMetricExporterSpi​(MetricExporterSpi... metricExporterSpi)` | Sets fully configured instances of `MetricExporterSpi`.
    `IgniteConfiguration` | IgniteConfiguration.`setMetricsExpireTime​(long metricsExpTime)` | Sets time in milliseconds after which a certain metric value is considered expired.
    `IgniteConfiguration` | IgniteConfiguration.`setMetricsHistorySize​(int metricsHistSize)` | Sets number of metrics kept in history to compute totals and averages.
    `IgniteConfiguration` | IgniteConfiguration.`setMetricsLogFrequency​(long metricsLogFreq)` | Sets frequency of metrics log print out.
    `IgniteConfiguration` | IgniteConfiguration.`setMetricsUpdateFrequency​(long metricsUpdateFreq)` | Sets Ignite metrics update frequency in milliseconds.
    `IgniteConfiguration` | IgniteConfiguration.`setNetworkSendRetryCount​(int sndRetryCnt)` | Sets message send retries count.
    `IgniteConfiguration` | IgniteConfiguration.`setNetworkSendRetryDelay​(long sndRetryDelay)` | Sets interval in milliseconds between message send retries.
    `IgniteConfiguration` | IgniteConfiguration.`setNetworkTimeout​(long netTimeout)` | Maximum timeout in milliseconds for network requests.
    `IgniteConfiguration` | IgniteConfiguration.`setNodeId​(UUID nodeId)` | Deprecated. Use `setConsistentId(Serializable)` instead.
    `IgniteConfiguration` | IgniteConfiguration.`setOdbcConfiguration​(OdbcConfiguration odbcCfg)` | Deprecated. Use `setClientConnectorConfiguration(ClientConnectorConfiguration)` instead.
    `IgniteConfiguration` | IgniteConfiguration.`setPeerClassLoadingEnabled​(boolean p2pEnabled)` | Enables/disables peer class loading.
    `IgniteConfiguration` | IgniteConfiguration.`setPeerClassLoadingLocalClassPathExclude​(String... p2pLocClsPathExcl)` | Sets list of packages in a system class path that should be P2P loaded even if they exist locally.
    `IgniteConfiguration` | IgniteConfiguration.`setPeerClassLoadingMissedResourcesCacheSize​(int p2pMissedCacheSize)` | Sets size of missed resources cache.
    `IgniteConfiguration` | IgniteConfiguration.`setPeerClassLoadingThreadPoolSize​(int poolSize)` | Sets thread pool size to use for peer class loading.
    `IgniteConfiguration` | IgniteConfiguration.`setPersistentStoreConfiguration​(PersistentStoreConfiguration pstCfg)` | Deprecated. Part of old API.
    `IgniteConfiguration` | IgniteConfiguration.`setPlatformConfiguration​(PlatformConfiguration platformCfg)` | Sets platform configuration.
    `IgniteConfiguration` | IgniteConfiguration.`setPluginConfigurations​(PluginConfiguration... pluginCfgs)` | Deprecated. Since `PluginProvider`s can be set explicitly via `setPluginProviders(PluginProvider[])` it's preferable to store `PluginConfiguration` as a part of `PluginProvider`.
    `IgniteConfiguration` | IgniteConfiguration.`setPluginProviders​(PluginProvider... pluginProvs)` | Sets plugin providers.
    `IgniteConfiguration` | IgniteConfiguration.`setPublicThreadPoolSize​(int poolSize)` | Sets thread pool size to use within grid.
    `IgniteConfiguration` | IgniteConfiguration.`setQueryThreadPoolSize​(int poolSize)` | Sets query thread pool size to use within grid.
    `IgniteConfiguration` | IgniteConfiguration.`setRebalanceBatchesPrefetchCount​(long rebalanceBatchesCnt)` | The number of batches generated by supply node at rebalancing procedure start.
    `IgniteConfiguration` | IgniteConfiguration.`setRebalanceBatchSize​(int rebalanceBatchSize)` | The supply message size in bytes to be loaded within a single rebalance batch.
    `IgniteConfiguration` | IgniteConfiguration.`setRebalanceThreadPoolSize​(int rebalanceThreadPoolSize)` | Sets Max count of threads can be used at rebalancing.
    `IgniteConfiguration` | IgniteConfiguration.`setRebalanceThrottle​(long rebalanceThrottle)` | Time in milliseconds to wait between rebalance messages to avoid overloading of CPU or network.
    `IgniteConfiguration` | IgniteConfiguration.`setRebalanceTimeout​(long rebalanceTimeout)` | Rebalance timeout for supply and demand messages in milliseconds.
    `IgniteConfiguration` | IgniteConfiguration.`setSegmentationPolicy​(SegmentationPolicy segPlc)` | Sets segmentation policy.
    `IgniteConfiguration` | IgniteConfiguration.`setSegmentationResolveAttempts​(int segResolveAttempts)` | Sets segmentation resolve attempts count.
    `IgniteConfiguration` | IgniteConfiguration.`setSegmentationResolvers​(SegmentationResolver... segResolvers)` | Sets segmentation resolvers.
    `IgniteConfiguration` | IgniteConfiguration.`setSegmentCheckFrequency​(long segChkFreq)` | Sets network segment check frequency.
    `IgniteConfiguration` | IgniteConfiguration.`setServiceConfiguration​(ServiceConfiguration... svcCfgs)` | Sets configurations for services to be deployed on the grid.
    `IgniteConfiguration` | IgniteConfiguration.`setServiceThreadPoolSize​(int poolSize)` | Sets thread pool size to use within grid.
    `IgniteConfiguration` | IgniteConfiguration.`setShutdownPolicy​(ShutdownPolicy shutdownPolicy)` | Sets shutdown policy.
    `IgniteConfiguration` | IgniteConfiguration.`setSnapshotPath​(String snapshotPath)` |
    `IgniteConfiguration` | IgniteConfiguration.`setSnapshotThreadPoolSize​(int snapshotThreadPoolSize)` |
    `IgniteConfiguration` | IgniteConfiguration.`setSqlConfiguration​(SqlConfiguration sqlCfg)` |
    `IgniteConfiguration` | IgniteConfiguration.`setSqlConnectorConfiguration​(SqlConnectorConfiguration sqlConnCfg)` | Deprecated. Use `setClientConnectorConfiguration(ClientConnectorConfiguration)` instead.
    `IgniteConfiguration` | IgniteConfiguration.`setSqlQueryHistorySize​(int size)` | Deprecated. Use `SqlConfiguration.getSqlQueryHistorySize()` instead.
    `IgniteConfiguration` | IgniteConfiguration.`setSqlSchemas​(String... sqlSchemas)` | Deprecated. Use `SqlConfiguration.setSqlSchemas(String...)` instead.
    `IgniteConfiguration` | IgniteConfiguration.`setSslContextFactory​(javax.cache.configuration.Factory<SSLContext> sslCtxFactory)` | Sets SSL context factory that will be used for creating a secure socket layer.
    `IgniteConfiguration` | IgniteConfiguration.`setStripedPoolSize​(int stripedPoolSize)` | Sets striped pool size that should be used for cache requests processing.
    `IgniteConfiguration` | IgniteConfiguration.`setSystemThreadPoolSize​(int poolSize)` | Sets system thread pool size to use within grid.
    `IgniteConfiguration` | IgniteConfiguration.`setSystemViewExporterSpi​(SystemViewExporterSpi... sysViewExporterSpi)` | Sets fully configured instances of `SystemViewExporterSpi`.
    `IgniteConfiguration` | IgniteConfiguration.`setSystemWorkerBlockedTimeout​(long sysWorkerBlockedTimeout)` | Sets maximum inactivity period for system worker.
    `IgniteConfiguration` | IgniteConfiguration.`setTimeServerPortBase​(int timeSrvPortBase)` | Sets time server port base.
    `IgniteConfiguration` | IgniteConfiguration.`setTimeServerPortRange​(int timeSrvPortRange)` | Sets time server port range.
    `IgniteConfiguration` | IgniteConfiguration.`setTracingSpi​(TracingSpi tracingSpi)` | Set fully configured instance of `TracingSpi`.
    `IgniteConfiguration` | IgniteConfiguration.`setTransactionConfiguration​(TransactionConfiguration txCfg)` | Sets transactions configuration.
    `IgniteConfiguration` | IgniteConfiguration.`setUserAttributes​(Map<String,​?> userAttrs)` | Sets user attributes for this node.
    `IgniteConfiguration` | IgniteConfiguration.`setUtilityCacheKeepAliveTime​(long keepAliveTime)` | Sets keep alive time of thread pool size that will be used to process utility cache messages.
    `IgniteConfiguration` | IgniteConfiguration.`setUtilityCachePoolSize​(int poolSize)` | Sets default thread pool size that will be used to process utility cache messages.
    `IgniteConfiguration` | IgniteConfiguration.`setWaitForSegmentOnStart​(boolean waitForSegOnStart)` | Sets wait for segment on start flag.
    `IgniteConfiguration` | IgniteConfiguration.`setWarmupClosure​(IgniteInClosure<IgniteConfiguration> warmupClos)` | Sets warmup closure to execute before grid startup.
    `IgniteConfiguration` | IgniteConfiguration.`setWorkDirectory​(String igniteWorkDir)` | Sets Ignite work folder.

    Methods in org.apache.ignite.configuration that return types with arguments of type IgniteConfiguration
    Modifier and Type | Method | Description
    --- | --- | ---
    `IgniteInClosure<IgniteConfiguration>` | IgniteConfiguration.`getWarmupClosure()` | Gets grid warmup closure.

    Method parameters in org.apache.ignite.configuration with type arguments of type IgniteConfiguration
    Modifier and Type | Method | Description
    --- | --- | ---
    `IgniteConfiguration` | IgniteConfiguration.`setWarmupClosure​(IgniteInClosure<IgniteConfiguration> warmupClos)` | Sets warmup closure to execute before grid startup.

    Constructors in org.apache.ignite.configuration with parameters of type IgniteConfiguration
    Constructor | Description
    --- | ---
    `IgniteConfiguration​(IgniteConfiguration cfg)` | Creates grid configuration by coping all configuration properties from given configuration.

  - ### Uses of IgniteConfiguration in org.apache.ignite.dump

    Methods in org.apache.ignite.dump that return IgniteConfiguration
    Modifier and Type | Method | Description
    --- | --- | ---
    `@Nullable IgniteConfiguration` | DumpReaderConfiguration.`config()` |

    Constructors in org.apache.ignite.dump with parameters of type IgniteConfiguration
    Constructor | Description
    --- | ---
    `DumpReaderConfiguration​(@Nullable String name, @Nullable String path, @Nullable IgniteConfiguration cfg, DumpConsumer cnsmr, int thCnt, Duration timeout, boolean failFast, boolean keepBinary, boolean keepRaw, String[] grpNames, String[] cacheNames, boolean skipCopies, EncryptionSpi encSpi)` |
    `DumpReaderConfiguration​(String name, @Nullable String path, @Nullable IgniteConfiguration cfg, DumpConsumer cnsmr)` |

  - ### Uses of IgniteConfiguration in org.apache.ignite.plugin

    Methods in org.apache.ignite.plugin that return IgniteConfiguration
    Modifier and Type | Method | Description
    --- | --- | ---
    `IgniteConfiguration` | CachePluginContext.`igniteConfiguration()` |
    `IgniteConfiguration` | PluginContext.`igniteConfiguration()` |

  - ### Uses of IgniteConfiguration in org.apache.ignite.startup

    Methods in org.apache.ignite.startup with parameters of type IgniteConfiguration
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | BasicWarmupClosure.`apply​(IgniteConfiguration gridCfg)` | Closure body.