Microsoft Azure Event Hubs Client for Java

Build/Package	Status
master
dev
azure-eventhubs
azure-eventhubs-eph

Azure Event Hubs is a highly scalable publish-subscribe service that can ingest millions of events per second and stream them into multiple applications. This lets you process and analyze the massive amounts of data produced by your connected devices and applications. Once Event Hubs has collected the data, you can retrieve, transform and store it by using any real-time analytics provider or with batching/storage adapters.

Refer to the online documentation to learn more about Event Hubs in general. Refer to General Overview document for a general overview of Event Hubs Client for Java.

Using the library

Two java packages are released to Maven Central Repository from this GitHub repository.

Microsoft Azure EventHubs Java Client

This library exposes the send and receive APIs. This library will in turn pull further required dependencies, specifically the required versions of Apache Qpid Proton-J, and the cryptography library BCPKIX by the Legion of Bouncy Castle.

   	<dependency> 
   		<groupId>com.microsoft.azure</groupId> 
   		<artifactId>azure-eventhubs</artifactId> 
   		<version>1.0.0</version>
   	</dependency>

Microsoft Azure EventHubs Java Event Processor Host library

This library exposes an out-of-the-box distributed partition processor for Event Hubs. It pulls the required versions of Event Hubs, Azure Storage and GSon libraries.

   	<dependency> 
   		<groupId>com.microsoft.azure</groupId> 
   		<artifactId>azure-eventhubs-eph</artifactId> 
   		<version>1.0.0</version>
   	</dependency>

For different types of build environments, the latest released JAR files can also be explicitly obtained from the Maven Central Repository or from the Release distribution point on GitHub.

Samples

Additional samples are provided here: azure/azure-event-hubs

How to provide feedback

First, if you experience any issues with the runtime behavior of the Azure Event Hubs service, please consider filing a support request right away. Your options for getting support are enumerated here. In the Azure portal, you can file a support request from the "Help and support" menu in the upper right hand corner of the page.

If you find issues in this library or have suggestions for improvement of code or documentation, you can file an issue in the project's GitHub repository or send across a pull request - see our Contribution Guidelines.

Issues related to runtime behavior of the service, such as sporadic exceptions or apparent service-side performance or reliability issues can not be handled here.

Generally, if you want to discuss Azure Event Hubs or this client library with the community and the maintainers, you can turn to stackoverflow.com under the #azure-eventhub tag or the MSDN Service Bus Forum.

Build & contribute to the library

You will generally not have to build this client library yourself. This library is available on maven central. If you have any specific requirement for which you want to contribute or need to generate a SNAPSHOT version, this section is for you.

We adopted maven build model and strive to keep the project model intuitive enough to developers. If you need any help with any specific IDE or cannot get the build going in any environment - please open an issue. Here are few general topics, which we thought developers would need help with:

Running Integration tests

Set the following two Environment variables to be able to run unit tests targeting Microsoft Azure EventHubs service:

• EVENT_HUB_CONNECTION_STRING - the event hub connection string to which the tests should target. the format of the connection string is: Endpoint=----NAMESPACE_ENDPOINT------;EntityPath=----EVENTHUB_NAME----;SharedAccessKeyName=----KEY_NAME----;SharedAccessKey=----KEY_VALUE----. Here's how to create an Event Hub on Azure Portal and get the connection string.

• EPHTESTSTORAGE - the Microsoft Azure Storage account connection string to use while running EPH tests. The format of the connection string is: DefaultEndpointsProtocol=https;AccountName=---STORAGE_ACCOUNT_NAME---;AccountKey=---ACCOUNT_KEY---;EndpointSuffix=---ENPOINT_SUFFIX---. For more details on this visit - how to create an Azure Storage account connection string.

Explore the client library with IDEs

• If you see any Build Errors - make sure the Execution Environment is set to JDK version 1.8 or higher