/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.ignite.internal;
import java.util.List;
import java.util.Map;
import java.util.UUID;
import java.util.concurrent.ExecutorService;
import org.apache.ignite.IgniteLogger;
import org.apache.ignite.configuration.IgniteConfiguration;
import org.apache.ignite.internal.managers.checkpoint.GridCheckpointManager;
import org.apache.ignite.internal.managers.collision.GridCollisionManager;
import org.apache.ignite.internal.managers.communication.GridIoManager;
import org.apache.ignite.internal.managers.deployment.GridDeploymentManager;
import org.apache.ignite.internal.managers.discovery.GridDiscoveryManager;
import org.apache.ignite.internal.managers.eventstorage.GridEventStorageManager;
import org.apache.ignite.internal.managers.failover.GridFailoverManager;
import org.apache.ignite.internal.managers.indexing.GridIndexingManager;
import org.apache.ignite.internal.managers.loadbalancer.GridLoadBalancerManager;
import org.apache.ignite.internal.processors.affinity.GridAffinityProcessor;
import org.apache.ignite.internal.processors.cache.GridCacheProcessor;
import org.apache.ignite.internal.processors.cacheobject.IgniteCacheObjectProcessor;
import org.apache.ignite.internal.processors.closure.GridClosureProcessor;
import org.apache.ignite.internal.processors.cluster.ClusterProcessor;
import org.apache.ignite.internal.processors.cluster.GridClusterStateProcessor;
import org.apache.ignite.internal.processors.continuous.GridContinuousProcessor;
import org.apache.ignite.internal.processors.datastreamer.DataStreamProcessor;
import org.apache.ignite.internal.processors.datastructures.DataStructuresProcessor;
import org.apache.ignite.internal.processors.hadoop.HadoopProcessorAdapter;
import org.apache.ignite.internal.processors.hadoop.HadoopHelper;
import org.apache.ignite.internal.processors.igfs.IgfsHelper;
import org.apache.ignite.internal.processors.igfs.IgfsProcessorAdapter;
import org.apache.ignite.internal.processors.job.GridJobProcessor;
import org.apache.ignite.internal.processors.jobmetrics.GridJobMetricsProcessor;
import org.apache.ignite.internal.processors.marshaller.GridMarshallerMappingProcessor;
import org.apache.ignite.internal.processors.odbc.OdbcProcessor;
import org.apache.ignite.internal.processors.platform.PlatformProcessor;
import org.apache.ignite.internal.processors.plugin.IgnitePluginProcessor;
import org.apache.ignite.internal.processors.pool.PoolProcessor;
import org.apache.ignite.internal.processors.port.GridPortProcessor;
import org.apache.ignite.internal.processors.query.GridQueryProcessor;
import org.apache.ignite.internal.processors.resource.GridResourceProcessor;
import org.apache.ignite.internal.processors.rest.GridRestProcessor;
import org.apache.ignite.internal.processors.schedule.IgniteScheduleProcessorAdapter;
import org.apache.ignite.internal.processors.security.GridSecurityProcessor;
import org.apache.ignite.internal.processors.segmentation.GridSegmentationProcessor;
import org.apache.ignite.internal.processors.service.GridServiceProcessor;
import org.apache.ignite.internal.processors.session.GridTaskSessionProcessor;
import org.apache.ignite.internal.processors.task.GridTaskProcessor;
import org.apache.ignite.internal.processors.timeout.GridTimeoutProcessor;
import org.apache.ignite.internal.suggestions.GridPerformanceSuggestions;
import org.apache.ignite.internal.util.IgniteExceptionRegistry;
import org.apache.ignite.internal.util.StripedExecutor;
import org.apache.ignite.internal.util.tostring.GridToStringExclude;
import org.apache.ignite.plugin.PluginNotFoundException;
import org.apache.ignite.plugin.PluginProvider;
import org.apache.ignite.thread.IgniteStripedThreadPoolExecutor;
import org.jetbrains.annotations.Nullable;
/**
*
*/
@GridToStringExclude
public interface GridKernalContext extends Iterable<GridComponent> {
/**
* Gets list of all grid components in the order they were added.
*
* @return List of all grid components in the order they were added.
*/
public List<GridComponent> components();
/**
* Gets local node ID.
*
* @return Local node ID.
*/
public UUID localNodeId();
/**
* Gets Ignite instance name.
*
* @return Ignite instance name.
*/
public String igniteInstanceName();
/**
* Gets logger for given category.
*
* @param ctgr Category.
* @return Logger.
*/
public IgniteLogger log(String ctgr);
/**
* Gets logger for given class.
*
* @param cls Class to get logger for.
* @return Logger.
*/
public IgniteLogger log(Class<?> cls);
/**
* @return {@code True} if grid is in the process of stopping.
*/
public boolean isStopping();
/**
* Gets kernal gateway.
*
* @return Kernal gateway.
*/
public GridKernalGateway gateway();
/**
* Gets grid instance managed by kernal.
*
* @return Grid instance.
*/
public IgniteEx grid();
/**
* Gets grid configuration.
*
* @return Grid configuration.
*/
public IgniteConfiguration config();
/**
* Gets task processor.
*
* @return Task processor.
*/
public GridTaskProcessor task();
/**
* Gets cache data affinity processor.
*
* @return Cache data affinity processor.
*/
public GridAffinityProcessor affinity();
/**
* Gets job processor.
*
* @return Job processor
*/
public GridJobProcessor job();
/**
* Gets timeout processor.
*
* @return Timeout processor.
*/
public GridTimeoutProcessor timeout();
/**
* Gets resource processor.
*
* @return Resource processor.
*/
public GridResourceProcessor resource();
/**
* Gets job metric processor.
*
* @return Metrics processor.
*/
public GridJobMetricsProcessor jobMetric();
/**
* Gets caches processor.
*
* @return Cache processor.
*/
public GridCacheProcessor cache();
/**
* Gets cluster state processor.
*
* @return Cluster state processor.
*/
public GridClusterStateProcessor state();
/**
* Gets task session processor.
*
* @return Session processor.
*/
public GridTaskSessionProcessor session();
/**
* Gets closure processor.
*
* @return Closure processor.
*/
public GridClosureProcessor closure();
/**
* Gets service processor.
*
* @return Service processor.
*/
public GridServiceProcessor service();
/**
* Gets port processor.
*
* @return Port processor.
*/
public GridPortProcessor ports();
/**
* Gets schedule processor.
*
* @return Schedule processor.
*/
public IgniteScheduleProcessorAdapter schedule();
/**
* Gets REST processor.
*
* @return REST processor.
*/
public GridRestProcessor rest();
/**
* Gets segmentation processor.
*
* @return Segmentation processor.
*/
public GridSegmentationProcessor segmentation();
/**
* Gets data streamer processor.
*
* @return Data streamer processor.
*/
public <K, V> DataStreamProcessor<K, V> dataStream();
/**
* Gets file system processor.
*
* @return File system processor.
*/
public IgfsProcessorAdapter igfs();
/**
* Gets IGFS utils processor.
*
* @return IGFS utils processor.
*/
public IgfsHelper igfsHelper();
/**
* Gets event continuous processor.
*
* @return Event continuous processor.
*/
public GridContinuousProcessor continuous();
/**
* Gets Hadoop processor.
*
* @return Hadoop processor.
*/
public HadoopProcessorAdapter hadoop();
/**
* Gets pool processor.
*
* @return Pool processor.
*/
public PoolProcessor pools();
/**
* Gets grid marshaller mapping processor.
*
* @return Mapping processor.
*/
public GridMarshallerMappingProcessor mapping();
/**
* Gets Hadoop helper.
*
* @return Hadoop helper.
*/
public HadoopHelper hadoopHelper();
/**
* Gets utility cache pool.
*
* @return Utility cache pool.
*/
public ExecutorService utilityCachePool();
/**
* Gets async callback pool.
*
* @return Async callback pool.
*/
public IgniteStripedThreadPoolExecutor asyncCallbackPool();
/**
* Gets cache object processor.
*
* @return Cache object processor.
*/
public IgniteCacheObjectProcessor cacheObjects();
/**
* Gets query processor.
*
* @return Query processor.
*/
public GridQueryProcessor query();
/**
* Gets ODBC processor.
*
* @return ODBC processor.
*/
public OdbcProcessor odbc();
/**
* @return Plugin processor.
*/
public IgnitePluginProcessor plugins();
/**
* Gets deployment manager.
*
* @return Deployment manager.
*/
public GridDeploymentManager deploy();
/**
* Gets communication manager.
*
* @return Communication manager.
*/
public GridIoManager io();
/**
* Gets discovery manager.
*
* @return Discovery manager.
*/
public GridDiscoveryManager discovery();
/**
* Gets checkpoint manager.
*
* @return Checkpoint manager.
*/
public GridCheckpointManager checkpoint();
/**
* Gets event storage manager.
*
* @return Event storage manager.
*/
public GridEventStorageManager event();
/**
* Gets failover manager.
*
* @return Failover manager.
*/
public GridFailoverManager failover();
/**
* Gets collision manager.
*
* @return Collision manager.
*/
public GridCollisionManager collision();
/**
* Gets authentication processor.
*
* @return Authentication processor.
*/
public GridSecurityProcessor security();
/**
* Gets load balancing manager.
*
* @return Load balancing manager.
*/
public GridLoadBalancerManager loadBalancing();
/**
* Gets indexing manager.
*
* @return Indexing manager.
*/
public GridIndexingManager indexing();
/**
* Gets data structures processor.
*
* @return Data structures processor.
*/
public DataStructuresProcessor dataStructures();
/**
* Sets segmented flag to {@code true} when node is stopped due to segmentation issues.
*/
public void markSegmented();
/**
* Gets segmented flag.
*
* @return {@code True} if network is currently segmented, {@code false} otherwise.
*/
public boolean segmented();
/**
* Print grid kernal memory stats (sizes of internal structures, etc.).
*
* NOTE: This method is for testing and profiling purposes only.
*/
public void printMemoryStats();
/**
* Checks whether this node is daemon.
*
* @return {@code True} if this node is daemon, {@code false} otherwise.
*/
public boolean isDaemon();
/**
* @return Performance suggestions object.
*/
public GridPerformanceSuggestions performance();
/**
* Gets user version for given class loader by checking
* {@code META-INF/ignite.xml} file for {@code userVersion} attribute. If
* {@code ignite.xml} file is not found, or user version is not specified there,
* then default version (empty string) is returned.
*
* @param ldr Class loader.
* @return User version for given class loader or empty string if no version
* was explicitly specified.
*/
public String userVersion(ClassLoader ldr);
/**
* @param name Plugin name.
* @return Plugin provider instance.
* @throws PluginNotFoundException If plugin provider for the given name was not found.
*/
public PluginProvider pluginProvider(String name) throws PluginNotFoundException;
/**
* Creates optional component.
*
* @param cls Component class.
* @return Created component.
*/
public <T> T createComponent(Class<T> cls);
/**
* @return Thread pool implementation to be used in grid to process job execution
* requests and user messages sent to the node.
*/
public ExecutorService getExecutorService();
/**
* Executor service that is in charge of processing service proxy invocations.
*
* @return Thread pool implementation to be used in grid for service proxy invocations.
*/
public ExecutorService getServiceExecutorService();
/**
* Executor service that is in charge of processing internal system messages.
*
* @return Thread pool implementation to be used in grid for internal system messages.
*/
public ExecutorService getSystemExecutorService();
/**
* Executor service that is in charge of processing internal system messages
* in stripes (dedicated threads).
*
* @return Thread pool implementation to be used in grid for internal system messages.
*/
public StripedExecutor getStripedExecutorService();
/**
* Executor service that is in charge of processing internal and Visor
* {@link org.apache.ignite.compute.ComputeJob GridJobs}.
*
* @return Thread pool implementation to be used in grid for internal and Visor
* jobs processing.
*/
public ExecutorService getManagementExecutorService();
/**
* @return Thread pool implementation to be used for peer class loading
* requests handling.
*/
public ExecutorService getPeerClassLoadingExecutorService();
/**
* Executor service that is in charge of processing outgoing IGFS messages.
*
* @return Thread pool implementation to be used for IGFS outgoing message sending.
*/
public ExecutorService getIgfsExecutorService();
/**
* Executor service that is in charge of processing data stream messages.
*
* @return Thread pool implementation to be used for data stream messages.
*/
public ExecutorService getDataStreamerExecutorService();
/**
* Should return an instance of fully configured thread pool to be used for
* processing of client messages (REST requests).
*
* @return Thread pool implementation to be used for processing of client
* messages.
*/
public ExecutorService getRestExecutorService();
/**
* Get affinity executor service.
*
* @return Affinity executor service.
*/
public ExecutorService getAffinityExecutorService();
/**
* Get indexing executor service.
*
* @return Indexing executor service.
*/
@Nullable public ExecutorService getIndexingExecutorService();
/**
* Executor service that is in charge of processing query messages.
*
* @return Thread pool implementation to be used in grid for query messages.
*/
public ExecutorService getQueryExecutorService();
/**
* Executor services that is in charge of processing user compute task.
*
* @return Map of custom thread pool executors.
*/
@Nullable public Map<String, ? extends ExecutorService> customExecutors();
/**
* Executor service that is in charge of processing schema change messages.
*
* @return Executor service that is in charge of processing schema change messages.
*/
public ExecutorService getSchemaExecutorService();
/**
* Gets exception registry.
*
* @return Exception registry.
*/
public IgniteExceptionRegistry exceptionRegistry();
/**
* Get node attribute by name.
*
* @param key Attribute name.
* @return Attribute value.
*/
public Object nodeAttribute(String key);
/**
* Check if node has specified attribute.
*
* @param key Attribute name.
* @return {@code true} If node has attribute with specified name.
*/
public boolean hasNodeAttribute(String key);
/**
* Add attribute to node attributes.
*
* @param key Attribute name.
* @param val Attribute value.
* @return Previous attribute value associated with attribute name.
*/
public Object addNodeAttribute(String key, Object val);
/**
* @return Node attributes.
*/
public Map<String, Object> nodeAttributes();
/**
* Gets Cluster processor.
*
* @return Cluster processor.
*/
public ClusterProcessor cluster();
/**
* Gets marshaller context.
*
* @return Marshaller context.
*/
public MarshallerContextImpl marshallerContext();
/**
* @return {@code True} if local node is client node (has flag {@link IgniteConfiguration#isClientMode()} set).
*/
public boolean clientNode();
/**
* @return {@code True} if local node in disconnected state.
*/
public boolean clientDisconnected();
/**
* @return Platform processor.
*/
public PlatformProcessor platform();
}