com.hazelcast.client.impl.ClientEngineImpl Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2016, 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.client.impl;
import com.hazelcast.cache.impl.JCacheDetector;
import com.hazelcast.client.AuthenticationException;
import com.hazelcast.client.ClientEndpoint;
import com.hazelcast.client.ClientEndpointManager;
import com.hazelcast.client.ClientEngine;
import com.hazelcast.client.ClientEvent;
import com.hazelcast.client.ClientEventType;
import com.hazelcast.client.impl.client.AuthenticationRequest;
import com.hazelcast.client.impl.client.ClientRequest;
import com.hazelcast.client.impl.client.ClientResponse;
import com.hazelcast.client.impl.operations.ClientDisconnectionOperation;
import com.hazelcast.client.impl.operations.GetConnectedClientsOperation;
import com.hazelcast.client.impl.operations.PostJoinClientOperation;
import com.hazelcast.client.impl.protocol.ClientExceptionFactory;
import com.hazelcast.client.impl.protocol.ClientMessage;
import com.hazelcast.client.impl.protocol.MessageTaskFactory;
import com.hazelcast.client.impl.protocol.task.MessageTask;
import com.hazelcast.cluster.ClusterService;
import com.hazelcast.config.Config;
import com.hazelcast.core.Client;
import com.hazelcast.core.ClientListener;
import com.hazelcast.core.ClientType;
import com.hazelcast.core.HazelcastInstanceNotActiveException;
import com.hazelcast.core.Member;
import com.hazelcast.instance.GroupProperty;
import com.hazelcast.instance.MemberImpl;
import com.hazelcast.instance.Node;
import com.hazelcast.internal.serialization.SerializationService;
import com.hazelcast.logging.ILogger;
import com.hazelcast.nio.Address;
import com.hazelcast.nio.Connection;
import com.hazelcast.nio.ConnectionListener;
import com.hazelcast.nio.Packet;
import com.hazelcast.nio.serialization.Data;
import com.hazelcast.nio.serialization.PortableReader;
import com.hazelcast.nio.tcp.TcpIpConnection;
import com.hazelcast.partition.InternalPartitionService;
import com.hazelcast.security.Credentials;
import com.hazelcast.security.SecurityContext;
import com.hazelcast.spi.CoreService;
import com.hazelcast.spi.EventPublishingService;
import com.hazelcast.spi.EventRegistration;
import com.hazelcast.spi.EventService;
import com.hazelcast.spi.ExecutionService;
import com.hazelcast.spi.ManagedService;
import com.hazelcast.spi.MemberAttributeServiceEvent;
import com.hazelcast.spi.MembershipAwareService;
import com.hazelcast.spi.MembershipServiceEvent;
import com.hazelcast.spi.NodeEngine;
import com.hazelcast.spi.Operation;
import com.hazelcast.spi.OperationService;
import com.hazelcast.spi.PostJoinAwareService;
import com.hazelcast.spi.ProxyService;
import com.hazelcast.spi.impl.NodeEngineImpl;
import com.hazelcast.spi.impl.PartitionSpecificRunnable;
import com.hazelcast.spi.impl.operationservice.InternalOperationService;
import com.hazelcast.transaction.TransactionManagerService;
import com.hazelcast.util.executor.ExecutorType;
import javax.security.auth.login.LoginException;
import java.security.Permission;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Map;
import java.util.Properties;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.Executor;
import java.util.concurrent.Future;
import java.util.concurrent.RejectedExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.logging.Level;
import static com.hazelcast.spi.impl.OperationResponseHandlerFactory.createEmptyResponseHandler;
/**
* Class that requests, listeners from client handled in node side.
*/
public class ClientEngineImpl implements ClientEngine, CoreService, PostJoinAwareService,
ManagedService, MembershipAwareService, EventPublishingService {
/**
* Service name to be used in requests.
*/
public static final String SERVICE_NAME = "hz:core:clientEngine";
private static final int ENDPOINT_REMOVE_DELAY_SECONDS = 10;
private static final int EXECUTOR_QUEUE_CAPACITY_PER_CORE = 100000;
private static final int THREADS_PER_CORE = 20;
private final Node node;
private final NodeEngineImpl nodeEngine;
private final Executor executor;
private final SerializationService serializationService;
// client uuid -> member uuid
private final ConcurrentMap ownershipMappings = new ConcurrentHashMap();
private final ClientEndpointManagerImpl endpointManager;
private final ILogger logger;
private final ConnectionListener connectionListener = new ConnectionListenerImpl();
private final MessageTaskFactory messageTaskFactory;
private final ClientExceptionFactory clientExceptionFactory;
public ClientEngineImpl(Node node) {
this.logger = node.getLogger(ClientEngine.class);
this.node = node;
this.serializationService = node.getSerializationService();
this.nodeEngine = node.nodeEngine;
this.endpointManager = new ClientEndpointManagerImpl(this, nodeEngine);
this.executor = newExecutor();
this.messageTaskFactory = node.getNodeExtension().createMessageTaskFactory();
this.clientExceptionFactory = initClientExceptionFactory();
ClientHeartbeatMonitor heartBeatMonitor = new ClientHeartbeatMonitor(
endpointManager, this, nodeEngine.getExecutionService(), node.groupProperties);
heartBeatMonitor.start();
}
private ClientExceptionFactory initClientExceptionFactory() {
boolean jcacheAvailable = JCacheDetector.isJcacheAvailable(nodeEngine.getConfigClassLoader());
return new ClientExceptionFactory(jcacheAvailable);
}
private Executor newExecutor() {
final ExecutionService executionService = nodeEngine.getExecutionService();
int coreSize = Runtime.getRuntime().availableProcessors();
int threadCount = node.getGroupProperties().getInteger(GroupProperty.CLIENT_ENGINE_THREAD_COUNT);
if (threadCount <= 0) {
threadCount = coreSize * THREADS_PER_CORE;
}
return executionService.register(ExecutionService.CLIENT_EXECUTOR,
threadCount, coreSize * EXECUTOR_QUEUE_CAPACITY_PER_CORE,
ExecutorType.CONCRETE);
}
//needed for testing purposes
public ConnectionListener getConnectionListener() {
return connectionListener;
}
@Override
public SerializationService getSerializationService() {
return serializationService;
}
@Override
public int getClientEndpointCount() {
return endpointManager.size();
}
public void handlePacket(Packet packet) {
int partitionId = packet.getPartitionId();
if (partitionId < 0) {
executor.execute(new ClientPacketProcessor(packet));
} else {
InternalOperationService operationService = nodeEngine.getOperationService();
operationService.execute(new ClientPacketProcessor(packet));
}
}
public void handleClientMessage(ClientMessage clientMessage, Connection connection) {
int partitionId = clientMessage.getPartitionId();
final MessageTask messageTask = messageTaskFactory.create(clientMessage, connection);
if (partitionId < 0) {
executor.execute(messageTask);
} else {
InternalOperationService operationService = nodeEngine.getOperationService();
operationService.execute(messageTask);
}
}
@Override
public InternalPartitionService getPartitionService() {
return nodeEngine.getPartitionService();
}
@Override
public ClusterService getClusterService() {
return nodeEngine.getClusterService();
}
@Override
public EventService getEventService() {
return nodeEngine.getEventService();
}
@Override
public ProxyService getProxyService() {
return nodeEngine.getProxyService();
}
public void sendResponse(ClientEndpoint endpoint, Object key, Object response, long callId,
boolean isError, boolean isEvent) {
Data data = serializationService.toData(response);
ClientResponse clientResponse = new ClientResponse(data, callId, isError);
int partitionId = key == null ? -1 : getPartitionService().getPartitionId(key);
Packet packet = new Packet(serializationService.toBytes(clientResponse), partitionId);
if (isEvent) {
packet.setHeader(Packet.HEADER_EVENT);
}
Connection conn = endpoint.getConnection();
conn.write(packet);
}
@Override
public Address getMasterAddress() {
return node.getMasterAddress();
}
@Override
public Address getThisAddress() {
return node.getThisAddress();
}
@Override
public MemberImpl getLocalMember() {
return node.getLocalMember();
}
@Override
public Config getConfig() {
return node.getConfig();
}
@Override
public ILogger getLogger(Class clazz) {
return node.getLogger(clazz);
}
public ClientEndpointManager getEndpointManager() {
return endpointManager;
}
public ClientExceptionFactory getClientExceptionFactory() {
return clientExceptionFactory;
}
@Override
public SecurityContext getSecurityContext() {
return node.securityContext;
}
public void bind(final ClientEndpoint endpoint) {
final Connection conn = endpoint.getConnection();
if (conn instanceof TcpIpConnection) {
Address address = new Address(conn.getRemoteSocketAddress());
((TcpIpConnection) conn).setEndPoint(address);
}
ClientEvent event = new ClientEvent(endpoint.getUuid(),
ClientEventType.CONNECTED,
endpoint.getSocketAddress(),
endpoint.getClientType());
sendClientEvent(event);
}
void sendClientEvent(ClientEvent event) {
final EventService eventService = nodeEngine.getEventService();
final Collection regs = eventService.getRegistrations(SERVICE_NAME, SERVICE_NAME);
String uuid = event.getUuid();
eventService.publishEvent(SERVICE_NAME, regs, event, uuid.hashCode());
}
@Override
public void dispatchEvent(ClientEvent event, ClientListener listener) {
if (event.getEventType() == ClientEventType.CONNECTED) {
listener.clientConnected(event);
} else {
listener.clientDisconnected(event);
}
}
@Override
public void memberAdded(MembershipServiceEvent event) {
}
@Override
public void memberRemoved(MembershipServiceEvent event) {
if (event.getMember().localMember()) {
return;
}
final String deadMemberUuid = event.getMember().getUuid();
try {
nodeEngine.getExecutionService().schedule(new DestroyEndpointTask(deadMemberUuid),
ENDPOINT_REMOVE_DELAY_SECONDS, TimeUnit.SECONDS);
} catch (RejectedExecutionException e) {
if (logger.isFinestEnabled()) {
logger.finest(e);
}
}
}
@Override
public void memberAttributeChanged(MemberAttributeServiceEvent event) {
}
public Collection getClients() {
final HashSet clients = new HashSet();
for (ClientEndpoint endpoint : endpointManager.getEndpoints()) {
clients.add((Client) endpoint);
}
return clients;
}
@Override
public void init(NodeEngine nodeEngine, Properties properties) {
node.getConnectionManager().addConnectionListener(connectionListener);
}
@Override
public void reset() {
}
@Override
public void shutdown(boolean terminate) {
for (ClientEndpoint ce : endpointManager.getEndpoints()) {
ClientEndpointImpl endpoint = (ClientEndpointImpl) ce;
try {
endpoint.destroy();
} catch (LoginException e) {
logger.finest(e.getMessage());
}
try {
final Connection conn = endpoint.getConnection();
if (conn.isAlive()) {
conn.close();
}
} catch (Exception e) {
logger.finest(e);
}
}
endpointManager.clear();
ownershipMappings.clear();
}
public void addOwnershipMapping(String clientUuid, String ownerUuid) {
ownershipMappings.put(clientUuid, ownerUuid);
}
public void removeOwnershipMapping(String clientUuid) {
ownershipMappings.remove(clientUuid);
}
public TransactionManagerService getTransactionManagerService() {
return node.nodeEngine.getTransactionManagerService();
}
public final class ClientPacketProcessor implements PartitionSpecificRunnable {
final Packet packet;
private ClientPacketProcessor(Packet packet) {
this.packet = packet;
}
@Override
public int getPartitionId() {
return packet.getPartitionId();
}
@Override
public void run() {
Connection conn = packet.getConn();
ClientEndpointImpl endpoint = (ClientEndpointImpl) endpointManager.getEndpoint(conn);
ClientRequest request = null;
try {
request = loadRequest();
if (request == null) {
handlePacketWithNullRequest();
} else if (request instanceof AuthenticationRequest) {
if (conn.isAlive()) {
endpoint = new ClientEndpointImpl(ClientEngineImpl.this, conn);
processRequest(endpoint, request);
} else {
handleEndpointNotCreatedConnectionNotAlive();
}
} else if (endpoint == null) {
handleMissingEndpoint(conn);
} else if (endpoint.isAuthenticated()) {
processRequest(endpoint, request);
} else {
handleAuthenticationFailure(endpoint, request);
}
} catch (Throwable e) {
logProcessingFailure(request, e);
handleProcessingFailure(endpoint, request, packet, e);
}
}
private ClientRequest loadRequest() {
return serializationService.toObject(packet);
}
private void handleEndpointNotCreatedConnectionNotAlive() {
logger.warning("Dropped: " + packet + " -> endpoint not created for AuthenticationRequest, "
+ "connection not alive");
}
private void handlePacketWithNullRequest() {
logger.warning("Dropped: " + packet + " -> null request");
}
private void handleMissingEndpoint(Connection conn) {
if (conn.isAlive()) {
logger.severe("Dropping: " + packet + " -> no endpoint found for live connection.");
} else {
if (logger.isFinestEnabled()) {
logger.finest("Dropping: " + packet + " -> no endpoint found for dead connection.");
}
}
}
private void logProcessingFailure(ClientRequest request, Throwable e) {
if (logger.isLoggable(Level.FINEST)) {
if (request == null) {
logger.log(Level.FINEST, e.getMessage(), e);
} else {
logger.log(Level.FINEST, "While executing request: " + request + " -> " + e.getMessage(), e);
}
}
}
private void handleProcessingFailure(ClientEndpointImpl endpoint, ClientRequest request, Data data, Throwable e) {
if (request != null && endpoint != null) {
endpoint.sendResponse(e, request.getCallId());
} else if (data != null && endpoint != null) {
long callId = extractCallId(data);
if (callId != -1) {
endpoint.sendResponse(e, callId);
}
// Worst case, seems like we cannot even read the callId, wrong/broken packet?
}
}
private long extractCallId(Data data) {
try {
PortableReader portableReader = serializationService.createPortableReader(data);
return portableReader.readLong("cId");
} catch (Throwable e) {
Level level = nodeEngine.isRunning() ? Level.SEVERE : Level.FINEST;
if (logger.isLoggable(level)) {
logger.log(level, e.getMessage(), e);
}
}
return -1;
}
private void processRequest(ClientEndpointImpl endpoint, ClientRequest request) throws Exception {
if (!node.joined()) {
throw new HazelcastInstanceNotActiveException("Hazelcast instance is not ready yet!");
}
request.setEndpoint(endpoint);
initService(request);
request.setClientEngine(ClientEngineImpl.this);
final Credentials credentials = endpoint.getCredentials();
request.setSerializationService(serializationService);
request.setOperationService(nodeEngine.getOperationService());
interceptBefore(credentials, request);
checkPermissions(endpoint, request);
request.process();
interceptAfter(credentials, request);
}
private void interceptBefore(Credentials credentials, ClientRequest request) {
final SecurityContext securityContext = getSecurityContext();
final String methodName = request.getMethodName();
if (securityContext != null && methodName != null) {
final String objectType = request.getDistributedObjectType();
final String objectName = request.getDistributedObjectName();
securityContext.interceptBefore(credentials, objectType, objectName, methodName, request.getParameters());
}
}
private void interceptAfter(Credentials credentials, ClientRequest request) {
final SecurityContext securityContext = getSecurityContext();
final String methodName = request.getMethodName();
if (securityContext != null && methodName != null) {
final String objectType = request.getDistributedObjectType();
final String objectName = request.getDistributedObjectName();
securityContext.interceptAfter(credentials, objectType, objectName, methodName);
}
}
private void checkPermissions(ClientEndpointImpl endpoint, ClientRequest request) {
SecurityContext securityContext = getSecurityContext();
if (securityContext != null) {
Permission permission = request.getRequiredPermission();
if (permission != null) {
securityContext.checkPermission(endpoint.getSubject(), permission);
}
}
}
private void initService(ClientRequest request) {
String serviceName = request.getServiceName();
if (serviceName == null) {
return;
}
Object service = nodeEngine.getService(serviceName);
request.setService(service);
}
private void handleAuthenticationFailure(ClientEndpointImpl endpoint, ClientRequest request) {
Exception exception;
if (nodeEngine.isRunning()) {
String message = "Client " + endpoint + " must authenticate before any operation.";
logger.severe(message);
exception = new AuthenticationException(message);
} else {
exception = new HazelcastInstanceNotActiveException();
}
endpoint.sendResponse(exception, request.getCallId());
endpointManager.removeEndpoint(endpoint);
}
}
private final class ConnectionListenerImpl implements ConnectionListener {
@Override
public void connectionAdded(Connection conn) {
//no-op
//unfortunately we can't do the endpoint creation here, because this event is only called when the
//connection is bound, but we need to use the endpoint connection before that.
}
@Override
public void connectionRemoved(Connection connection) {
if (connection.isClient() && nodeEngine.isRunning()) {
ClientEndpointImpl endpoint = (ClientEndpointImpl) endpointManager.getEndpoint(connection);
if (endpoint == null) {
return;
}
if (!endpoint.isFirstConnection()) {
return;
}
String localMemberUuid = node.getLocalMember().getUuid();
String ownerUuid = endpoint.getPrincipal().getOwnerUuid();
if (localMemberUuid.equals(ownerUuid)) {
callDisconnectionOperation(endpoint);
}
}
}
private void callDisconnectionOperation(ClientEndpointImpl endpoint) {
Collection memberList = nodeEngine.getClusterService().getMembers();
OperationService operationService = nodeEngine.getOperationService();
ClientDisconnectionOperation op = createClientDisconnectionOperation(endpoint.getUuid());
operationService.runOperationOnCallingThread(op);
for (Member member : memberList) {
if (!member.localMember()) {
op = createClientDisconnectionOperation(endpoint.getUuid());
operationService.send(op, member.getAddress());
}
}
}
}
private ClientDisconnectionOperation createClientDisconnectionOperation(String clientUuid) {
ClientDisconnectionOperation op = new ClientDisconnectionOperation(clientUuid);
op.setNodeEngine(nodeEngine)
.setServiceName(SERVICE_NAME)
.setService(this)
.setOperationResponseHandler(createEmptyResponseHandler());
return op;
}
private class DestroyEndpointTask implements Runnable {
private final String deadMemberUuid;
public DestroyEndpointTask(String deadMemberUuid) {
this.deadMemberUuid = deadMemberUuid;
}
@Override
public void run() {
endpointManager.removeEndpoints(deadMemberUuid);
removeMappings();
}
void removeMappings() {
Iterator> iterator = ownershipMappings.entrySet().iterator();
while (iterator.hasNext()) {
Map.Entry entry = iterator.next();
String clientUuid = entry.getKey();
String memberUuid = entry.getValue();
if (deadMemberUuid.equals(memberUuid)) {
iterator.remove();
ClientDisconnectionOperation op = createClientDisconnectionOperation(clientUuid);
nodeEngine.getOperationService().runOperationOnCallingThread(op);
}
}
}
}
@Override
public Operation getPostJoinOperation() {
return ownershipMappings.isEmpty() ? null : new PostJoinClientOperation(ownershipMappings);
}
@Override
public Map getConnectedClientStats() {
int numberOfCppClients = 0;
int numberOfDotNetClients = 0;
int numberOfJavaClients = 0;
int numberOfOtherClients = 0;
Operation clientInfoOperation = new GetConnectedClientsOperation();
OperationService operationService = node.nodeEngine.getOperationService();
Map resultMap = new HashMap();
Map clientsMap = new HashMap();
for (Member member : node.getClusterService().getMembers()) {
Address target = member.getAddress();
Future> future
= operationService.invokeOnTarget(SERVICE_NAME, clientInfoOperation, target);
try {
Map endpoints = future.get();
if (endpoints == null) {
continue;
}
//Merge connected clients according to their uuid.
for (Map.Entry entry : endpoints.entrySet()) {
clientsMap.put(entry.getKey(), entry.getValue());
}
} catch (Exception e) {
logger.warning("Cannot get client information from: " + target.toString(), e);
}
}
//Now we are regrouping according to the client type
for (ClientType clientType : clientsMap.values()) {
switch (clientType) {
case JAVA:
numberOfJavaClients++;
break;
case CSHARP:
numberOfDotNetClients++;
break;
case CPP:
numberOfCppClients++;
break;
default:
numberOfOtherClients++;
}
}
resultMap.put(ClientType.CPP, numberOfCppClients);
resultMap.put(ClientType.CSHARP, numberOfDotNetClients);
resultMap.put(ClientType.JAVA, numberOfJavaClients);
resultMap.put(ClientType.OTHER, numberOfOtherClients);
return resultMap;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy