Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/commercetools/commercetools-jvm-sdk

The e-commerce SDK from commercetools running on the Java virtual machine.
https://github.com/commercetools/commercetools-jvm-sdk

audit-sdk commercetools commercetools-java-sdks commercetools-sdk java java-sdk sdk

Last synced: 5 days ago
JSON representation

The e-commerce SDK from commercetools running on the Java virtual machine.

Awesome Lists containing this project

README 

        
# commercetools JVM SDK

:warning: **This commercetools JVM SDK is in its Maintenance Support mode currently, and is planned to be deprecated, please note the following dates.



| Active Support        | Maintenance Support   | End of Life           |

| --------------------- | --------------------- | --------------------- |

| `28th February, 2022` | `31st December 2023.` | `1st January 2024.`   |



We recommend to use our [Java SDK V2](https://docs.commercetools.com/sdk/jvm-sdk#java-sdk-v2), and you can migrate to the new version using our [migration guideline](https://docs.commercetools.com/sdk/java-sdk-migrate).



CT-logo



[![][travis img]][travis]

[![][maven img]][maven]

[![][license img]][license]



The JVM SDK enables developers to use Java 8 methods and objects to communicate with the [Composable Commerce API](https://www.commercetools.com/) rather than using plain HTTP calls.

Users gain type-safety, encapsulation, IDE auto completion and an internal domain specific language to discover and formulate valid requests.



## JDK compatibility

Tested with JDKs: Oracle 1.8.0_221, OpenJDK 1.8.0_221 and Amazon Corretto 8.222.10.1.



## Using the SDK

* install [Java 8](https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)

* (since May 19, 2016 new link) [Javadoc](https://commercetools.github.io/commercetools-jvm-sdk/apidocs/index.html), there you find also code snippets and insights

    * [Getting Started](https://commercetools.github.io/commercetools-jvm-sdk/apidocs/io/sphere/sdk/meta/GettingStarted.html)

    * [Release Notes](https://commercetools.github.io/commercetools-jvm-sdk/apidocs/io/sphere/sdk/meta/ReleaseNotes.html)

    * [Contributing](https://commercetools.github.io/commercetools-jvm-sdk/apidocs/io/sphere/sdk/meta/ContributorDocumentation.html)



## Installation



### Java SDK with Maven



````xml



  com.commercetools.sdk.jvm.core

  commercetools-models

  1.61.0



  com.commercetools.sdk.jvm.core

  commercetools-java-client

  1.61.0



  com.commercetools.sdk.jvm.core

  commercetools-convenience

  1.61.0



````

* https://search.maven.org/#artifactdetails%7Ccom.commercetools.sdk.jvm.core%7Ccommercetools-models%7C1.61.0%7Cjar

* https://search.maven.org/#artifactdetails%7Ccom.commercetools.sdk.jvm.core%7Ccommercetools-java-client%7C1.61.0%7Cjar

* https://search.maven.org/#artifactdetails%7Ccom.commercetools.sdk.jvm.core%7Ccommercetools-convenience%7C1.61.0%7Cjar



### Modules

* `commercetools-java-client`: alias for commercetools-java-client-ahc-2_0

* `commercetools-java-client-apache-async`: uses Apache HTTP client

* `commercetools-java-client-ahc-1_9`: uses async HTTP client 1.9 (AHC 1.9 is incompatible to AHC 1.8)

* `commercetools-java-client-ahc-2_0`: uses async HTTP client 2.0 (do not mix it with the other AHC modules)

* `commercetools-java-client-ahc-2_5`: uses async HTTP client 2.5 (AHC 2.5 is incompatible to AHC 2.0)

* `commercetools-java-client-ahc-2_12`: uses async HTTP client 2.12

* `commercetools-models`: models which do not depend to a client implementation



### Java SDK with gradle



````

repositories {

    mavenCentral()

}



dependencies {

    def jvmSdkVersion = "1.61.0"

    compile "com.commercetools.sdk.jvm.core:commercetools-models:$jvmSdkVersion"

    compile "com.commercetools.sdk.jvm.core:commercetools-java-client:$jvmSdkVersion"

    compile "com.commercetools.sdk.jvm.core:commercetools-convenience:$jvmSdkVersion"

}

````



### Play/Scala SDK with SBT



see https://github.com/commercetools/commercetools-jvm-sdk-scala-add-ons



### reactive streams

* https://github.com/commercetools/commercetools-jvm-sdk-reactive-streams-add-ons



### JVM SDK Contrib



Useful code from external developers



* https://github.com/commercetools/commercetools-jvm-sdk-contrib

* contains also ProductImageUploadCommand from https://docs.commercetools.com/http-api-projects-products.html#upload-a-product-image



## Short-term roadmap

* https://github.com/commercetools/commercetools-jvm-sdk/milestones

* https://waffle.io/commercetools/commercetools-jvm-sdk



## Open Source Examples

* [Sunrise Java](https://github.com/commercetools/commercetools-sunrise-java) - a shop using Play Framework 2.x with Handlebars.java as template engine, Google Guice for DI

* [Donut](https://github.com/commercetools/commercetools-donut) - single product subscription shop example with Play Framework 2.x and Twirl (Plays default) as template engine

* [commercetools Spring MVC archetype](https://github.com/commercetools/commercetools-spring-mvc-archetype) - template integrating the SDK with Spring DI and Spring MVC and showing just some products, thymeleaf template engine

* [Reproducer Example](https://github.com/commercetools/commercetools-jvm-sdk-reproducer-example) - a demo which shows how to reproduce errors



## Stability



1. Experimental features in the API are also experimental features of the SDK.

    * this includes for example

        * payments

        * nested product attributes

1. The dependencies will only be updated in the next major version to improve stability. Of course, if bugs in libraries *occur*, we may need to update.

1. JVM SDK test dependencies and build tools can be updated because they don't affect the production code.

1. The JVM SDK has an abstract HTTP client layer so old or new http client versions can be used.

1. order import is experimental

1. the search methods with lambda parameters are beta `ProductProjectionSearch.ofCurrent().withQueryFilters(m -> m.categories().id().containsAll(categoryIds1))`

1. getters of draft objects might change since new HTTP API features can introduce polymorphism

1. final classes without public constructors can be transformed into an interface



## Executing integration tests



1. create a NEW API client in the Admin Center (`https://mc.commercetools.com/YOUR_PROJECT_KEY/settings/developer/api-clients`) with all available permissions (at the time of writing it is manage_payments manage_my_profile manage_orders view_products view_customers view_payments view_types manage_my_orders manage_types manage_customers manage_products view_orders manage_project), the by default created client has just `manage_project`

1. in the Admin Center in the "DANGER ZONE" activate the checkbox "ENABLE MESSAGES" within the "Messages Settings"

1. set "de", "de-AT", "en" as languages in the Admin Center

1. set at least one country in the Admin Center

1. create a file "integrationtest.properties" inside the project root

1. fill it with the credentials of a new empty Project which is for testing;



```

projectKey=YOUR project key without quotes

clientId=YOUR client id without quotes

clientSecret=YOUR client secret without quotes

apiUrl=https://api.europe-west1.gcp.commercetools.com

authUrl=https://auth.europe-west1.gcp.commercetools.com

```



1. use `./mvnw verify` to execute all integration tests

1. use `./mvnw -Dit.test=*Product* -DfailIfNoTests=false verify` to execute all integration test classes which have "Product" in the class name

1. for running the unit tests use `./mvnw test`

1. alternatively use your IDE to execute the tests

1. for some IDEs like IntelliJ IDEA you need to add the Javac flag "-parameters", then also rebuild the whole project to apply the change



[](definitions for the top badges)



[travis]:https://travis-ci.org/commercetools/commercetools-jvm-sdk

[travis img]:https://travis-ci.org/commercetools/commercetools-jvm-sdk.svg?branch=master



[maven]:https://search.maven.org/#search|gav|1|g:"com.commercetools.sdk.jvm.core"%20AND%20a:"commercetools-models"

[maven img]:https://maven-badges.herokuapp.com/maven-central/com.commercetools.sdk.jvm.core/commercetools-models/badge.svg



[license]:LICENSE.md

[license img]:https://img.shields.io/badge/License-Apache%202-blue.svg