[GitHub] merlimat commented on a change in pull request #1089: PIP-12 Introduce builder for creating Producer Consumer Reader
merlimat commented on a change in pull request #1089: PIP-12 Introduce builder
for creating Producer Consumer Reader
URL: https://github.com/apache/incubator-pulsar/pull/1089#discussion_r168927012
##
File path:
pulsar-client/src/main/java/org/apache/pulsar/client/api/ConsumerBuilder.java
##
@@ -0,0 +1,245 @@
+/**
+ * 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.api;
+
+import java.io.Serializable;
+import java.util.Map;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.TimeUnit;
+
+/**
+ * {@link ConsumerBuilder} is used to configure and create instances of {@link
Consumer}.
+ *
+ * @see PulsarClient#newConsumer()
+ *
+ * @since 2.0.0
+ */
+public interface ConsumerBuilder extends Serializable, Cloneable {
+
+/**
+ * Create a copy of the current consumer builder.
+ *
+ * Cloning the builder can be used to share an incomplete configuration
and specialize it multiple times. For
+ * example:
+ *
+ *
+ * ConsumerBuilder builder = client.newConsumer() //
+ * .subscriptionName("my-subscription-name") //
+ * .subscriptionType(SubscriptionType.Shared) //
+ * .receiverQueueSize(10);
+ *
+ * Consumer consumer1 = builder.clone().topic(TOPIC_1).subscribe();
+ * Consumer consumer2 = builder.clone().topic(TOPIC_2).subscribe();
+ *
+ */
+ConsumerBuilder clone();
+
+/**
+ * Finalize the {@link Consumer} creation by subscribing to the topic.
+ *
+ *
+ * If the subscription does not exist, a new subscription will be created
and all messages published after the
+ * creation will be retained until acknowledged, even if the consumer is
not connected.
+ *
+ * @return the {@link Consumer} instance
+ * @throws PulsarClientException
+ * if the the subscribe operation fails
+ */
+Consumer subscribe() throws PulsarClientException;
+
+/**
+ * Finalize the {@link Consumer} creation by subscribing to the topic in
asynchronous mode.
+ *
+ *
+ * If the subscription does not exist, a new subscription will be created
and all messages published after the
+ * creation will be retained until acknowledged, even if the consumer is
not connected.
+ *
+ * @return a future that will yield a {@link Consumer} instance
+ * @throws PulsarClientException
+ * if the the subscribe operation fails
+ */
+CompletableFuture subscribeAsync();
+
+/**
+ * Specify the topic this consumer will subscribe on.
+ *
+ * This argument is required when constructing the consumer.
+ *
+ * @param topicName
+ */
+ConsumerBuilder topic(String topicName);
Review comment:
For parsing, it's already all concentrated in the `DestinationName` class,
which I plan to rename into `TopicName`. It is not exposed to users though.
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
[GitHub] merlimat commented on a change in pull request #1089: PIP-12 Introduce builder for creating Producer Consumer Reader
merlimat commented on a change in pull request #1089: PIP-12 Introduce builder
for creating Producer Consumer Reader
URL: https://github.com/apache/incubator-pulsar/pull/1089#discussion_r168642225
##
File path:
pulsar-client/src/main/java/org/apache/pulsar/client/api/ClientBuilder.java
##
@@ -0,0 +1,265 @@
+/**
+ * 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.api;
+
+import java.io.Serializable;
+import java.util.Map;
+import java.util.concurrent.TimeUnit;
+
+import
org.apache.pulsar.client.api.PulsarClientException.UnsupportedAuthenticationException;
+
+/**
+ * Builder interface that is used to construct a {@link PulsarClient} instance.
+ *
+ * @since 2.0.0
+ */
+public interface ClientBuilder extends Serializable, Cloneable {
+
+/**
+ * @return the new {@link PulsarClient} instance
+ */
+PulsarClient build() throws PulsarClientException;
+
+/**
+ * Create a copy of the current client builder.
+ *
+ * Cloning the builder can be used to share an incomplete configuration
and specialize it multiple times. For
+ * example:
+ *
+ *
+ * ClientBuilder builder =
PulsarClient.builder().ioThreads(8).listenerThreads(4);
+ *
+ * PulsarClient client1 = builder.clone().serviceUrl(URL_1).build();
+ * PulsarClient client2 = builder.clone().serviceUrl(URL_2).build();
+ *
+ */
+ClientBuilder clone();
+
+/**
+ * Configure the service URL for the Pulsar service.
+ *
+ * This parameter is required
+ *
+ * @param serviceUrl
+ * @return
+ */
+ClientBuilder serviceUrl(String serviceUrl);
+
+/**
+ * Set the authentication provider to use in the Pulsar client instance.
+ *
+ * Example:
+ *
+ *
+ *
+ *
+ * String AUTH_CLASS =
"org.apache.pulsar.client.impl.auth.AuthenticationTls";
+ *
+ * Map conf = new TreeMap<>();
+ * conf.put("tlsCertFile", "/my/cert/file");
+ * conf.put("tlsKeyFile", "/my/key/file");
+ *
+ * Authentication auth = AuthenticationFactor.create(AUTH_CLASS, conf);
+ *
+ * PulsarClient client = PulsarClient.builder()
+ * .serviceUrl(SERVICE_URL)
+ * .authentication(auth)
+ * .build();
+ *
+ *
+ *
+ *
+ * @param authentication
+ *an instance of the {@link Authentication} provider already
constructed
+ */
+ClientBuilder authentication(Authentication authentication);
+
+/**
+ * Set the authentication provider to use in the Pulsar client instance.
+ *
+ * Example:
+ *
+ *
+ *
+ *
+ * String AUTH_CLASS =
"org.apache.pulsar.client.impl.auth.AuthenticationTls";
+ * String AUTH_PARAMS =
"tlsCertFile:/my/cert/file,tlsKeyFile:/my/key/file";
+ *
+ * PulsarClient client = PulsarClient.builder()
+ * .serviceUrl(SERVICE_URL)
+ * .authentication(AUTH_CLASS, AUTH_PARAMS)
+ * .build();
+ *
+ *
+ *
+ *
+ * @param authPluginClassName
+ *name of the Authentication-Plugin you want to use
+ * @param authParamsString
+ *string which represents parameters for the
Authentication-Plugin, e.g., "key1:val1,key2:val2"
+ * @throws UnsupportedAuthenticationException
+ * failed to instantiate specified Authentication-Plugin
+ */
+ClientBuilder authentication(String authPluginClassName, String
authParamsString)
+throws UnsupportedAuthenticationException;
+
+/**
+ * Set the authentication provider to use in the Pulsar client instance.
+ *
+ * Example:
+ *
+ *
+ *
+ *
+ * String AUTH_CLASS =
"org.apache.pulsar.client.impl.auth.AuthenticationTls";
+ *
+ * Map conf = new TreeMap<>();
+ * conf.put("tlsCertFile", "/my/cert/file");
+ * conf.put("tlsKeyFile", "/my/key/file");
+ *
+ * PulsarClient client = PulsarClient.builder()
+ * .serviceUrl(SERVICE_URL)
+ * .authentication(AUTH_CLASS, conf)
+ * .build();
+ *
+ *
+ *
[GitHub] merlimat commented on a change in pull request #1089: PIP-12 Introduce builder for creating Producer Consumer Reader
merlimat commented on a change in pull request #1089: PIP-12 Introduce builder
for creating Producer Consumer Reader
URL: https://github.com/apache/incubator-pulsar/pull/1089#discussion_r168641196
##
File path:
pulsar-client/src/main/java/org/apache/pulsar/client/api/ClientBuilder.java
##
@@ -0,0 +1,265 @@
+/**
+ * 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.api;
+
+import java.io.Serializable;
+import java.util.Map;
+import java.util.concurrent.TimeUnit;
+
+import
org.apache.pulsar.client.api.PulsarClientException.UnsupportedAuthenticationException;
+
+/**
+ * Builder interface that is used to construct a {@link PulsarClient} instance.
+ *
+ * @since 2.0.0
+ */
+public interface ClientBuilder extends Serializable, Cloneable {
+
+/**
+ * @return the new {@link PulsarClient} instance
+ */
+PulsarClient build() throws PulsarClientException;
+
+/**
+ * Create a copy of the current client builder.
+ *
+ * Cloning the builder can be used to share an incomplete configuration
and specialize it multiple times. For
+ * example:
+ *
+ *
+ * ClientBuilder builder =
PulsarClient.builder().ioThreads(8).listenerThreads(4);
+ *
+ * PulsarClient client1 = builder.clone().serviceUrl(URL_1).build();
+ * PulsarClient client2 = builder.clone().serviceUrl(URL_2).build();
+ *
+ */
+ClientBuilder clone();
+
+/**
+ * Configure the service URL for the Pulsar service.
+ *
+ * This parameter is required
+ *
+ * @param serviceUrl
+ * @return
+ */
+ClientBuilder serviceUrl(String serviceUrl);
+
+/**
+ * Set the authentication provider to use in the Pulsar client instance.
+ *
+ * Example:
+ *
+ *
+ *
+ *
+ * String AUTH_CLASS =
"org.apache.pulsar.client.impl.auth.AuthenticationTls";
+ *
+ * Map conf = new TreeMap<>();
+ * conf.put("tlsCertFile", "/my/cert/file");
+ * conf.put("tlsKeyFile", "/my/key/file");
+ *
+ * Authentication auth = AuthenticationFactor.create(AUTH_CLASS, conf);
+ *
+ * PulsarClient client = PulsarClient.builder()
+ * .serviceUrl(SERVICE_URL)
+ * .authentication(auth)
+ * .build();
+ *
+ *
+ *
+ *
+ * @param authentication
+ *an instance of the {@link Authentication} provider already
constructed
+ */
+ClientBuilder authentication(Authentication authentication);
+
+/**
+ * Set the authentication provider to use in the Pulsar client instance.
+ *
+ * Example:
+ *
+ *
+ *
+ *
+ * String AUTH_CLASS =
"org.apache.pulsar.client.impl.auth.AuthenticationTls";
+ * String AUTH_PARAMS =
"tlsCertFile:/my/cert/file,tlsKeyFile:/my/key/file";
+ *
+ * PulsarClient client = PulsarClient.builder()
+ * .serviceUrl(SERVICE_URL)
+ * .authentication(AUTH_CLASS, AUTH_PARAMS)
+ * .build();
+ *
+ *
+ *
+ *
+ * @param authPluginClassName
+ *name of the Authentication-Plugin you want to use
+ * @param authParamsString
+ *string which represents parameters for the
Authentication-Plugin, e.g., "key1:val1,key2:val2"
+ * @throws UnsupportedAuthenticationException
+ * failed to instantiate specified Authentication-Plugin
+ */
+ClientBuilder authentication(String authPluginClassName, String
authParamsString)
+throws UnsupportedAuthenticationException;
+
+/**
+ * Set the authentication provider to use in the Pulsar client instance.
+ *
+ * Example:
+ *
+ *
+ *
+ *
+ * String AUTH_CLASS =
"org.apache.pulsar.client.impl.auth.AuthenticationTls";
+ *
+ * Map conf = new TreeMap<>();
+ * conf.put("tlsCertFile", "/my/cert/file");
+ * conf.put("tlsKeyFile", "/my/key/file");
+ *
+ * PulsarClient client = PulsarClient.builder()
+ * .serviceUrl(SERVICE_URL)
+ * .authentication(AUTH_CLASS, conf)
+ * .build();
+ *
+ *
+ *
[GitHub] merlimat commented on a change in pull request #1089: PIP-12 Introduce builder for creating Producer Consumer Reader
merlimat commented on a change in pull request #1089: PIP-12 Introduce builder
for creating Producer Consumer Reader
URL: https://github.com/apache/incubator-pulsar/pull/1089#discussion_r168237399
##
File path:
pulsar-client/src/main/java/org/apache/pulsar/client/api/ClientBuilder.java
##
@@ -0,0 +1,263 @@
+/**
+ * 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.api;
+
+import java.io.Serializable;
+import java.util.Map;
+import java.util.concurrent.TimeUnit;
+
+import
org.apache.pulsar.client.api.PulsarClientException.UnsupportedAuthenticationException;
+
+/**
+ * Builder interface that is used to construct a {@link PulsarClient} instance.
+ */
+public interface ClientBuilder extends Serializable, Cloneable {
+
+/**
+ * @return the new {@link PulsarClient} instance
+ */
+PulsarClient build() throws PulsarClientException;
+
+/**
+ * Create a copy of the current client builder.
+ *
+ * Cloning the builder can be used to share an incomplete configuration
and specialize it multiple times. For
+ * example:
+ *
+ *
+ * ClientBuilder builder =
PulsarClient.builder().ioThreads(8).listenerThreads(4);
+ *
+ * PulsarClient client1 = builder.clone().serviceUrl(URL_1).build();
+ * PulsarClient client2 = builder.clone().serviceUrl(URL_2).build();
+ *
+ */
+ClientBuilder clone();
Review comment:
`clone()` is a bit weird in the way it's treated. It cannot be marked as
`@Override`
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
[GitHub] merlimat commented on a change in pull request #1089: PIP-12 Introduce builder for creating Producer Consumer Reader
merlimat commented on a change in pull request #1089: PIP-12 Introduce builder
for creating Producer Consumer Reader
URL: https://github.com/apache/incubator-pulsar/pull/1089#discussion_r168236993
##
File path:
pulsar-client/src/main/java/org/apache/pulsar/client/api/ClientBuilder.java
##
@@ -0,0 +1,263 @@
+/**
+ * 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.api;
+
+import java.io.Serializable;
+import java.util.Map;
+import java.util.concurrent.TimeUnit;
+
+import
org.apache.pulsar.client.api.PulsarClientException.UnsupportedAuthenticationException;
+
+/**
+ * Builder interface that is used to construct a {@link PulsarClient} instance.
Review comment:
Sure, will add `@since`
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
[GitHub] merlimat commented on a change in pull request #1089: PIP-12 Introduce builder for creating Producer Consumer Reader
merlimat commented on a change in pull request #1089: PIP-12 Introduce builder
for creating Producer Consumer Reader
URL: https://github.com/apache/incubator-pulsar/pull/1089#discussion_r168236725
##
File path:
pulsar-client/src/main/java/org/apache/pulsar/client/api/ConsumerBuilder.java
##
@@ -0,0 +1,230 @@
+/**
+ * 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.api;
+
+import java.io.Serializable;
+import java.util.Map;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.TimeUnit;
+
+/**
+ * {@link ConsumerBuilder} is used to configure and create instances of {@link
Consumer}.
+ *
+ * @see PulsarClient#newConsumer()
+ */
+public interface ConsumerBuilder extends Serializable, Cloneable {
+
+/**
+ * Create a copy of the current consumer builder.
+ *
+ * Cloning the builder can be used to share an incomplete configuration
and specialize it multiple times. For
+ * example:
+ *
+ *
+ * ConsumerBuilder builder = client.newConsumer() //
+ * .subscriptionName("my-subscription-name") //
+ * .subscriptionType(SubscriptionType.Shared) //
+ * .receiverQueueSize(10);
+ *
+ * Consumer consumer1 = builder.clone().topic(TOPIC_1).subscribe();
+ * Consumer consumer2 = builder.clone().topic(TOPIC_2).subscribe();
+ *
+ */
+ConsumerBuilder clone();
+
+/**
+ * Finalize the consumer creation by subscribing to the topic.
+ *
+ *
+ * Subscribing to the c
Review comment:
ups, forgot to finish
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
