diff --git a/Best-practices.md b/Best-practices.md index 2f67beff2d8..c3763a7edf6 100644 --- a/Best-practices.md +++ b/Best-practices.md @@ -242,7 +242,8 @@ To avoid the escaping issues while building a predicate string we advice to use The ApiHttpResponse is the abstraction atop the HTTP transfer and doesn't know about the internal semantics of the HTTP body. The ApiHttpResponse::getMessage() method in this case returns the HTTP header message like OK, CONTINUE, BAD REQUEST. In case of an error the ErrorMiddleware will throw an exception. The HTTP body will be added as exception message string. -As the thrown exceptions are derived from the ApiHttpException class which has a getBodyAs helper method which is capable of deserializing the body string to the given specified class. For the Composable Commerce API this would be the ErrorResponse class. In case of a BadRequestException or ConcurrentModification the error response will be automatically deserialized. +As the thrown exceptions are derived from the ApiHttpException class which has a getBodyAs helper method which is capable of deserializing the body string to the given specified class. For commercetools APIs, this would be the ErrorResponse class. In case of a BadRequestException or ConcurrentModification the error response will be automatically deserialized. + ```java apiRoot.products().post(draft).execute() .exceptionally(throwable -> { diff --git a/README.md b/README.md index 1799a2ac23f..e3f997d4c5a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -# commercetools Composable Commerce Java SDK - +# commercetools Java SDK [![][maven img]][maven] [![][snyk img]][snyk] diff --git a/build.gradle b/build.gradle index c519092b0e4..54c7f18a8c9 100644 --- a/build.gradle +++ b/build.gradle @@ -68,7 +68,7 @@ class Version { allprojects { apply from: "$rootDir/gradle-scripts/repositories.gradle" - description = "The e-commerce SDK from commercetools Composable Commerce for Java" + description = "The e-commerce SDK from commercetools for Java" configurations { taglet { diff --git a/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/ExceptionDocumentation.java b/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/ExceptionDocumentation.java index 5f212274f78..b9331e7701a 100644 --- a/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/ExceptionDocumentation.java +++ b/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/ExceptionDocumentation.java @@ -13,7 +13,7 @@ * *

JSON serializing and deserializing problems throw {@link io.vrap.rmf.base.client.utils.json.JsonException}.

* - *

{@link io.vrap.rmf.base.client.ApiHttpException} is a base exception for all error responses from Composable Commerce (HTTP status code {@code >= 400}).

+ *

{@link io.vrap.rmf.base.client.ApiHttpException} is a base exception for all error responses from commercetools (HTTP status code {@code >= 400}).

* *

{@link io.vrap.rmf.base.client.error.ApiClientException} expresses errors which can be recovered by the client side (HTTP status code {@code >= 400 and < 500}). * {@link io.vrap.rmf.base.client.error.ApiServerException} is for server errors.

diff --git a/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/GeneralConcept.java b/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/GeneralConcept.java index ac148360148..8168d9f5087 100644 --- a/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/GeneralConcept.java +++ b/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/GeneralConcept.java @@ -9,7 +9,7 @@ * {@include.toc} *

General concept of the SDK

* - * The SDK provides classes and interfaces to interact with the commercetools Composable Commerce APIs in an object-oriented way. + * The SDK provides classes and interfaces to interact with the commercetools APIs in an object-oriented way. * *

ApiHttpClient

* diff --git a/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/GettingStarted.java b/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/GettingStarted.java index 89a5fe83f47..caf9ddb2ebf 100644 --- a/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/GettingStarted.java +++ b/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/GettingStarted.java @@ -5,7 +5,7 @@ * {@include.toc} *

About the client

* - *

The commercetools Composable Commerce client communicates asynchronously with the API via HTTPS + *

The commercetools client communicates asynchronously with the API via HTTPS * and it takes care about authentication.

* *

The client uses Java objects to formulate an HTTP request, performs the request and diff --git a/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/Logging.java b/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/Logging.java index 359f57361c1..c9721c0cc82 100644 --- a/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/Logging.java +++ b/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/Logging.java @@ -13,7 +13,7 @@ * {@include.toc} *

Logging

* - *

Internal logging used by the commercetools Composable Commerce client itself. Uses slf4j logger named {@code commercetools}.

+ *

Internal logging used by the commercetools client itself. Uses slf4j logger named {@code commercetools}.

* *

Logger configuration

* @@ -54,9 +54,9 @@ * *

The loggers form a hierarchy separated by a dot. The root logger is {@code commercetools}.

* - *

The child loggers of commercetools Composable Commerce correspond with the names of the API endpoints, so for example {@code commercetools.categories} for Categories and {@code commercetools.product-types} for Product Types.

+ *

The child loggers of commercetools correspond with the names of the API endpoints, so for example {@code commercetools.categories} for Categories and {@code commercetools.product-types} for Product Types.

* - *

The grandchild loggers refer to actions. For example, {@code commercetools.categories.request} refers to performing requests via HTTPs to commercetools Composable Commerce for Categories and {@code commercetools.categories.response} refers to the response for Categories.

+ *

The grandchild loggers refer to actions. For example, {@code commercetools.categories.request} refers to performing requests via HTTPs to commercetools for Categories and {@code commercetools.categories.response} refers to the response for Categories.

* *

The logger makes use of different log levels, so for example {@code commercetools.categories.response} logs on debug level the http response from the platform (abbreviated example):

* diff --git a/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/Middlewares.java b/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/Middlewares.java index 0797eae1325..220d31ff07b 100644 --- a/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/Middlewares.java +++ b/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/Middlewares.java @@ -18,7 +18,7 @@

OAuthMiddleware

-

An {@link io.vrap.rmf.base.client.http.OAuthMiddleware} is used to authenticate a request against the commercetools Composable Commerce +

An {@link io.vrap.rmf.base.client.http.OAuthMiddleware} is used to authenticate a request against the commercetools APIs. The default implementation adds an auth header to the request instance. In case of an expired token it will try to reauthenticate automatically. To retrieve an {@link io.vrap.rmf.base.client.AuthenticationToken} the {@link io.vrap.rmf.base.client.http.OAuthHandler} is called.

diff --git a/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/Using.java b/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/Using.java index bf9e756c654..2ebf22361cd 100644 --- a/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/Using.java +++ b/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/Using.java @@ -23,7 +23,7 @@ *

Request DSL

* *

Building request can be done with the help of an ApiRoot, e.g. {@link com.commercetools.api.client.ProjectApiRoot}. - * The DSL mirrors the directory structure and HTTP methods of the API and allows navigating and discovering the commercetools Composable Commerce + * The DSL mirrors the directory structure and HTTP methods of the API and allows navigating and discovering the commercetools * API while typing. The HTTP method builders includes methods for every query parameter. Additionally there are * the {@link ApiMethod#execute()} and {@link ApiMethod#executeBlocking()} methods which are sending the request using the * configured {@link io.vrap.rmf.base.client.ApiHttpClient} and mapping the result to the correct response class. In case diff --git a/examples/spring-datadog-statsd/README.md b/examples/spring-datadog-statsd/README.md index c8ceadde2d1..86e3dec8070 100644 --- a/examples/spring-datadog-statsd/README.md +++ b/examples/spring-datadog-statsd/README.md @@ -4,7 +4,7 @@ Example to show how Java SDK can be used in a Spring Boot application with Datad ## Requirements -- A Composable Commerce Project with a configured [API Client](https://docs.commercetools.com/api/getting-started/create-api-client). +- A commercetools Project with a configured [API Client](https://docs.commercetools.com/api/getting-started/create-api-client). Necessary scopes: `view_published_products`, `manage_orders` - Your Project must have existing products containing variants with SKUs, and at least one customer, the storefront search endpoint must be active. - If your Project is currently empty, you can install the [SUNRISE sample data](https://github.com/commercetools/commercetools-sunrise-data). diff --git a/examples/spring-datadog-statsd/src/main/resources/templates/home/index.html b/examples/spring-datadog-statsd/src/main/resources/templates/home/index.html index b72394f2db8..5ec81412af6 100644 --- a/examples/spring-datadog-statsd/src/main/resources/templates/home/index.html +++ b/examples/spring-datadog-statsd/src/main/resources/templates/home/index.html @@ -1,11 +1,11 @@ - commercetools Composable Commerce Spring example + commercetools Spring example

-

This is an example application showing the integration of commercetools Composable Commerce in a Spring Boot MVC environment.

+

This is an example application showing the integration of commercetools in a Spring Boot MVC environment.

diff --git a/examples/spring-datadog/README.md b/examples/spring-datadog/README.md index c06c984827f..53cd9dd0bf5 100644 --- a/examples/spring-datadog/README.md +++ b/examples/spring-datadog/README.md @@ -4,7 +4,7 @@ Example to show how Java SDK can be used in a Spring Boot application with Datad ## Requirements -- A Composable Commerce Project with a configured [API Client](https://docs.commercetools.com/api/getting-started/create-api-client). +- A commercetools Project with a configured [API Client](https://docs.commercetools.com/api/getting-started/create-api-client). Necessary scopes: `view_published_products`, `manage_orders` - Your Project must have existing products containing variants with SKUs, and at least one customer, the storefront search endpoint must be active. - If your Project is currently empty, you can install the [SUNRISE sample data](https://github.com/commercetools/commercetools-sunrise-data). diff --git a/examples/spring-datadog/src/main/resources/templates/home/index.html b/examples/spring-datadog/src/main/resources/templates/home/index.html index b72394f2db8..5ec81412af6 100644 --- a/examples/spring-datadog/src/main/resources/templates/home/index.html +++ b/examples/spring-datadog/src/main/resources/templates/home/index.html @@ -1,11 +1,11 @@ - commercetools Composable Commerce Spring example + commercetools Spring example
-

This is an example application showing the integration of commercetools Composable Commerce in a Spring Boot MVC environment.

+

This is an example application showing the integration of commercetools in a Spring Boot MVC environment.

diff --git a/examples/spring-dynatrace-oneagent/README.md b/examples/spring-dynatrace-oneagent/README.md index d3450986325..e0136c1b37a 100644 --- a/examples/spring-dynatrace-oneagent/README.md +++ b/examples/spring-dynatrace-oneagent/README.md @@ -4,7 +4,7 @@ Example to show how Java SDK can be used in a Spring Boot application with Dynat ## Requirements -- A Composable Commerce Project with a configured [API Client](https://docs.commercetools.com/api/getting-started/create-api-client). +- A commercetools Project with a configured [API Client](https://docs.commercetools.com/api/getting-started/create-api-client). Necessary scopes: `view_published_products`, `manage_orders` - Your Project must have existing products containing variants with SKUs, and at least one customer, the storefront search endpoint must be active. - If your Project is currently empty, you can install the [SUNRISE sample data](https://github.com/commercetools/commercetools-sunrise-data). diff --git a/examples/spring-dynatrace-oneagent/src/main/resources/templates/home/index.html b/examples/spring-dynatrace-oneagent/src/main/resources/templates/home/index.html index b72394f2db8..5ec81412af6 100644 --- a/examples/spring-dynatrace-oneagent/src/main/resources/templates/home/index.html +++ b/examples/spring-dynatrace-oneagent/src/main/resources/templates/home/index.html @@ -1,11 +1,11 @@ - commercetools Composable Commerce Spring example + commercetools Spring example
-

This is an example application showing the integration of commercetools Composable Commerce in a Spring Boot MVC environment.

+

This is an example application showing the integration of commercetools in a Spring Boot MVC environment.

diff --git a/examples/spring-newrelic/README.md b/examples/spring-newrelic/README.md index 982e7c3b67c..9695bae7302 100644 --- a/examples/spring-newrelic/README.md +++ b/examples/spring-newrelic/README.md @@ -4,7 +4,7 @@ Example to show how Java SDK can be used in a Spring Boot application with NewRe ## Requirements -- A Composable Commerce Project with a configured [API Client](https://docs.commercetools.com/api/getting-started/create-api-client). +- A commercetools Project with a configured [API Client](https://docs.commercetools.com/api/getting-started/create-api-client). Necessary scopes: `view_published_products`, `manage_orders` - Your Project must have existing products containing variants with SKUs, and at least one customer, the storefront search endpoint must be active. - If your Project is currently empty, you can install the [SUNRISE sample data](https://github.com/commercetools/commercetools-sunrise-data). diff --git a/examples/spring-newrelic/src/main/resources/templates/home/index.html b/examples/spring-newrelic/src/main/resources/templates/home/index.html index b72394f2db8..5ec81412af6 100644 --- a/examples/spring-newrelic/src/main/resources/templates/home/index.html +++ b/examples/spring-newrelic/src/main/resources/templates/home/index.html @@ -1,11 +1,11 @@ - commercetools Composable Commerce Spring example + commercetools Spring example
-

This is an example application showing the integration of commercetools Composable Commerce in a Spring Boot MVC environment.

+

This is an example application showing the integration of commercetools in a Spring Boot MVC environment.

diff --git a/examples/spring-otel/README.md b/examples/spring-otel/README.md index 7032cbcd658..5d60a99a62e 100644 --- a/examples/spring-otel/README.md +++ b/examples/spring-otel/README.md @@ -6,7 +6,7 @@ OpenTelemetry auto instrumentation. ## Requirements -- A Composable Commerce Project with a configured [API Client](https://docs.commercetools.com/api/getting-started/create-api-client). +- A commercetools Project with a configured [API Client](https://docs.commercetools.com/api/getting-started/create-api-client). Necessary scopes: `view_published_products`, `manage_orders` - Your Project must have existing products containing variants with SKUs, and at least one customer, the storefront search endpoint must be active. - If your Project is currently empty, you can install the [SUNRISE sample data](https://github.com/commercetools/commercetools-sunrise-data). diff --git a/examples/spring-otel/src/main/resources/templates/home/index.html b/examples/spring-otel/src/main/resources/templates/home/index.html index b72394f2db8..5ec81412af6 100644 --- a/examples/spring-otel/src/main/resources/templates/home/index.html +++ b/examples/spring-otel/src/main/resources/templates/home/index.html @@ -1,11 +1,11 @@ - commercetools Composable Commerce Spring example + commercetools Spring example
-

This is an example application showing the integration of commercetools Composable Commerce in a Spring Boot MVC environment.

+

This is an example application showing the integration of commercetools in a Spring Boot MVC environment.

diff --git a/examples/spring/README.md b/examples/spring/README.md index 57d8a82f768..6b8629e6d52 100644 --- a/examples/spring/README.md +++ b/examples/spring/README.md @@ -4,7 +4,7 @@ Example to show how the ME endpoints can be used with the Java SDK in a Spring B ## Requirements -- A Composable Commerce Project with a configured [API Client](https://docs.commercetools.com/api/getting-started/create-api-client). +- A commercetools Project with a configured [API Client](https://docs.commercetools.com/api/getting-started/create-api-client). Necessary scopes: `view_published_products`, `view_categories`, `manage_my_profile`, `manage_my_shopping_lists`, `manage_my_payments`, `manage_my_orders` - Your Project must have existing products containing variants with SKUs, and at least one customer, the storefront search endpoint must be active. - If your Project is currently empty, you can install the [SUNRISE sample data](https://github.com/commercetools/commercetools-sunrise-data). diff --git a/examples/spring/src/main/resources/templates/home/index.html b/examples/spring/src/main/resources/templates/home/index.html index 6022a58daa7..615b7cad404 100644 --- a/examples/spring/src/main/resources/templates/home/index.html +++ b/examples/spring/src/main/resources/templates/home/index.html @@ -1,11 +1,11 @@ - commercetools Composable Commerce Spring example + commercetools Spring example
-

This is an example application showing the integration of commercetools Composable Commerce in a Spring Boot webflux environment.

+

This is an example application showing the integration of commercetools in a Spring Boot webflux environment.

diff --git a/rmf/rmf-java-base/src/main/java/io/vrap/rmf/base/client/utils/json/JsonUtils.java b/rmf/rmf-java-base/src/main/java/io/vrap/rmf/base/client/utils/json/JsonUtils.java index 0ae4ba4df3f..a7301825cf6 100644 --- a/rmf/rmf-java-base/src/main/java/io/vrap/rmf/base/client/utils/json/JsonUtils.java +++ b/rmf/rmf-java-base/src/main/java/io/vrap/rmf/base/client/utils/json/JsonUtils.java @@ -125,7 +125,7 @@ public static T fromJsonNode(final JsonNode jsonNode, final TypeReference } /** - * Converts a commercetools Composable Commerce Java object to JSON as {@link JsonNode}. + * Converts a commercetools Java object to JSON as {@link JsonNode}. *

If {@code value} is of type String and contains JSON data, that will be ignored, {@code value} will be treated as just any String. * If you want to parse a JSON String to a JsonNode use {@link JsonUtils#parse(java.lang.String)} instead.

*

diff --git a/src/main/javadoc/overview.html b/src/main/javadoc/overview.html index 4268462f852..95516d85339 100644 --- a/src/main/javadoc/overview.html +++ b/src/main/javadoc/overview.html @@ -1,5 +1,5 @@ - commercetools Composable Commerce Java SDK. + commercetools Java SDK.

Pages about the SDK