5.8 KiB
| title | author | description | monikerRange | ms.author | ms.custom | ms.date | no-loc | uid | |
|---|---|---|---|---|---|---|---|---|---|
| ASP.NET Core SignalR Java client | mikaelm12 | Learn how to use the ASP.NET Core SignalR Java client. | >= aspnetcore-2.2 | mimengis | mvc | 11/12/2019 |
|
signalr/java-client |
ASP.NET Core SignalR Java client
The Java client enables connecting to an ASP.NET Core SignalR server from Java code, including Android apps. Like the JavaScript client and the .NET client, the Java client enables you to receive and send messages to a hub in real time. The Java client is available in ASP.NET Core 2.2 and later.
The sample Java console app referenced in this article uses the SignalR Java client.
View or download sample code (how to download)
Install the SignalR Java client package
The signalr-1.0.0 JAR file allows clients to connect to SignalR hubs. To find the latest JAR file version number, see the Maven search results.
If using Gradle, add the following line to the dependencies section of your build.gradle file:
implementation 'com.microsoft.signalr:signalr:1.0.0'
If using Maven, add the following lines inside the <dependencies> element of your pom.xml file:
[!code-xmlpom.xml dependency element]
Connect to a hub
To establish a HubConnection, the HubConnectionBuilder should be used. The hub URL and log level can be configured while building a connection. Configure any required options by calling any of the HubConnectionBuilder methods before build. Start the connection with start.
[!code-javaBuild hub connection]
Call hub methods from client
A call to send invokes a hub method. Pass the hub method name and any arguments defined in the hub method to send.
[!code-javasend method]
[!NOTE] If you're using Azure SignalR Service in Serverless mode, you cannot call hub methods from a client. For more information, see the SignalR Service documentation.
Call client methods from hub
Use hubConnection.on to define methods on the client that the hub can call. Define the methods after building but before starting the connection.
[!code-javaDefine client methods]
Add logging
The SignalR Java client uses the SLF4J library for logging. It's a high-level logging API that allows users of the library to chose their own specific logging implementation by bringing in a specific logging dependency. The following code snippet shows how to use java.util.logging with the SignalR Java client.
implementation 'org.slf4j:slf4j-jdk14:1.7.25'
If you don't configure logging in your dependencies, SLF4J loads a default no-operation logger with the following warning message:
SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
SLF4J: Defaulting to no-operation (NOP) logger implementation
SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
This can safely be ignored.
Android development notes
With regards to Android SDK compatibility for the SignalR client features, consider the following items when specifying your target Android SDK version:
- The SignalR Java Client will run on Android API Level 16 and later.
- Connecting through the Azure SignalR Service will require Android API Level 20 and later because the Azure SignalR Service requires TLS 1.2 and doesn't support SHA-1-based cipher suites. Android added support for SHA-256 (and above) cipher suites in API Level 20.
Configure bearer token authentication
In the SignalR Java client, you can configure a bearer token to use for authentication by providing an "access token factory" to the HttpHubConnectionBuilder. Use withAccessTokenFactory to provide an RxJava Single<String>. With a call to Single.defer, you can write logic to produce access tokens for your client.
HubConnection hubConnection = HubConnectionBuilder.create("YOUR HUB URL HERE")
.withAccessTokenProvider(Single.defer(() -> {
// Your logic here.
return Single.just("An Access Token");
})).build();
Known limitations
::: moniker range=">= aspnetcore-3.0"
- Only the JSON protocol is supported.
- Transport fallback and the Server Sent Events transport aren't supported.
::: moniker-end
::: moniker range="< aspnetcore-3.0"
- Only the JSON protocol is supported.
- Only the WebSockets transport is supported.
- Streaming isn't supported yet.
::: moniker-end