com.hazelcast.config.CollectionConfig 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 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.checkAsyncBackupCount;
import static com.hazelcast.internal.util.Preconditions.checkBackupCount;
import static com.hazelcast.internal.util.Preconditions.checkNotNull;
/**
* Provides configuration service for Collection.
*
* @param Type of Collection such as List, Set
*/
public abstract class CollectionConfig
implements IdentifiedDataSerializable, NamedConfig, Versioned, UserCodeNamespaceAwareConfig> {
/**
* Default maximum size for the Configuration.
*/
public static final int DEFAULT_MAX_SIZE = 0;
/**
* The default number of synchronous backups
*/
public static final int DEFAULT_SYNC_BACKUP_COUNT = 1;
/**
* The default number of asynchronous backups
*/
public static final int DEFAULT_ASYNC_BACKUP_COUNT = 0;
private String name;
private List listenerConfigs;
private int backupCount = DEFAULT_SYNC_BACKUP_COUNT;
private int asyncBackupCount = DEFAULT_ASYNC_BACKUP_COUNT;
private int maxSize = DEFAULT_MAX_SIZE;
private boolean statisticsEnabled = true;
private String splitBrainProtectionName;
private MergePolicyConfig mergePolicyConfig = new MergePolicyConfig();
private @Nullable String userCodeNamespace = DEFAULT_NAMESPACE;
protected CollectionConfig() {
}
protected CollectionConfig(CollectionConfig config) {
this.name = config.name;
this.listenerConfigs = new ArrayList<>(config.getItemListenerConfigs());
this.backupCount = config.backupCount;
this.asyncBackupCount = config.asyncBackupCount;
this.maxSize = config.maxSize;
this.statisticsEnabled = config.statisticsEnabled;
this.splitBrainProtectionName = config.splitBrainProtectionName;
this.mergePolicyConfig = new MergePolicyConfig(config.mergePolicyConfig);
this.userCodeNamespace = config.userCodeNamespace;
}
/**
* Gets the name of this collection.
*
* @return the name of this collection
*/
public String getName() {
return name;
}
/**
* Sets the name of this collection.
*
* @param name the name of this collection
* @return the updated collection configuration
*/
public T setName(String name) {
this.name = name;
return (T) this;
}
/**
* Gets the list of ItemListenerConfigs.
*
* @return the list of ItemListenerConfigs
*/
public List getItemListenerConfigs() {
if (listenerConfigs == null) {
listenerConfigs = new ArrayList<>();
}
return listenerConfigs;
}
/**
* Sets the list of ItemListenerConfigs.
*
* @param listenerConfigs the list of ItemListenerConfigs to set
* @return this collection configuration
*/
public T setItemListenerConfigs(List listenerConfigs) {
this.listenerConfigs = listenerConfigs;
return (T) this;
}
/**
* Gets the total number of synchronous and asynchronous backups for this collection.
*
* @return the total number of synchronous and asynchronous backups for this collection
*/
public int getTotalBackupCount() {
return backupCount + asyncBackupCount;
}
/**
* Gets the number of synchronous backups for this collection.
*
* @return the number of synchronous backups for this collection
*/
public int getBackupCount() {
return backupCount;
}
/**
* Sets the number of synchronous backups for this collection.
*
* @param backupCount the number of synchronous backups to set for this collection
* @return the current CollectionConfig
* @throws IllegalArgumentException if backupCount smaller than 0,
* or larger than the maximum number of backup
* or the sum of the backups and async backups is larger than the maximum number of backups
* @see #setAsyncBackupCount(int)
*/
public T setBackupCount(int backupCount) {
this.backupCount = checkBackupCount(backupCount, asyncBackupCount);
return (T) this;
}
/**
* Gets the number of asynchronous backups.
*
* @return the number of asynchronous backups
*/
public int getAsyncBackupCount() {
return asyncBackupCount;
}
/**
* Sets the number of asynchronous backups.
*
* @param asyncBackupCount the number of asynchronous synchronous backups to set
* @return the updated CollectionConfig
* @throws IllegalArgumentException if asyncBackupCount is smaller than 0,
* or larger than the maximum number of backups,
* or the sum of the backups and async backups is larger than the maximum number of backups.
* @see #setBackupCount(int)
* @see #getAsyncBackupCount()
*/
public T setAsyncBackupCount(int asyncBackupCount) {
this.asyncBackupCount = checkAsyncBackupCount(asyncBackupCount, asyncBackupCount);
return (T) this;
}
/**
* Gets the maximum size for the Configuration.
*
* @return the maximum size for the Configuration
*/
public int getMaxSize() {
return maxSize == 0 ? Integer.MAX_VALUE : maxSize;
}
/**
* Sets the maximum size for the collection.
*
* @return the current CollectionConfig
*/
public T setMaxSize(int maxSize) {
this.maxSize = maxSize;
return (T) this;
}
/**
* Checks if collection statistics are enabled.
*
* @return {@code true} if collection statistics are enabled, {@code false} otherwise
*/
public boolean isStatisticsEnabled() {
return statisticsEnabled;
}
/**
* Sets collection statistics to enabled or disabled.
*
* @param statisticsEnabled {@code true} to enable collection statistics, {@code false} to disable
* @return the current collection config instance
*/
public T setStatisticsEnabled(boolean statisticsEnabled) {
this.statisticsEnabled = statisticsEnabled;
return (T) this;
}
/**
* Adds an item listener to this collection (listens for when items are added or removed).
*
* @param itemListenerConfig the item listener to add to this collection
* @return this configuration
*/
public T addItemListenerConfig(ItemListenerConfig itemListenerConfig) {
getItemListenerConfigs().add(itemListenerConfig);
return (T) this;
}
/**
* Returns the split brain protection name for operations.
*
* @return the split brain protection name
*/
public String getSplitBrainProtectionName() {
return splitBrainProtectionName;
}
/**
* Sets the split brain protection name for operations.
*
* @param splitBrainProtectionName the split brain protection name
* @return the updated configuration
*/
public T setSplitBrainProtectionName(String splitBrainProtectionName) {
this.splitBrainProtectionName = splitBrainProtectionName;
return (T) this;
}
/**
* Gets the {@link MergePolicyConfig} for the collection.
*
* @return the {@link MergePolicyConfig} for the collection
*/
public MergePolicyConfig getMergePolicyConfig() {
return mergePolicyConfig;
}
/**
* Sets the {@link MergePolicyConfig} for the collection.
*
* @return the current CollectionConfig
*/
public T setMergePolicyConfig(MergePolicyConfig mergePolicyConfig) {
this.mergePolicyConfig = checkNotNull(mergePolicyConfig, "mergePolicyConfig cannot be null");
return (T) 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 CollectionConfig} instance
* @since 5.4
*/
public T setUserCodeNamespace(@Nullable String userCodeNamespace) {
this.userCodeNamespace = userCodeNamespace;
return (T) this;
}
@Override
public int getFactoryId() {
return ConfigDataSerializerHook.F_ID;
}
@Override
public void writeData(ObjectDataOutput out) throws IOException {
out.writeString(name);
writeNullableList(listenerConfigs, out);
out.writeInt(backupCount);
out.writeInt(asyncBackupCount);
out.writeInt(maxSize);
out.writeBoolean(statisticsEnabled);
out.writeString(splitBrainProtectionName);
out.writeObject(mergePolicyConfig);
// RU_COMPAT_5_3
if (out.getVersion().isGreaterOrEqual(V5_4)) {
out.writeString(userCodeNamespace);
}
}
@Override
public void readData(ObjectDataInput in) throws IOException {
name = in.readString();
listenerConfigs = readNullableList(in);
backupCount = in.readInt();
asyncBackupCount = in.readInt();
maxSize = in.readInt();
statisticsEnabled = in.readBoolean();
splitBrainProtectionName = in.readString();
mergePolicyConfig = in.readObject();
// RU_COMPAT_5_3
if (in.getVersion().isGreaterOrEqual(V5_4)) {
userCodeNamespace = in.readString();
}
}
@Override
@SuppressWarnings({"checkstyle:cyclomaticcomplexity", "checkstyle:npathcomplexity"})
public final boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof CollectionConfig)) {
return false;
}
CollectionConfig that = (CollectionConfig) o;
if (backupCount != that.backupCount) {
return false;
}
if (asyncBackupCount != that.asyncBackupCount) {
return false;
}
if (getMaxSize() != that.getMaxSize()) {
return false;
}
if (statisticsEnabled != that.statisticsEnabled) {
return false;
}
if (!Objects.equals(name, that.name)) {
return false;
}
if (!Objects.equals(splitBrainProtectionName, that.splitBrainProtectionName)) {
return false;
}
if (!Objects.equals(mergePolicyConfig, that.mergePolicyConfig)) {
return false;
}
if (!Objects.equals(userCodeNamespace, that.userCodeNamespace)) {
return false;
}
return getItemListenerConfigs().equals(that.getItemListenerConfigs());
}
@Override
public final int hashCode() {
int result = name != null ? name.hashCode() : 0;
result = 31 * result + getItemListenerConfigs().hashCode();
result = 31 * result + backupCount;
result = 31 * result + asyncBackupCount;
result = 31 * result + getMaxSize();
result = 31 * result + (statisticsEnabled ? 1 : 0);
result = 31 * result + (splitBrainProtectionName != null ? splitBrainProtectionName.hashCode() : 0);
result = 31 * result + (mergePolicyConfig != null ? mergePolicyConfig.hashCode() : 0);
result = 31 * result + (userCodeNamespace != null ? userCodeNamespace.hashCode() : 0);
return result;
}
/**
* Returns field names with values as concatenated String so it can be used in child classes' toString() methods.
*/
protected String fieldsToString() {
return "name='" + name
+ "', listenerConfigs=" + listenerConfigs
+ ", backupCount=" + backupCount
+ ", asyncBackupCount=" + asyncBackupCount
+ ", maxSize=" + maxSize
+ ", statisticsEnabled=" + statisticsEnabled
+ ", splitBrainProtectionName='" + splitBrainProtectionName + "'"
+ ", mergePolicyConfig='" + mergePolicyConfig + "'"
+ ", userCodeNamespace='" + userCodeNamespace + "'";
}
}