com.hazelcast.spi.impl.NodeEngine Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2021, Hazelcast, Inc. All Rights Reserved.
*
* Licensed 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 com.hazelcast.spi.impl;
import com.hazelcast.cluster.Cluster;
import com.hazelcast.cluster.Member;
import com.hazelcast.config.Config;
import com.hazelcast.core.HazelcastInstance;
import com.hazelcast.internal.cluster.ClusterService;
import com.hazelcast.internal.serialization.SerializationService;
import com.hazelcast.internal.services.ManagedService;
import com.hazelcast.logging.ILogger;
import com.hazelcast.cluster.Address;
import com.hazelcast.internal.serialization.Data;
import com.hazelcast.spi.annotation.PrivateApi;
import com.hazelcast.spi.impl.eventservice.EventService;
import com.hazelcast.spi.impl.executionservice.ExecutionService;
import com.hazelcast.spi.impl.operationservice.OperationService;
import com.hazelcast.spi.impl.proxyservice.ProxyService;
import com.hazelcast.spi.impl.tenantcontrol.impl.TenantControlServiceImpl;
import com.hazelcast.spi.merge.SplitBrainMergePolicyProvider;
import com.hazelcast.internal.partition.IPartitionService;
import com.hazelcast.spi.properties.HazelcastProperties;
import com.hazelcast.splitbrainprotection.SplitBrainProtectionService;
import com.hazelcast.sql.impl.SqlServiceImpl;
import com.hazelcast.transaction.TransactionManagerService;
import com.hazelcast.version.MemberVersion;
import com.hazelcast.wan.impl.WanReplicationService;
import javax.annotation.Nonnull;
import java.util.Collection;
/**
* The NodeEngine is the 'umbrella' of services/service-method that gets injected into a {@link ManagedService}.
*
* So if you are writing a custom SPI service, such as a stack-service, this service should probably implement
* the {@link ManagedService} so you can get access to the services within the system.
*/
@PrivateApi
public interface NodeEngine {
OperationService getOperationService();
ExecutionService getExecutionService();
ClusterService getClusterService();
IPartitionService getPartitionService();
EventService getEventService();
SerializationService getSerializationService();
ProxyService getProxyService();
/**
* Returns the tenant control service.
*/
TenantControlServiceImpl getTenantControlService();
WanReplicationService getWanReplicationService();
SplitBrainProtectionService getSplitBrainProtectionService();
SqlServiceImpl getSqlService();
/**
* Gets the TransactionManagerService.
*
* @return the TransactionManagerService
*/
TransactionManagerService getTransactionManagerService();
/**
* Gets the address of the master member.
*
* This value can be null if no master is elected yet.
*
* The value can change over time.
*
* @return the address of the master member
*/
Address getMasterAddress();
/**
* Get the address of this member.
*
* The returned value will never change and will never be {@code null}.
*
* @return the address of this member
*/
Address getThisAddress();
/**
* Returns the local member.
*
* The returned value will never be null but it may change when local lite member is promoted to a data member
* or when this member merges to a new cluster after split-brain detected. Returned value should not be
* cached but instead this method should be called each time when local member is needed.
*
* @return the local member
*/
Member getLocalMember();
/**
* Returns the Config that was used to create the HazelcastInstance.
*
* The returned value will never change and will never be {@code null}.
*
* @return the config
*/
Config getConfig();
/**
* Returns the Config ClassLoader. This class loader will be used for instantiation of all classes defined by the
* configuration (e.g. listeners, policies, stores, partitioning strategies, split brain protection functions, ...).
*
* TODO: add more documentation what the purpose is of the config classloader
*
* @return the config ClassLoader.
*/
ClassLoader getConfigClassLoader();
/**
* Returns the HazelcastProperties.
*
* The returned value will never change and will never be {@code null}.
*
* @return the HazelcastProperties
*/
HazelcastProperties getProperties();
/**
* Gets the logger for a given name.
*
* It is best to get an ILogger through this method instead of calling {@link com.hazelcast.logging.Logger#getLogger(String)}.
*
* @param name the name of the logger
* @return the ILogger
* @throws NullPointerException if name is {@code null}
* @see #getLogger(String)
*/
ILogger getLogger(String name);
/**
* Gets the logger for a given class.
*
* It is best to get an ILogger through this method instead of calling {@link com.hazelcast.logging.Logger#getLogger(Class)}.
*
* @param clazz the class of the logger
* @return the ILogger
* @throws NullPointerException if clazz is {@code null}
* @see #getLogger(Class)
*/
ILogger getLogger(Class clazz);
/**
* Serializes an object to a {@link Data}.
*
* This method can safely be called with a {@link Data} instance. In that case, that instance is returned.
*
* If this method is called with {@code null}, {@code null} is returned.
*
* @param object the object to serialize
* @return the serialized object
* @throws com.hazelcast.nio.serialization.HazelcastSerializationException when serialization fails
*/
Data toData(Object object);
/**
* Deserializes an object.
*
* This method can safely be called on an object that is already deserialized. In that case, that instance
* is returned.
*
* If this method is called with {@code null}, {@code null} is returned.
*
* @param object the object to deserialize
* @return the deserialized object
* @throws com.hazelcast.nio.serialization.HazelcastSerializationException when deserialization fails
*/
T toObject(Object object);
/**
* Deserializes an object.
*
* This method can safely be called on an object that is already deserialized. In that case, that instance
* is returned.
*
* If this method is called with {@code null}, {@code null} is returned.
*
* @param object the object to deserialize
* @param klazz The class to instantiate when deserializing the object
* @return the deserialized object
* @throws com.hazelcast.nio.serialization.HazelcastSerializationException when deserialization fails
*/
T toObject(Object object, Class klazz);
/**
* Indicates that node is not shutting down or it has not already shut down
*
* @return {@code true} if node is not shutting down or it has not already shut down, {@code false} otherwise
*/
boolean isRunning();
/**
* Returns the HazelcastInstance that this {@link NodeEngine} belongs to.
*
* @return the HazelcastInstance
*/
HazelcastInstance getHazelcastInstance();
/**
* Gets the service with the given name.
*
* @param serviceName the name of the service
* @param the type of the service
* @return the found service, or HazelcastException in case of failure ({@code null} will never be returned)
*/
T getService(@Nonnull String serviceName);
/**
* Gets the service for the given serviceName if it exists or null otherwise.
*
* @param serviceName the name of the shared service to get
* @param the type of the service
* @return the found service, or null if the service was not found
* @throws NullPointerException if the serviceName is {@code null}
*/
T getServiceOrNull(@Nonnull String serviceName);
/**
* Returns the codebase version of the node. For example, when running on hazelcast-3.8.jar, this would resolve
* to {@code Version.of(3,8,0)}. A node's codebase version may be different than cluster version.
*
* @return codebase version of the node
* @see Cluster#getClusterVersion()
* @since 3.8
*/
MemberVersion getVersion();
/**
* Returns the {@link SplitBrainMergePolicyProvider} for this instance.
*
* @return the {@link SplitBrainMergePolicyProvider}
* @since 3.10
*/
SplitBrainMergePolicyProvider getSplitBrainMergePolicyProvider();
/**
* Returns a list of services matching provides service class/interface.
*
* Note: CoreServices will be placed at the beginning of the list.
*/
Collection getServices(Class serviceClass);
}