com.hazelcast.config.TopicConfig Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2024, 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.config;
import com.hazelcast.internal.config.ConfigDataSerializerHook;
import com.hazelcast.nio.ObjectDataInput;
import com.hazelcast.nio.ObjectDataOutput;
import com.hazelcast.nio.serialization.IdentifiedDataSerializable;
import com.hazelcast.nio.serialization.impl.Versioned;
import com.hazelcast.topic.ITopic;
import javax.annotation.Nullable;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import static com.hazelcast.internal.cluster.Versions.V5_4;
import static com.hazelcast.internal.serialization.impl.SerializationUtil.readNullableList;
import static com.hazelcast.internal.serialization.impl.SerializationUtil.writeNullableList;
import static com.hazelcast.internal.util.Preconditions.checkHasText;
import static com.hazelcast.internal.util.Preconditions.isNotNull;
/**
* Contains the configuration for a {@link ITopic}.
*/
public class TopicConfig implements IdentifiedDataSerializable, NamedConfig, Versioned,
UserCodeNamespaceAwareConfig {
/**
* Default global ordering configuration.
*/
public static final boolean DEFAULT_GLOBAL_ORDERING_ENABLED = false;
private String name;
private boolean globalOrderingEnabled = DEFAULT_GLOBAL_ORDERING_ENABLED;
private boolean statisticsEnabled = true;
private boolean multiThreadingEnabled;
private List listenerConfigs;
private @Nullable String userCodeNamespace = DEFAULT_NAMESPACE;
/**
* Creates a TopicConfig.
*/
public TopicConfig() {
}
/**
* Creates a TopicConfig with the given name.
*
* @param name the name of the Topic
*/
public TopicConfig(String name) {
setName(name);
}
/**
* Creates a {@link TopicConfig} by cloning another TopicConfig.
*
* @param config the TopicConfig to clone
*/
public TopicConfig(TopicConfig config) {
isNotNull(config, "config");
this.name = config.name;
this.globalOrderingEnabled = config.globalOrderingEnabled;
this.multiThreadingEnabled = config.multiThreadingEnabled;
this.listenerConfigs = new ArrayList<>(config.getMessageListenerConfigs());
this.userCodeNamespace = config.userCodeNamespace;
}
/**
* Gets the name of the topic, null if nothing is set.
*
* @return the name of the topic
*/
@Override
public String getName() {
return name;
}
/**
* Sets the name of the topic.
*
* @param name the topic name to set
* @return the updated {@link TopicConfig}
* @throws IllegalArgumentException if name is {@code null} or an empty string
*/
@Override
public TopicConfig setName(String name) {
this.name = checkHasText(name, "name must contain text");
return this;
}
/**
* Checks if global ordering is enabled (all nodes listening to the same topic
* get their messages in the same order), or disabled (nodes get
* the messages in the order that the messages are published).
*
* @return true if global ordering is enabled, false if disabled
*/
public boolean isGlobalOrderingEnabled() {
return globalOrderingEnabled;
}
/**
* Enable global ordering (all nodes listening to the same topic
* get their messages in the same order), or disable it (nodes get
* the messages in the order that the messages are published).
*
* @param globalOrderingEnabled set to {@code true} to enable global ordering, {@code false} to disable
* @return the updated TopicConfig
*/
public TopicConfig setGlobalOrderingEnabled(boolean globalOrderingEnabled) {
if (this.multiThreadingEnabled && globalOrderingEnabled) {
throw new IllegalArgumentException("Global ordering can not be enabled when multi-threading is used.");
}
this.globalOrderingEnabled = globalOrderingEnabled;
return this;
}
/**
* Checks if multithreaded processing of incoming messages is enabled or not.
* When disabled only one dedicated thread will handle all topic messages. Otherwise,
* any thread from events thread pool can be used for message handling.
*
* @return {@code true} if multi-threading is enabled, {@code false} if disabled
*/
public boolean isMultiThreadingEnabled() {
return multiThreadingEnabled;
}
/**
* Enable multithreaded message handling. When enabled any thread from events
* thread pool can be used for incoming message processing. Otherwise, only one
* dedicated thread will be used to handle topic messages.
* Note: it can be enabled only in case when global ordering is disabled. Moreover,
* the local message ordering is not supported in this mode also. This means the
* messages produced by local publisher can be processed by several threads with
* no ordering guarantee.
*
* @param multiThreadingEnabled set to {@code true} to enable multithreaded message processing, {@code false} to disable
* @return the updated TopicConfig
*/
public TopicConfig setMultiThreadingEnabled(boolean multiThreadingEnabled) {
if (this.globalOrderingEnabled && multiThreadingEnabled) {
throw new IllegalArgumentException("Multi-threading can not be enabled when global ordering is used.");
}
this.multiThreadingEnabled = multiThreadingEnabled;
return this;
}
/**
* Adds a message listener to this topic (listens for when messages are added or removed).
*
* @param listenerConfig the message listener to add to this topic
*/
public TopicConfig addMessageListenerConfig(ListenerConfig listenerConfig) {
getMessageListenerConfigs().add(listenerConfig);
return this;
}
/**
* Gets the list of message listeners (listens for when messages are added or removed) for this topic.
*
* @return the list of message listeners for this topic
*/
public List getMessageListenerConfigs() {
if (listenerConfigs == null) {
listenerConfigs = new ArrayList<>();
}
return listenerConfigs;
}
/**
* Sets the list of message listeners (listens for when messages are added or removed) for this topic.
*
* @param listenerConfigs the list of message listeners for this topic
* @return this updated topic configuration
*/
public TopicConfig setMessageListenerConfigs(List listenerConfigs) {
this.listenerConfigs = listenerConfigs;
return this;
}
/**
* Checks if statistics are enabled for this topic.
*
* @return {@code true} if statistics are enabled, {@code false} otherwise
*/
public boolean isStatisticsEnabled() {
return statisticsEnabled;
}
/**
* Enables or disables statistics for this topic.
*
* @param statisticsEnabled {@code true} to enable statistics for this topic, {@code false} to disable
* @return the updated TopicConfig
*/
public TopicConfig setStatisticsEnabled(boolean statisticsEnabled) {
this.statisticsEnabled = statisticsEnabled;
return this;
}
/**
* {@inheritDoc}
*/
@Override
@Nullable
public String getUserCodeNamespace() {
return userCodeNamespace;
}
/**
* Associates the provided Namespace Name with this structure for {@link ClassLoader} awareness.
*
* The behaviour of setting this to {@code null} is outlined in the documentation for
* {@link UserCodeNamespaceAwareConfig#DEFAULT_NAMESPACE}.
*
* @param userCodeNamespace The ID of the Namespace to associate with this structure.
* @return the updated {@link TopicConfig} instance
* @since 5.4
*/
public TopicConfig setUserCodeNamespace(@Nullable String userCodeNamespace) {
this.userCodeNamespace = userCodeNamespace;
return this;
}
@Override
@SuppressWarnings({"checkstyle:cyclomaticcomplexity", "checkstyle:npathcomplexity"})
public final boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof TopicConfig that)) {
return false;
}
if (globalOrderingEnabled != that.globalOrderingEnabled) {
return false;
}
if (statisticsEnabled != that.statisticsEnabled) {
return false;
}
if (multiThreadingEnabled != that.multiThreadingEnabled) {
return false;
}
if (listenerConfigs != null && that.listenerConfigs != null && !listenerConfigs.equals(that.listenerConfigs)) {
return false;
}
if (listenerConfigs != null && that.listenerConfigs == null && !listenerConfigs.isEmpty()) {
return false;
}
if (listenerConfigs == null && that.listenerConfigs != null && !that.listenerConfigs.isEmpty()) {
return false;
}
if (!Objects.equals(userCodeNamespace, that.userCodeNamespace)) {
return false;
}
return name != null ? name.equals(that.name) : that.name == null;
}
@Override
@SuppressWarnings({"checkstyle:cyclomaticcomplexity", "checkstyle:npathcomplexity"})
public final int hashCode() {
int result = name != null ? name.hashCode() : 0;
result = 31 * result + (globalOrderingEnabled ? 1 : 0);
result = 31 * result + (statisticsEnabled ? 1 : 0);
result = 31 * result + (multiThreadingEnabled ? 1 : 0);
result = 31 * result + (listenerConfigs != null ? listenerConfigs.hashCode() : 0);
result = 31 * result + (userCodeNamespace != null ? userCodeNamespace.hashCode() : 0);
return result;
}
@Override
public String toString() {
return "TopicConfig [name=" + name
+ ", globalOrderingEnabled=" + globalOrderingEnabled
+ ", multiThreadingEnabled=" + multiThreadingEnabled
+ ", statisticsEnabled=" + statisticsEnabled
+ ", userCodeNamespace=" + userCodeNamespace
+ "]";
}
@Override
public int getFactoryId() {
return ConfigDataSerializerHook.F_ID;
}
@Override
public int getClassId() {
return ConfigDataSerializerHook.TOPIC_CONFIG;
}
@Override
public void writeData(ObjectDataOutput out) throws IOException {
out.writeString(name);
out.writeBoolean(globalOrderingEnabled);
out.writeBoolean(statisticsEnabled);
out.writeBoolean(multiThreadingEnabled);
writeNullableList(listenerConfigs, out);
// RU_COMPAT_5_3
if (out.getVersion().isGreaterOrEqual(V5_4)) {
out.writeString(userCodeNamespace);
}
}
@Override
public void readData(ObjectDataInput in) throws IOException {
name = in.readString();
globalOrderingEnabled = in.readBoolean();
statisticsEnabled = in.readBoolean();
multiThreadingEnabled = in.readBoolean();
listenerConfigs = readNullableList(in);
// RU_COMPAT_5_3
if (in.getVersion().isGreaterOrEqual(V5_4)) {
userCodeNamespace = in.readString();
}
}
}