/*
* Copyright (c) 2008-2013, 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.replicatedmap;
import com.hazelcast.config.Config;
import com.hazelcast.config.InMemoryFormat;
import com.hazelcast.config.ReplicatedMapConfig;
import com.hazelcast.core.DistributedObject;
import com.hazelcast.core.EntryEvent;
import com.hazelcast.core.EntryListener;
import com.hazelcast.logging.ILogger;
import com.hazelcast.monitor.impl.LocalReplicatedMapStatsImpl;
import com.hazelcast.nio.serialization.IdentifiedDataSerializable;
import com.hazelcast.replicatedmap.messages.MultiReplicationMessage;
import com.hazelcast.replicatedmap.messages.ReplicationMessage;
import com.hazelcast.replicatedmap.record.AbstractReplicatedRecordStore;
import com.hazelcast.replicatedmap.record.DataReplicatedRecordStore;
import com.hazelcast.replicatedmap.record.ObjectReplicatedRecordStorage;
import com.hazelcast.replicatedmap.record.ReplicatedRecord;
import com.hazelcast.replicatedmap.record.ReplicatedRecordStore;
import com.hazelcast.replicatedmap.record.ReplicationPublisher;
import com.hazelcast.spi.EventFilter;
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.NodeEngine;
import com.hazelcast.spi.RemoteService;
import com.hazelcast.util.ConcurrencyUtil;
import com.hazelcast.util.ConstructorFunction;
import java.util.EventListener;
import java.util.Iterator;
import java.util.Properties;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;
/**
* This is the main service implementation to handle replication and manages the backing
* {@link com.hazelcast.replicatedmap.record.ReplicatedRecordStore}s that actually hold the data
*/
public class ReplicatedMapService
implements ManagedService, RemoteService, EventPublishingService<Object, Object> {
/**
* Public constant for the internal service name of the ReplicatedMapService
*/
public static final String SERVICE_NAME = "hz:impl:replicatedMapService";
/**
* Public constant for the internal name of the replication topic
*/
public static final String EVENT_TOPIC_NAME = SERVICE_NAME + ".replication";
private static final int INITIAL_DELAY = 5;
private static final int PERIOD = 5;
private final ConcurrentHashMap<String, ReplicatedRecordStore> replicatedStorages = initReplicatedRecordStoreMapping();
private final CleanerRegistrator cleanerRegistrator = new CleanerRegistrator() {
@Override
public <V> ScheduledFuture<V> registerCleaner(ReplicatedRecordStore replicatedRecordStorage) {
return (ScheduledFuture) ReplicatedMapService.this.registerCleaner(replicatedRecordStorage);
}
};
private final ConstructorFunction<String, ReplicatedRecordStore> constructor = buildConstructorFunction();
private final ILogger logger;
private final Config config;
private final NodeEngine nodeEngine;
private final EventService eventService;
private final ExecutionService executionService;
private final EventRegistration eventRegistration;
public ReplicatedMapService(NodeEngine nodeEngine) {
this.logger = nodeEngine.getLogger(ReplicatedMapService.class.getName());
this.nodeEngine = nodeEngine;
this.config = nodeEngine.getConfig();
this.eventService = nodeEngine.getEventService();
this.executionService = nodeEngine.getExecutionService();
this.eventRegistration = eventService.registerListener(SERVICE_NAME, EVENT_TOPIC_NAME, new ReplicationListener());
}
@Override
public void init(NodeEngine nodeEngine, Properties properties) {
}
@Override
public void reset() {
for (ReplicatedRecordStore replicatedRecordStore : replicatedStorages.values()) {
replicatedRecordStore.clear(false, true);
}
}
@Override
public void shutdown(boolean terminate) {
for (ReplicatedRecordStore replicatedRecordStore : replicatedStorages.values()) {
replicatedRecordStore.destroy();
}
replicatedStorages.clear();
}
@Override
public DistributedObject createDistributedObject(String objectName) {
ReplicatedRecordStore replicatedRecordStore = ConcurrencyUtil
.getOrPutSynchronized(replicatedStorages, objectName, replicatedStorages, constructor);
return new ReplicatedMapProxy(nodeEngine, (AbstractReplicatedRecordStore) replicatedRecordStore);
}
@Override
public void destroyDistributedObject(String objectName) {
ReplicatedRecordStore replicatedRecordStore = replicatedStorages.remove(objectName);
if (replicatedRecordStore != null) {
replicatedRecordStore.destroy();
}
}
@Override
public void dispatchEvent(Object event, Object listener) {
if (event instanceof EntryEvent) {
EntryEvent entryEvent = (EntryEvent) event;
EntryListener entryListener = (EntryListener) listener;
switch (entryEvent.getEventType()) {
case ADDED:
entryListener.entryAdded(entryEvent);
break;
case EVICTED:
entryListener.entryEvicted(entryEvent);
break;
case UPDATED:
entryListener.entryUpdated(entryEvent);
break;
case REMOVED:
entryListener.entryRemoved(entryEvent);
break;
// TODO handle evictAll and clearAll event
default:
throw new IllegalArgumentException("event type " + entryEvent.getEventType() + " not supported");
}
String mapName = ((EntryEvent) event).getName();
if (config.findReplicatedMapConfig(mapName).isStatisticsEnabled()) {
ReplicatedRecordStore recordStore = replicatedStorages.get(mapName);
if (recordStore instanceof AbstractReplicatedRecordStore) {
LocalReplicatedMapStatsImpl stats = ((AbstractReplicatedRecordStore) recordStore).getReplicatedMapStats();
stats.incrementReceivedEvents();
}
}
} else if (listener instanceof ReplicatedMessageListener) {
((ReplicatedMessageListener) listener).onMessage((IdentifiedDataSerializable) event);
}
}
public ReplicatedMapConfig getReplicatedMapConfig(String name) {
return config.getReplicatedMapConfig(name).getAsReadOnly();
}
public ReplicatedRecordStore getReplicatedRecordStore(String name, boolean create) {
if (create) {
return ConcurrencyUtil.getOrPutSynchronized(replicatedStorages, name, replicatedStorages, constructor);
}
return replicatedStorages.get(name);
}
public String addEventListener(EventListener entryListener, EventFilter eventFilter, String mapName) {
EventRegistration registration = eventService.registerLocalListener(SERVICE_NAME, mapName, eventFilter, entryListener);
return registration.getId();
}
public boolean removeEventListener(String mapName, String registrationId) {
return eventService.deregisterListener(SERVICE_NAME, mapName, registrationId);
}
ScheduledFuture<?> registerCleaner(ReplicatedRecordStore replicatedRecordStorage) {
if (replicatedRecordStorage instanceof AbstractReplicatedRecordStore) {
AbstractReplicatedRecordStore recordStore = (AbstractReplicatedRecordStore) replicatedRecordStorage;
return executionService.scheduleWithFixedDelay(new Cleaner(recordStore), INITIAL_DELAY, PERIOD, TimeUnit.SECONDS);
}
String className = replicatedRecordStorage.getClass().getName();
throw new IllegalArgumentException("Unknown ReplicatedRecordStore implementation: " + className);
}
private ConcurrentHashMap<String, ReplicatedRecordStore> initReplicatedRecordStoreMapping() {
return new ConcurrentHashMap<String, ReplicatedRecordStore>();
}
private ConstructorFunction<String, ReplicatedRecordStore> buildConstructorFunction() {
return new ConstructorFunction<String, ReplicatedRecordStore>() {
@Override
public ReplicatedRecordStore createNew(String name) {
ReplicatedMapConfig replicatedMapConfig = getReplicatedMapConfig(name);
InMemoryFormat inMemoryFormat = replicatedMapConfig.getInMemoryFormat();
AbstractReplicatedRecordStore replicatedRecordStorage = null;
switch (inMemoryFormat) {
case OBJECT:
replicatedRecordStorage = new ObjectReplicatedRecordStorage(name, nodeEngine, cleanerRegistrator,
ReplicatedMapService.this);
break;
case BINARY:
replicatedRecordStorage = new DataReplicatedRecordStore(name, nodeEngine, cleanerRegistrator,
ReplicatedMapService.this);
break;
case OFFHEAP:
throw new IllegalStateException("offheap not yet supported for replicated map");
default:
throw new IllegalStateException("Unhandeled in memory format:" + inMemoryFormat);
}
return replicatedRecordStorage;
}
};
}
/**
* Listener implementation to listen on replication messages from other nodes
*/
private final class ReplicationListener
implements ReplicatedMessageListener {
public void onMessage(IdentifiedDataSerializable message) {
if (message instanceof ReplicationMessage) {
ReplicationMessage replicationMessage = (ReplicationMessage) message;
ReplicatedRecordStore replicatedRecordStorage = replicatedStorages.get(replicationMessage.getName());
ReplicationPublisher replicationPublisher = replicatedRecordStorage.getReplicationPublisher();
if (replicatedRecordStorage instanceof AbstractReplicatedRecordStore) {
replicationPublisher.queueUpdateMessage(replicationMessage);
}
} else if (message instanceof MultiReplicationMessage) {
MultiReplicationMessage multiReplicationMessage = (MultiReplicationMessage) message;
ReplicatedRecordStore replicatedRecordStorage = replicatedStorages.get(multiReplicationMessage.getName());
ReplicationPublisher replicationPublisher = replicatedRecordStorage.getReplicationPublisher();
if (replicatedRecordStorage instanceof AbstractReplicatedRecordStore) {
replicationPublisher.queueUpdateMessages(multiReplicationMessage);
}
}
}
}
/**
* The Cleaner is used to removed expired entries from the registered
* {@link com.hazelcast.replicatedmap.record.ReplicatedRecordStore}
*/
private static final class Cleaner
implements Runnable {
private final long ttl = TimeUnit.SECONDS.toMillis(10);
private final AbstractReplicatedRecordStore replicatedRecordStorage;
private Cleaner(AbstractReplicatedRecordStore replicatedRecordStorage) {
this.replicatedRecordStorage = replicatedRecordStorage;
}
public void run() {
final Iterator<ReplicatedRecord> iterator = replicatedRecordStorage.getRecords().iterator();
final long now = System.currentTimeMillis();
while (iterator.hasNext()) {
final ReplicatedRecord v = iterator.next();
if (v.getValue() == null && (v.getUpdateTime() + ttl) < now) {
iterator.remove();
}
}
}
}
}