Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Servicebus track2 readme changes 10327 #12735

Merged
merged 25 commits into from
Jul 3, 2020
Merged
Changes from 22 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
5c3cf98
Increment package version after release of com.azure azure-messaging-…
azure-sdk May 8, 2020
39b9a1a
resolve merge conflict
May 12, 2020
f9cc7d2
Merge branch 'azure-sdk-increment-package-version-servicebus-386162'
May 12, 2020
3a4b16f
merge master
May 13, 2020
b67ac9b
Merge branch 'master' of github.com:hemanttanwar/azure-sdk-for-java
May 13, 2020
510e76c
Merge branch 'master' of github.com:Azure/azure-sdk-for-java
May 20, 2020
663dac4
Merge branch 'master' of github.com:Azure/azure-sdk-for-java
Jun 5, 2020
2962fab
Merge branch 'master' of github.com:Azure/azure-sdk-for-java
Jun 8, 2020
d418224
Merge branch 'master' of github.com:Azure/azure-sdk-for-java
Jun 9, 2020
6a9dc35
Merge branch 'master' of github.com:Azure/azure-sdk-for-java
Jun 9, 2020
d0d0d88
Merge branch 'master' of github.com:Azure/azure-sdk-for-java
Jun 10, 2020
80bcfd7
Merge branch 'master' of github.com:Azure/azure-sdk-for-java
Jun 11, 2020
136c66a
Merge branch 'master' of github.com:Azure/azure-sdk-for-java
Jun 17, 2020
ed8488a
Merge branch 'master' of github.com:Azure/azure-sdk-for-java
Jun 18, 2020
874767a
Merge branch 'master' of github.com:Azure/azure-sdk-for-java
Jun 24, 2020
e4c98cc
Merge branch 'master' of github.com:Azure/azure-sdk-for-java
Jun 26, 2020
964c1b6
Merge branch 'master' of github.com:Azure/azure-sdk-for-java
Jun 28, 2020
4aa1fcc
Merge branch 'master' of github.com:Azure/azure-sdk-for-java
Jun 28, 2020
9a962a8
Merge branch 'master' of github.com:Azure/azure-sdk-for-java
Jun 29, 2020
b0bf58e
Merge branch 'master' of github.com:Azure/azure-sdk-for-java
Jul 1, 2020
5585b23
Merge branch 'master' of github.com:Azure/azure-sdk-for-java
Jul 1, 2020
dc6cb8f
readme changes
Jul 1, 2020
7b9dc85
readme changes
Jul 1, 2020
f48dd08
REview comments
Jul 3, 2020
acef67c
Review comments
Jul 3, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 17 additions & 25 deletions sdk/servicebus/azure-messaging-servicebus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,38 +15,21 @@ have to be online at the same time.
[Source code][source_code] | [API reference documentation][api_documentation]
| [Product documentation][product_docs]| [Samples][sample_examples]

## Table of contents

- [Azure Service Bus client library for Java](#azure-service-bus-client-library-for-java)
- [Table of contents](#table-of-contents)
- [Getting started](#getting-started)
- [Prerequisites](#prerequisites)
- [Include the package](#include-the-package)
- [Authenticate the client](#authenticate-the-client)
- [Key concepts](#key-concepts)
- [Examples](#examples)
- [Send messages](#send-messages)
- [Receive messages](#receive-messages)
- [Settle messages](#settle-messages)
- [Send and receive from session enabled queues or topics](#send-and-receive-from-session-enabled-queues-or-topics)
- [Troubleshooting](#troubleshooting)
- [Enable client logging](#enable-client-logging)
- [Enable AMQP transport logging](#enable-amqp-transport-logging)
- [Common exceptions](#common-exceptions)
- [Next steps](#next-steps)
- [Contributing](#contributing)

## Getting started

### Prerequisites

- Java Development Kit (JDK) with version 8 or above
- [Java Development Kit (JDK)][java_development_kit] with version 8 or above
- [Maven][maven]
- Microsoft Azure subscription
- You can create a free account at: https://azure.microsoft.com
- Azure Service Bus instance
- Step-by-step guide for [creating a Service Bus instance using Azure Portal][service_bus_create]

To quickly create the needed Service Bus resources in Azure and to receive a connection string for them, you can deploy our sample template by clicking:

[![](http://azuredeploy.net/deploybutton.png)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-sdk-for-net%2Fmaster%2Fsdk%2Fservicebus%2FAzure.Messaging.ServiceBus%2Fassets%2Fsamples-azure-deploy.json)

### Include the package

[//]: # ({x-version-update-start;com.azure:azure-messaging-servicebus;current})
Expand Down Expand Up @@ -143,6 +126,10 @@ on which actual message transmission takes place. The namespace often serves as
receives a copy of the message sent to the topic.

## Examples
- [Send messages](#send-messages)
- [Receive messages](#receive-messages)
- [Settle messages](#settle-messages)
- [Send and receive from session enabled queues or topics](#send-and-receive-from-session-enabled-queues-or-topics)

### Send messages

Expand Down Expand Up @@ -359,7 +346,9 @@ java.util.logging.SimpleFormatter.format=[%1$tF %1$tr] %3$s %4$s: %5$s %n

This is a general exception for AMQP related failures, which includes the AMQP errors as `ErrorCondition` and the
context that caused this exception as `AmqpErrorContext`. `isTransient` is a boolean indicating if the exception is a
transient error or not. If true, then the request can be retried; otherwise not.
transient error or not. If a transient AMQP exception occurs, the client library retries the operation as many times
as the [AmqpRetryOptons][AmqpRetryOptons] allows. Afterwords, the operation fails and an exception is propagated back
to the user.

[`AmqpErrorCondition`][AmqpErrorCondition] contains error conditions common to the AMQP protocol and used by Azure
services. When an AMQP exception is thrown, examining the error condition field can inform developers as to why the AMQP
Expand All @@ -373,7 +362,7 @@ The recommended way to solve the specific exception the AMQP exception represent

Beyond those discussed, the Azure Service Bus client library offers support for many additional scenarios to help take
advantage of the full feature set of the Azure Service Bus service. In order to help explore some of these scenarios,
check out the [samples README][samples_readme].
the following set of sample is available [here][samples_readme].

## Contributing

Expand All @@ -398,7 +387,7 @@ Guidelines](./../../../CONTRIBUTING.md) for more information.
[ReceiveMode]: ./src/main/java/com/azure/messaging/servicebus/models/ReceiveMode.java
[RetryOptions]: ../../core/azure-core-amqp/src/main/java/com/azure/core/amqp/AmqpRetryOptions.java
[sample_examples]: ./src/samples/java/com/azure/messaging/servicebus/
[samples_readme]: ./src/samples/README.md
[samples_readme]: ./src/samples/java/com/azure/messaging/servicebus
[service_bus_connection_string]: https://docs.microsoft.com/azure/service-bus-messaging/service-bus-create-namespace-portal#get-the-connection-string
[servicebus_create]: https://docs.microsoft.com/azure/service-bus-messaging/service-bus-create-namespace-portal
[servicebus_messaging_exceptions]: https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messaging-exceptions
Expand All @@ -411,5 +400,8 @@ Guidelines](./../../../CONTRIBUTING.md) for more information.
[subscription_concept]: https://docs.microsoft.com/azure/service-bus-messaging/service-bus-queues-topics-subscriptions#topics-and-subscriptions
[topic_concept]: https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messaging-overview#topics
[wiki_identity]: https://github.com/Azure/azure-sdk-for-java/wiki/Identity-and-Authentication
[java_development_kit]: https://docs.microsoft.com/en-us/java/azure/jdk/?view=azure-java-stable
[AmqpRetryOptons]: ../../core/azure-core-amqp/src/main/java/com/azure/core/amqp/AmqpRetryOptions.java
[service_bus_create]: https://docs.microsoft.com/azure/service-bus-messaging/service-bus-create-namespace-portal

![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-java%2Fsdk%2Fservicebus%2Fazure-messaging-servicebus%2FREADME.png)