/*
* Copyright (c) 2008-2017, 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.collection.impl.queue;
import com.hazelcast.collection.impl.common.DataAwareItemEvent;
import com.hazelcast.collection.impl.queue.operations.QueueReplicationOperation;
import com.hazelcast.collection.impl.txnqueue.TransactionalQueueProxy;
import com.hazelcast.collection.impl.txnqueue.operations.QueueTransactionRollbackOperation;
import com.hazelcast.config.QueueConfig;
import com.hazelcast.core.ItemEvent;
import com.hazelcast.core.ItemEventType;
import com.hazelcast.core.ItemListener;
import com.hazelcast.instance.MemberImpl;
import com.hazelcast.logging.ILogger;
import com.hazelcast.monitor.LocalQueueStats;
import com.hazelcast.monitor.impl.LocalQueueStatsImpl;
import com.hazelcast.nio.Address;
import com.hazelcast.nio.serialization.Data;
import com.hazelcast.partition.strategy.StringPartitioningStrategy;
import com.hazelcast.spi.EventPublishingService;
import com.hazelcast.spi.EventRegistration;
import com.hazelcast.spi.EventService;
import com.hazelcast.spi.ManagedService;
import com.hazelcast.spi.MigrationAwareService;
import com.hazelcast.spi.NodeEngine;
import com.hazelcast.spi.Operation;
import com.hazelcast.spi.OperationService;
import com.hazelcast.spi.PartitionMigrationEvent;
import com.hazelcast.spi.PartitionReplicationEvent;
import com.hazelcast.spi.QuorumAwareService;
import com.hazelcast.spi.RemoteService;
import com.hazelcast.spi.StatisticsAwareService;
import com.hazelcast.spi.TaskScheduler;
import com.hazelcast.spi.TransactionalService;
import com.hazelcast.spi.partition.IPartition;
import com.hazelcast.spi.partition.IPartitionService;
import com.hazelcast.spi.partition.MigrationEndpoint;
import com.hazelcast.spi.serialization.SerializationService;
import com.hazelcast.transaction.impl.Transaction;
import com.hazelcast.util.ConcurrencyUtil;
import com.hazelcast.util.ConstructorFunction;
import com.hazelcast.util.MapUtil;
import com.hazelcast.util.scheduler.EntryTaskScheduler;
import com.hazelcast.util.scheduler.EntryTaskSchedulerFactory;
import com.hazelcast.util.scheduler.ScheduleType;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Properties;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
/**
* Provides important services via methods for the the Queue
* such as {@link com.hazelcast.collection.impl.queue.QueueEvictionProcessor }
*/
public class QueueService implements ManagedService, MigrationAwareService, TransactionalService,
RemoteService, EventPublishingService<QueueEvent, ItemListener>, StatisticsAwareService, QuorumAwareService {
public static final String SERVICE_NAME = "hz:impl:queueService";
private final EntryTaskScheduler<String, Void> queueEvictionScheduler;
private final NodeEngine nodeEngine;
private final ConcurrentMap<String, QueueContainer> containerMap
= new ConcurrentHashMap<String, QueueContainer>();
private final ConcurrentMap<String, LocalQueueStatsImpl> statsMap
= new ConcurrentHashMap<String, LocalQueueStatsImpl>(1000);
private final ConstructorFunction<String, LocalQueueStatsImpl> localQueueStatsConstructorFunction
= new ConstructorFunction<String, LocalQueueStatsImpl>() {
@Override
public LocalQueueStatsImpl createNew(String key) {
return new LocalQueueStatsImpl();
}
};
private final ILogger logger;
public QueueService(NodeEngine nodeEngine) {
this.nodeEngine = nodeEngine;
TaskScheduler globalScheduler = nodeEngine.getExecutionService().getGlobalTaskScheduler();
QueueEvictionProcessor entryProcessor = new QueueEvictionProcessor(nodeEngine);
this.queueEvictionScheduler = EntryTaskSchedulerFactory.newScheduler(
globalScheduler, entryProcessor, ScheduleType.POSTPONE);
this.logger = nodeEngine.getLogger(QueueService.class);
}
public void scheduleEviction(String name, long delay) {
queueEvictionScheduler.schedule(delay, name, null);
}
public void cancelEviction(String name) {
queueEvictionScheduler.cancel(name);
}
@Override
public void init(NodeEngine nodeEngine, Properties properties) {
}
@Override
public void reset() {
containerMap.clear();
}
@Override
public void shutdown(boolean terminate) {
reset();
}
public QueueContainer getOrCreateContainer(final String name, boolean fromBackup) throws Exception {
QueueContainer container = containerMap.get(name);
if (container != null) {
return container;
}
container = new QueueContainer(name, nodeEngine.getConfig().findQueueConfig(name), nodeEngine, this);
QueueContainer existing = containerMap.putIfAbsent(name, container);
if (existing != null) {
container = existing;
} else {
container.init(fromBackup);
container.getStore().instrument(nodeEngine);
}
return container;
}
public void addContainer(String name, QueueContainer container) {
containerMap.put(name, container);
}
// need for testing..
public boolean containsQueue(String name) {
return containerMap.containsKey(name);
}
@Override
public void beforeMigration(PartitionMigrationEvent partitionMigrationEvent) {
}
@Override
public Operation prepareReplicationOperation(PartitionReplicationEvent event) {
Map<String, QueueContainer> migrationData = new HashMap<String, QueueContainer>();
IPartitionService partitionService = nodeEngine.getPartitionService();
for (Entry<String, QueueContainer> entry : containerMap.entrySet()) {
String name = entry.getKey();
int partitionId = partitionService.getPartitionId(StringPartitioningStrategy.getPartitionKey(name));
QueueContainer container = entry.getValue();
if (partitionId == event.getPartitionId()
&& container.getConfig().getTotalBackupCount() >= event.getReplicaIndex()) {
migrationData.put(name, container);
}
}
if (migrationData.isEmpty()) {
return null;
} else {
return new QueueReplicationOperation(migrationData, event.getPartitionId(), event.getReplicaIndex());
}
}
@Override
public void commitMigration(PartitionMigrationEvent event) {
if (event.getMigrationEndpoint() == MigrationEndpoint.SOURCE) {
clearQueuesHavingLesserBackupCountThan(event.getPartitionId(), event.getNewReplicaIndex());
}
}
@Override
public void rollbackMigration(PartitionMigrationEvent event) {
if (event.getMigrationEndpoint() == MigrationEndpoint.DESTINATION) {
clearQueuesHavingLesserBackupCountThan(event.getPartitionId(), event.getCurrentReplicaIndex());
}
}
private void clearQueuesHavingLesserBackupCountThan(int partitionId, int thresholdReplicaIndex) {
Iterator<Entry<String, QueueContainer>> iterator = containerMap.entrySet().iterator();
IPartitionService partitionService = nodeEngine.getPartitionService();
while (iterator.hasNext()) {
final Entry<String, QueueContainer> entry = iterator.next();
final String name = entry.getKey();
final QueueContainer container = entry.getValue();
int containerPartitionId = partitionService.getPartitionId(StringPartitioningStrategy.getPartitionKey(name));
if (containerPartitionId != partitionId) {
continue;
}
if (thresholdReplicaIndex < 0 || thresholdReplicaIndex > container.getConfig().getTotalBackupCount()) {
container.destroy();
iterator.remove();
}
}
}
@Override
public void dispatchEvent(QueueEvent event, ItemListener listener) {
final MemberImpl member = nodeEngine.getClusterService().getMember(event.caller);
ItemEvent itemEvent = new DataAwareItemEvent(event.name, event.eventType, event.data,
member, nodeEngine.getSerializationService());
if (member == null) {
if (logger.isInfoEnabled()) {
logger.info("Dropping event " + itemEvent + " from unknown address:" + event.caller);
}
return;
}
if (event.eventType.equals(ItemEventType.ADDED)) {
listener.itemAdded(itemEvent);
} else {
listener.itemRemoved(itemEvent);
}
getLocalQueueStatsImpl(event.name).incrementReceivedEvents();
}
@Override
public QueueProxyImpl createDistributedObject(String objectId) {
return new QueueProxyImpl(objectId, this, nodeEngine);
}
@Override
public void destroyDistributedObject(String name) {
containerMap.remove(name);
nodeEngine.getEventService().deregisterAllListeners(SERVICE_NAME, name);
}
public String addItemListener(String name, ItemListener listener, boolean includeValue, boolean isLocal) {
EventService eventService = nodeEngine.getEventService();
QueueEventFilter filter = new QueueEventFilter(includeValue);
EventRegistration registration;
if (isLocal) {
registration = eventService.registerLocalListener(
QueueService.SERVICE_NAME, name, filter, listener);
} else {
registration = eventService.registerListener(
QueueService.SERVICE_NAME, name, filter, listener);
}
return registration.getId();
}
public boolean removeItemListener(String name, String registrationId) {
EventService eventService = nodeEngine.getEventService();
return eventService.deregisterListener(SERVICE_NAME, name, registrationId);
}
public NodeEngine getNodeEngine() {
return nodeEngine;
}
/**
* Returns the local queue statistics for the given name and partition ID. If this node is the owner for the partition,
* returned stats contain {@link LocalQueueStats#getOwnedItemCount()}, otherwise it contains
* {@link LocalQueueStats#getBackupItemCount()}.
*
* @param name the name of the queue for which the statistics are returned
* @param partitionId the partition ID for which the statistics are returned
* @return the statistics
*/
public LocalQueueStats createLocalQueueStats(String name, int partitionId) {
LocalQueueStatsImpl stats = getLocalQueueStatsImpl(name);
stats.setOwnedItemCount(0);
stats.setBackupItemCount(0);
QueueContainer container = containerMap.get(name);
if (container == null) {
return stats;
}
Address thisAddress = nodeEngine.getClusterService().getThisAddress();
IPartition partition = nodeEngine.getPartitionService().getPartition(partitionId);
Address owner = partition.getOwnerOrNull();
if (thisAddress.equals(owner)) {
stats.setOwnedItemCount(container.size());
} else if (owner != null) {
stats.setBackupItemCount(container.backupSize());
}
container.setStats(stats);
return stats;
}
/**
* Returns the local queue statistics for the queue with the given {@code name}. If this node is the owner of the queue,
* returned stats contain {@link LocalQueueStats#getOwnedItemCount()}, otherwise it contains
* {@link LocalQueueStats#getBackupItemCount()}.
*
* @param name the name of the queue for which the statistics are returned
* @return the statistics
*/
public LocalQueueStats createLocalQueueStats(String name) {
SerializationService serializationService = nodeEngine.getSerializationService();
IPartitionService partitionService = nodeEngine.getPartitionService();
Data keyData = serializationService.toData(name, StringPartitioningStrategy.INSTANCE);
int partitionId = partitionService.getPartitionId(keyData);
return createLocalQueueStats(name, partitionId);
}
public LocalQueueStatsImpl getLocalQueueStatsImpl(String name) {
return ConcurrencyUtil.getOrPutIfAbsent(statsMap, name, localQueueStatsConstructorFunction);
}
@Override
public TransactionalQueueProxy createTransactionalObject(String name, Transaction transaction) {
return new TransactionalQueueProxy(nodeEngine, this, name, transaction);
}
@Override
public void rollbackTransaction(String transactionId) {
final Set<String> queueNames = containerMap.keySet();
IPartitionService partitionService = nodeEngine.getPartitionService();
OperationService operationService = nodeEngine.getOperationService();
for (String name : queueNames) {
int partitionId = partitionService.getPartitionId(StringPartitioningStrategy.getPartitionKey(name));
Operation operation = new QueueTransactionRollbackOperation(name, transactionId)
.setPartitionId(partitionId)
.setService(this)
.setNodeEngine(nodeEngine);
operationService.execute(operation);
}
}
@Override
public Map<String, LocalQueueStats> getStats() {
Map<String, LocalQueueStats> queueStats = MapUtil.createHashMap(containerMap.size());
for (Entry<String, QueueContainer> entry : containerMap.entrySet()) {
String name = entry.getKey();
LocalQueueStats queueStat = createLocalQueueStats(name);
queueStats.put(name, queueStat);
}
return queueStats;
}
@Override
public String getQuorumName(String name) {
final QueueConfig queueConfig = nodeEngine.getConfig().findQueueConfig(name);
return queueConfig.getQuorumName();
}
}