Added Partitioned Queue Snippets (#30)

Author: mayur-solace

build.gradle

@@ -52,7 +52,7 @@ repositories {
 
 dependencies {
     // Solace Messaging API for Java Dependencies
-    implementation group: 'com.solace', name: 'solace-messaging-client', version: '1.2.0'
+    implementation group: 'com.solace', name: 'solace-messaging-client', version: '1.4.0'
 
     implementation group: 'org.apache.logging.log4j', name: 'log4j-api', version: '2.17.2'
     implementation group: 'org.apache.logging.log4j', name: 'log4j-core', version: '2.17.2'

pom.xml

@@ -10,7 +10,7 @@
     <dependency>
       <groupId>com.solace</groupId>
       <artifactId>solace-messaging-client</artifactId>
-      <version>1.2.0</version>
+      <version>1.4.0</version>
     </dependency>
     <dependency>
       <groupId>org.apache.logging.log4j</groupId>

src/main/java/com/solace/samples/java/snippets/HowToCreateOutboundMessagesWithPartitionKey.java

@@ -0,0 +1,71 @@
+package com.solace.samples.java.snippets;
+
+import com.solace.messaging.MessagingService;
+import com.solace.messaging.config.SolaceConstants.MessageUserPropertyConstants;
+import com.solace.messaging.publisher.OutboundMessage;
+import com.solace.messaging.publisher.OutboundMessageBuilder;
+import java.util.Properties;
+
+public class HowToCreateOutboundMessagesWithPartitionKey {
+
+
+  /**
+   * This example demonstrates how to set partition key using {@link OutboundMessageBuilder#withProperty(String,
+   * String)}. This example demonstrates a DISPOSABLE single use {@link OutboundMessageBuilder}. We
+   * recommend for performance purposes to reuse builder (one or multiple) instance to produce
+   * {@link OutboundMessage} instances
+   *
+   * @param service instance of a messaging service
+   * @param payload just a random byte payload
+   * @return ready to go message
+   */
+  public static OutboundMessage createMessageWithPartitionKeyUsingWithProperty(
+      MessagingService service, byte[] payload) {
+    final String samplePartitionKey = "Group_0";
+    final OutboundMessage myCustomMessage = service.messageBuilder()
+        .withProperty(MessageUserPropertyConstants.QUEUE_PARTITION_KEY, samplePartitionKey)
+        .build(payload);
+    return myCustomMessage;
+  }
+
+  /**
+   * This example demonstrates how to set partition key using {@link OutboundMessageBuilder#build(byte[],
+   * Properties)}. This example demonstrates a DISPOSABLE single use {@link OutboundMessageBuilder}.
+   * We recommend for performance purposes to reuse builder (one or multiple) instance to produce
+   * {@link OutboundMessage} instances
+   *
+   * @param service instance of a messaging service
+   * @param payload just a random byte payload
+   * @return ready to go message
+   */
+  public static OutboundMessage createMessageWithPartitionKeyUsingBuildMethodProperties(
+      MessagingService service, byte[] payload) {
+    final Properties properties = new Properties();
+    final String samplePartitionKey = "Group_0";
+    properties.setProperty(MessageUserPropertyConstants.QUEUE_PARTITION_KEY, samplePartitionKey);
+    final OutboundMessage myCustomMessage = service.messageBuilder()
+        .build(payload, properties);
+    return myCustomMessage;
+  }
+
+  /**
+   * This example demonstrates how to set partition key using {@link OutboundMessageBuilder#fromProperties(Properties)}.
+   * This example demonstrates a DISPOSABLE single use {@link OutboundMessageBuilder}. We recommend
+   * for performance purposes to reuse builder (one or multiple) instance to produce {@link
+   * OutboundMessage} instances
+   *
+   * @param service instance of a messaging service
+   * @param payload just a random byte payload
+   * @return ready to go message
+   */
+  public static OutboundMessage createMessageWithPartitionKeyUsingFromProperties(
+      MessagingService service, byte[] payload) {
+    final Properties properties = new Properties();
+    final String samplePartitionKey = "Group_0";
+    properties.setProperty(MessageUserPropertyConstants.QUEUE_PARTITION_KEY, samplePartitionKey);
+    final OutboundMessage myCustomMessage = service.messageBuilder()
+        .fromProperties(properties)
+        .build(payload);
+    return myCustomMessage;
+  }
+}