You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-14Lines changed: 17 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
1
# Sinch Java SDK
2
2
3
-
Here you'll find documentation related to the Sinch Java SDK, including how to install it, initialize it, and start developing <language> code using Sinch services.
3
+
Here you'll find documentation related to the Sinch Java SDK, including how to install it, initialize it, and start developing Java code using Sinch services.
4
4
5
5
To use Sinch services, you'll need a Sinch account and access keys. You can sign up for an account and create access keys at [dashboard.sinch.com](https://dashboard.sinch.com).
6
6
7
-
For more information on the Sinch APIs on which this SDK is based, refer to the official [developer documentation portal](https://developers.sinch.com).
7
+
For more information on the SDK, refer to the dedicated [Java SDK documentation section](https://developers.sinch.com/docs/sdks/java) and for the Sinch APIs on which this SDK is based, refer to the official [developer documentation portal](https://developers.sinch.com).
8
8
9
9
## Table of contents:
10
10
-[Prerequisites](#prerequisites)
@@ -14,7 +14,7 @@ For more information on the Sinch APIs on which this SDK is based, refer to the
-[Migration guide for previous SDK versions](#migration-guides)
17
+
-[Changelog and Migration guides](#changelog--migration)
18
18
19
19
## Prerequisites
20
20
@@ -25,7 +25,7 @@ For more information on the Sinch APIs on which this SDK is based, refer to the
25
25
26
26
## Installation
27
27
28
-
Add to your `pom.xml` file the dependency to SDK:
28
+
Add the SDK dependency to your `pom.xml` file:
29
29
```xml
30
30
<dependencies>
31
31
<dependency>
@@ -36,7 +36,7 @@ Add to your `pom.xml` file the dependency to SDK:
36
36
...
37
37
</dependencies>
38
38
```
39
-
Note the`${sdk.version}`need to be set according to released version to be used (see available versions from [Maven Repository](https://central.sonatype.com/artifact/com.sinch.sdk/sinch-sdk-java))
39
+
Note: The`${sdk.version}`needs to be set according to the released version to be used (see available versions from [Maven Repository](https://central.sonatype.com/artifact/com.sinch.sdk/sinch-sdk-java))
40
40
41
41
## Getting started
42
42
@@ -81,7 +81,7 @@ Here is the list of the Sinch products and their level of support by the Java SD
81
81
82
82
The SDK uses the Java 8 logging feature ([java.util.logging](https://docs.oracle.com/javase/8/docs/api/java/util/logging/package-summary.html#package.description))
83
83
84
-
When using java logging, Loggers and severity can be configured by using a `logging.properties` file like:
84
+
When using Java logging, Loggers and severity can be configured by using a `logging.properties` file like:
85
85
```
86
86
# java.util.logging configuration sample
87
87
# See https://docs.oracle.com/javase/8/docs/api/java/util/logging/package-summary.html#package.description
@@ -111,28 +111,27 @@ If you are using a different logging framework (such as SLF4J or Spring), please
111
111
112
112
To enhance the onboarding experience, the following resources are available:
- Java SDK Quickstart Repository: A repository with tutorials and templates to help you quickly start a new project: https://github.com/sinch/sinch-sdk-java-quickstart
116
-
- Java SDK Snippets: A collection of basic code snippets for reference: [snippets](examples/snippets/README.md)
-[Apache HTTP client](https://hc.apache.org/httpcomponents-client-5.4.x/5.4.1/httpclient5/project-info.html): Manages communication with Sinch products' REST APIs
120
+
-[Apache HTTP client](https://hc.apache.org/httpcomponents-client-ga/): Manages communication with Sinch products' REST APIs
The transition from <code>javax</code> to <code>jakarta</code> namespaces with the Java EE to Jakarta EE migration may cause compatibility issues. Refer to [Oracle's note about the transition](https://blogs.oracle.com/javamagazine/post/transition-from-java-ee-to-jakarta-ee) for additional details.
123
+
The transition from `javax` to `jakarta` namespaces with the Java EE to Jakarta EE migration may cause compatibility issues. Refer to [Oracle's note about the transition](https://docslib.org/doc/1185955/transition-from-java-ee-to-jakarta-ee-ee-conclusion-what-happened-and-what-you-need-to-know) for additional details.
125
124
126
125
Jackson maintainers provide two variants of the library:
127
126
> (*) NOTE: Jakarta-RS is the package under jakarta.ws.rs, replacing older JAX-RS which lived under javax.ws.rs. For JAX-RS variant, see repo jackson-jaxrs-providers
128
127
129
128
By default, the Sinch Java SDK uses the "new" [jackson-jakarta-rs-providers](https://github.com/FasterXML/jackson-jakarta-rs-providers). However, you can switch to the "older" [jackson-jaxrs-providers](https://github.com/FasterXML/jackson-jaxrs-providers) if required.
130
129
131
-
#### Switching to <code>jackson-jaxrs-providers</code>
132
-
Depending on your use case, you may need to adjust dependencies to enable <code>jaxrs</code> usage.
130
+
#### Switching to `jackson-jaxrs-providers`
131
+
Depending on your use case, you may need to adjust dependencies to enable `jaxrs` usage.
133
132
134
133
Add the following dependency to your configuration:
135
-
Note: Replace <code>VERSION-YOU-WANT-TO-BE-USED</code> by a Jackson version of at least `2.15.2`.
134
+
Note: Replace `VERSION-YOU-WANT-TO-BE-USED` with a Jackson version of at least `2.15.2`.
136
135
```xml
137
136
...
138
137
<dependency>
@@ -158,6 +157,10 @@ Note: Replace <code>VERSION-YOU-WANT-TO-BE-USED</code> by a Jackson version of a
158
157
For information about the latest changes in the SDK, please refer to the [CHANGELOG](CHANGELOG.md) file
159
158
and the [MIGRATION-GUIDE](MIGRATION-GUIDE.md) for instructions on how to update your code when upgrading to a new major version of the SDK.
0 commit comments