com.azure.messaging.servicebus

Class ServiceBusSenderClient

java.lang.Object

com.azure.messaging.servicebus.ServiceBusSenderClient

All Implemented Interfaces:

AutoCloseable

public class ServiceBusSenderClient
extends Object
implements AutoCloseable

A synchronous sender responsible for sending ServiceBusMessage to specific queue or topic on Azure Service Bus.

Create an instance of sender

 // The required parameter is a way to authenticate with Service Bus using credentials.
 // The connectionString provides a way to authenticate with Service Bus.
 ServiceBusSenderClient sender = new ServiceBusClientBuilder()
     .connectionString(
         "Endpoint={fully-qualified-namespace};SharedAccessKeyName={policy-name};SharedAccessKey={key}")
     .sender()
     .queueName("queue-name")
     .buildClient();
 

Send messages to a Service Bus resource

 
 List<ServiceBusMessage> messages = Arrays.asList(new ServiceBusMessage("test-1".getBytes(UTF_8)),
     new ServiceBusMessage("test-2".getBytes(UTF_8)));
 
 final CreateBatchOptions options = new CreateBatchOptions().setMaximumSizeInBytes(10 * 1024);
 // Creating a batch without options set.
 ServiceBusMessageBatch batch = sender.createBatch(options);
 for (ServiceBusMessage message : messages) {
     if (batch.tryAdd(message)) {
         continue;
     }
 
     sender.send(batch);
 }
 

Send messages using a size-limited ServiceBusMessageBatch

 
 
 final List<ServiceBusMessage> telemetryMessages = Arrays.asList(firstMessage, secondMessage, thirdMessage);
 
 // Setting `setMaximumSizeInBytes` when creating a batch, limits the size of that batch.
 // In this case, all the batches created with these options are limited to 256 bytes.
 final CreateBatchOptions options = new CreateBatchOptions()
     .setMaximumSizeInBytes(256);
 
 ServiceBusMessageBatch currentBatch = sender.createBatch(options);
 
 // For each telemetry message, we try to add it to the current batch.
 // When the batch is full, send it then create another batch to add more mesages to.
 for (ServiceBusMessage message : telemetryMessages) {
     if (!currentBatch.tryAdd(message)) {
         sender.send(currentBatch);
         currentBatch = sender.createBatch(options);
 
         // Add the message we couldn't before.
         if (!currentBatch.tryAdd(message)) {
             throw new IllegalArgumentException("Message is too large for an empty batch.");
         }
     }
 }
 

See Also:

ServiceBusClientBuilder.sender(), To communicate with a Service Bus resource using an asynchronous client.

Method Summary

Modifier and Type	Method and Description
void	cancelScheduledMessage(long sequenceNumber) Cancels the enqueuing of an already scheduled message, if it was not already enqueued.
void	close()
ServiceBusMessageBatch	createBatch() Creates a ServiceBusMessageBatch that can fit as many messages as the transport allows.
ServiceBusMessageBatch	createBatch(CreateBatchOptions options) Creates an ServiceBusMessageBatch configured with the options specified.
String	getEntityPath() Gets the name of the Service Bus resource.
String	getFullyQualifiedNamespace() Gets the fully qualified namespace.
Long	scheduleMessage(ServiceBusMessage message, Instant scheduledEnqueueTime) Sends a scheduled message to the Azure Service Bus entity this sender is connected to.
void	send(Iterable<ServiceBusMessage> messages) Sends a set of ServiceBusMessage to a Service Bus queue or topic using a batched approach.
void	send(ServiceBusMessage message) Sends a message to a Service Bus queue or topic.
void	send(ServiceBusMessageBatch batch) Sends a message batch to the Azure Service Bus entity this sender is connected to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getEntityPath

public String getEntityPath()

Gets the name of the Service Bus resource.

Returns:

The name of the Service Bus resource.

getFullyQualifiedNamespace

public String getFullyQualifiedNamespace()

Gets the fully qualified namespace.

Returns:

The fully qualified namespace.

send

public void send(ServiceBusMessage message)

Sends a message to a Service Bus queue or topic.

Parameters:

message - Message to be sent to Service Bus queue or topic.

Throws:

NullPointerException - if message is null.

send

public void send(Iterable<ServiceBusMessage> messages)

Sends a set of ServiceBusMessage to a Service Bus queue or topic using a batched approach. If the size of messages exceed the maximum size of a single batch, an exception will be triggered and the send will fail. By default, the message size is the max amount allowed on the link.

Parameters:

messages - Messages to be sent to Service Bus queue or topic.

Throws:

NullPointerException - if messages is null.

com.azure.core.amqp.exception.AmqpException - if messages is larger than the maximum allowed size of a single batch.

scheduleMessage

public Long scheduleMessage(ServiceBusMessage message,
                            Instant scheduledEnqueueTime)

Sends a scheduled message to the Azure Service Bus entity this sender is connected to. A scheduled message is enqueued and made available to receivers only at the scheduled enqueue time.

Parameters:

message - Message to be sent to the Service Bus Queue or Topic.

scheduledEnqueueTime - Instant at which the message should appear in the Service Bus queue or topic.

Returns:

The sequence number of the scheduled message which can be used to cancel the scheduling of the message.

Throws:

NullPointerException - if message or scheduledEnqueueTime is null.

cancelScheduledMessage

public void cancelScheduledMessage(long sequenceNumber)

Cancels the enqueuing of an already scheduled message, if it was not already enqueued.

Parameters:

sequenceNumber - of the scheduled message to cancel.

Throws:

IllegalArgumentException - if sequenceNumber is negative.

createBatch

public ServiceBusMessageBatch createBatch()

Creates a ServiceBusMessageBatch that can fit as many messages as the transport allows.

Returns:

A ServiceBusMessageBatch that can fit as many messages as the transport allows.

createBatch

public ServiceBusMessageBatch createBatch(CreateBatchOptions options)

Creates an ServiceBusMessageBatch configured with the options specified.

Parameters:

options - A set of options used to configure the ServiceBusMessageBatch.

Returns:

A new ServiceBusMessageBatch configured with the given options.

Throws:

NullPointerException - if options is null.

send

public void send(ServiceBusMessageBatch batch)

Sends a message batch to the Azure Service Bus entity this sender is connected to.

Parameters:

batch - of messages which allows client to send maximum allowed size for a batch of messages.

Throws:

NullPointerException - if batch is null.

close

public void close()

Specified by:

close in interface AutoCloseable