org.apache.pulsar.client.impl.ReaderBuilderImpl Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.pulsar.client.impl;
import static org.apache.pulsar.shade.com.google.common.base.Preconditions.checkArgument;
import static org.apache.pulsar.client.api.KeySharedPolicy.DEFAULT_HASH_RANGE_SIZE;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.TimeUnit;
import java.util.stream.Collectors;
import lombok.AccessLevel;
import lombok.Getter;
import lombok.NonNull;
import org.apache.pulsar.shade.org.apache.commons.lang3.StringUtils;
import org.apache.pulsar.client.api.ConsumerCryptoFailureAction;
import org.apache.pulsar.client.api.CryptoKeyReader;
import org.apache.pulsar.client.api.MessageCrypto;
import org.apache.pulsar.client.api.MessageId;
import org.apache.pulsar.client.api.PulsarClientException;
import org.apache.pulsar.client.api.Range;
import org.apache.pulsar.client.api.Reader;
import org.apache.pulsar.client.api.ReaderBuilder;
import org.apache.pulsar.client.api.ReaderInterceptor;
import org.apache.pulsar.client.api.ReaderListener;
import org.apache.pulsar.client.api.Schema;
import org.apache.pulsar.client.impl.conf.ConfigurationDataUtils;
import org.apache.pulsar.client.impl.conf.ReaderConfigurationData;
import org.apache.pulsar.common.util.FutureUtil;
@Getter(AccessLevel.PUBLIC)
public class ReaderBuilderImpl implements ReaderBuilder {
private final PulsarClientImpl client;
private ReaderConfigurationData conf;
private final Schema schema;
public ReaderBuilderImpl(PulsarClientImpl client, Schema schema) {
this(client, new ReaderConfigurationData(), schema);
}
private ReaderBuilderImpl(PulsarClientImpl client, ReaderConfigurationData conf, Schema schema) {
this.client = client;
this.conf = conf;
this.schema = schema;
}
@Override
@SuppressWarnings("unchecked")
public ReaderBuilder clone() {
return new ReaderBuilderImpl<>(client, conf.clone(), schema);
}
@Override
public Reader create() throws PulsarClientException {
try {
return createAsync().get();
} catch (Exception e) {
throw PulsarClientException.unwrap(e);
}
}
@Override
public CompletableFuture> createAsync() {
if (conf.getTopicNames().isEmpty()) {
return FutureUtil
.failedFuture(new IllegalArgumentException("Topic name must be set on the reader builder"));
}
if (conf.getStartMessageId() != null && conf.getStartMessageFromRollbackDurationInSec() > 0
|| conf.getStartMessageId() == null && conf.getStartMessageFromRollbackDurationInSec() <= 0) {
return FutureUtil
.failedFuture(new IllegalArgumentException(
"Start message id or start message from roll back must be specified but they cannot be"
+ " specified at the same time"));
}
if (conf.getStartMessageFromRollbackDurationInSec() > 0) {
conf.setStartMessageId(MessageId.earliest);
}
return client.createReaderAsync(conf, schema);
}
@Override
public ReaderBuilder loadConf(Map config) {
MessageId startMessageId = conf.getStartMessageId();
conf = ConfigurationDataUtils.loadData(config, conf, ReaderConfigurationData.class);
conf.setStartMessageId(startMessageId);
return this;
}
@Override
public ReaderBuilder topic(String topicName) {
conf.setTopicName(StringUtils.trim(topicName));
return this;
}
@Override
public ReaderBuilder topics(List topicNames) {
checkArgument(topicNames != null && topicNames.size() > 0,
"Passed in topicNames should not be null or empty.");
topicNames.forEach(topicName ->
checkArgument(StringUtils.isNotBlank(topicName), "topicNames cannot have blank topic"));
conf.getTopicNames().addAll(topicNames.stream().map(StringUtils::trim)
.collect(Collectors.toList()));
return this;
}
@Override
public ReaderBuilder startMessageId(MessageId startMessageId) {
conf.setStartMessageId(startMessageId);
return this;
}
@Override
public ReaderBuilder startMessageFromRollbackDuration(long rollbackDuration, TimeUnit timeunit) {
conf.setStartMessageFromRollbackDurationInSec(timeunit.toSeconds(rollbackDuration));
return this;
}
@Override
public ReaderBuilder startMessageIdInclusive() {
conf.setResetIncludeHead(true);
return this;
}
@Override
public ReaderBuilder readerListener(ReaderListener readerListener) {
conf.setReaderListener(readerListener);
return this;
}
@Override
public ReaderBuilder cryptoKeyReader(CryptoKeyReader cryptoKeyReader) {
conf.setCryptoKeyReader(cryptoKeyReader);
return this;
}
@Override
public ReaderBuilder defaultCryptoKeyReader(String privateKey) {
checkArgument(StringUtils.isNotBlank(privateKey), "privateKey cannot be blank");
return cryptoKeyReader(DefaultCryptoKeyReader.builder().defaultPrivateKey(privateKey).build());
}
@Override
public ReaderBuilder defaultCryptoKeyReader(@NonNull Map privateKeys) {
checkArgument(!privateKeys.isEmpty(), "privateKeys cannot be empty");
return cryptoKeyReader(DefaultCryptoKeyReader.builder().privateKeys(privateKeys).build());
}
@Override
public ReaderBuilder cryptoFailureAction(ConsumerCryptoFailureAction action) {
conf.setCryptoFailureAction(action);
return this;
}
@Override
public ReaderBuilder messageCrypto(MessageCrypto messageCrypto) {
conf.setMessageCrypto(messageCrypto);
return this;
}
@Override
public ReaderBuilder receiverQueueSize(int receiverQueueSize) {
checkArgument(receiverQueueSize >= 0, "receiverQueueSize needs to be >= 0");
conf.setReceiverQueueSize(receiverQueueSize);
return this;
}
@Override
public ReaderBuilder readerName(String readerName) {
conf.setReaderName(readerName);
return this;
}
@Override
public ReaderBuilder subscriptionRolePrefix(String subscriptionRolePrefix) {
conf.setSubscriptionRolePrefix(subscriptionRolePrefix);
return this;
}
@Override
public ReaderBuilder subscriptionName(String subscriptionName) {
conf.setSubscriptionName(subscriptionName);
return this;
}
@Override
public ReaderBuilder readCompacted(boolean readCompacted) {
conf.setReadCompacted(readCompacted);
return this;
}
@Override
public ReaderBuilder keyHashRange(Range... ranges) {
checkArgument(ranges != null && ranges.length > 0,
"Cannot specify a null ofr an empty key hash ranges for a reader");
for (int i = 0; i < ranges.length; i++) {
Range range1 = ranges[i];
if (range1.getStart() < 0 || range1.getEnd() > DEFAULT_HASH_RANGE_SIZE) {
throw new IllegalArgumentException("Ranges must be [0, 65535] but provided range is " + range1);
}
for (int j = 0; j < ranges.length; j++) {
Range range2 = ranges[j];
if (i != j && range1.intersect(range2) != null) {
throw new IllegalArgumentException("Key hash ranges with overlap between " + range1
+ " and " + range2);
}
}
}
conf.setKeyHashRanges(Arrays.asList(ranges));
return this;
}
@Override
public ReaderBuilder poolMessages(boolean poolMessages) {
conf.setPoolMessages(poolMessages);
return this;
}
@Override
public ReaderBuilder autoUpdatePartitions(boolean autoUpdate) {
this.conf.setAutoUpdatePartitions(autoUpdate);
return this;
}
@Override
public ReaderBuilder autoUpdatePartitionsInterval(int interval, TimeUnit unit) {
long intervalSeconds = unit.toSeconds(interval);
checkArgument(intervalSeconds >= 1, "Auto update partition interval needs to be >= 1 second");
this.conf.setAutoUpdatePartitionsIntervalSeconds(intervalSeconds);
return this;
}
@Override
public ReaderBuilder intercept(ReaderInterceptor... interceptors) {
if (interceptors != null) {
this.conf.setReaderInterceptorList(Arrays.asList(interceptors));
}
return this;
}
@Override
public ReaderBuilder maxPendingChunkedMessage(int maxPendingChunkedMessage) {
conf.setMaxPendingChunkedMessage(maxPendingChunkedMessage);
return this;
}
@Override
public ReaderBuilder autoAckOldestChunkedMessageOnQueueFull(boolean autoAckOldestChunkedMessageOnQueueFull) {
conf.setAutoAckOldestChunkedMessageOnQueueFull(autoAckOldestChunkedMessageOnQueueFull);
return this;
}
@Override
public ReaderBuilder expireTimeOfIncompleteChunkedMessage(long duration, TimeUnit unit) {
conf.setExpireTimeOfIncompleteChunkedMessageMillis(unit.toMillis(duration));
return this;
}
}