Java plugin docu #524

rjayasinghe · 2023-11-07T15:52:36Z

No description provided.

github-actions

Linting Errors

java/plugin_concept.md:117 Fenced code blocks should have a language specified

Spelling Mistakes

./java/plugin_concept.md:25:12 Unknown word "reuasable"
./java/plugin_concept.md:74:28 Unknown word "indepently"
./java/plugin_concept.md:78:455 Unknown word "addded"
./java/plugin_concept.md:95:98 Unknown word "reigstration"

Generally, for each spelling mistake there are 2 ways to fix it:

Fix the spelling mistake and commit it.
The word is incorrectly reported as misspelled → put the word on the project-words.txt list, located in the root project directory.

java/plugin_concept.md

github-actions

Spelling Mistakes

./java/plugin_concept.md:129:380 Unknown word "HCQL"

Generally, for each spelling mistake there are 2 ways to fix it:

Fix the spelling mistake and commit it.
The word is incorrectly reported as misspelled → put the word on the project-words.txt list, located in the root project directory.

java/plugin_concept.md

github-actions

Spelling Mistakes

./java/plugin_concept.md:25:12 Unknown word "Reuasable"
./java/plugin_concept.md:78:28 Unknown word "indepently"
./java/plugin_concept.md:84:132 Unknown word "addded"
./java/plugin_concept.md:101:98 Unknown word "reigstration"
./java/plugin_concept.md:137:380 Unknown word "HCQL"

Generally, for each spelling mistake there are 2 ways to fix it:

Fix the spelling mistake and commit it.
The word is incorrectly reported as misspelled → put the word on the project-words.txt list, located in the root project directory.

java/plugin_concept.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

github-actions

Spelling Mistakes

./java/plugin_concept.md:84:128 Unknown word "addded"

Generally, for each spelling mistake there are 2 ways to fix it:

Fix the spelling mistake and commit it.
The word is incorrectly reported as misspelled → put the word on the project-words.txt list, located in the root project directory.

java/plugin_concept.md

beckermarc

Some additional comments from my side :)

java/plugin_concept.md

Co-authored-by: Marc Becker <[email protected]>

t-bonk

Please add a remark, that the groupId com.sap.cds shall not be used by 3rd party plugins, adapters etc.

rjayasinghe · 2023-11-30T13:22:55Z

Please add a remark, that the groupId com.sap.cds shall not be used by 3rd party plugins, adapters etc.

fixed!

rjayasinghe · 2023-12-07T10:32:06Z

Please add a remark, that the groupId com.sap.cds shall not be used by 3rd party plugins, adapters etc.

I added a section for that.

resolved

t-bonk

LGTM

renejeglinsky · 2023-12-11T10:22:06Z

Should I rename the file from plugin-concept to just plugins? Or sth else?

java/plugin_concept.md

renejeglinsky · 2023-12-11T10:38:26Z

java/plugin_concept.md

+
+### Reference the Reuse Model in an Existing CAP Java Project
+
+Projects wanting to import the content simply add a Maven dependency to the reuse package to their `pom.xml` in the `<dependencies>` section.


Is it the parent pom in this case?

Suggested change

Projects wanting to import the content simply add a Maven dependency to the reuse package to their `pom.xml` in the `<dependencies>` section.

Projects wanting to import the content simply add a Maven dependency to the reuse package to their `./pom.xml` in the `<dependencies>` section.

It‘s the srv/pom.xml

Do I consume that, until this point locally? If yes, I guess the location of the new artifact is in parallel to my CAP project, as it is also for Node.js, right?
Or do we need a "Publish to Maven" step in between this and the previous step?

renejeglinsky · 2023-12-11T10:41:52Z

java/plugin_concept.md

+  </executions>
+</plugin>
+```
+> Please be ware that the module that uses the reuse module needs to be a Maven module itself or a submodule to a Maven module that declares the dependency to the Maven module. Usually you would declare the dependency in the `srv` module of your CAP Java project and use the reuse model in the service's CDS files then. In case you want to use the reuse model in your `db` module you need to make sure that your `db` module is a Maven module and include it to the project's parent `pom.xml` file.


How do I declare the dependency? In the srv/pom.xml?

Suggested change

> Please be ware that the module that uses the reuse module needs to be a Maven module itself or a submodule to a Maven module that declares the dependency to the Maven module. Usually you would declare the dependency in the `srv` module of your CAP Java project and use the reuse model in the service's CDS files then. In case you want to use the reuse model in your `db` module you need to make sure that your `db` module is a Maven module and include it to the project's parent `pom.xml` file.

> Please be aware that the module that uses the reuse module needs to be a Maven module itself or a submodule to a Maven module that declares the dependency to the Maven module. Usually you would declare the dependency in the _srv/pom.xml_ of your CAP Java project and use the reuse model in the service's CDS files then. In case you want to use the reuse model in your `db` module you need to make sure that there's a _db/pom.xml_ in your _db_ folder to declare as a Maven module and include this module then to the project's parent `pom.xml` file.

renejeglinsky · 2023-12-13T07:11:35Z

java/plugin_concept.md

+
+## Custom Protocol Adapters {#protocol-adapter}
+
+In CAP Java, the protocol adapter is the mechanism to implement inbound communication (another service or the UI) to the CAP service in development. The task of a protocol adapter is to translate any incoming requests of a defined protocol to CQL statements that then can be executed on locally defined CDS services. CAP Java comes with 3 protocol adapters (OData V2 and V4, and HCQL) but can be extended with custom implementations. In this section we'll have a deeper look on how such a protocol adapter can be built and registered with the CAP Java runtime.


How about shortening this intro and link to https://cap.cloud.sap/docs/java/architecture#protocol-adapters? This chapter about protocol adapters would need an update then, I guess?

renejeglinsky · 2023-12-13T09:38:37Z

Will merge this and go over some points with Robin later.

rjayasinghe and others added 7 commits October 17, 2023 09:48

WIP

2d9fff2

Merge remote-tracking branch 'origin/main' into java_plugin_docu

ed2b776

fix build error, continue text

22d71a5

continued guide

7cc046d

continue document

c57e658

Merge remote-tracking branch 'origin/main' into java_plugin_docu

7fc3e80

started protocol adapter section

459f224

rjayasinghe requested review from renejeglinsky and smahati as code owners November 7, 2023 15:52

rjayasinghe marked this pull request as draft November 7, 2023 15:53

github-actions bot reviewed Nov 7, 2023

View reviewed changes

rjayasinghe requested review from beckermarc and BraunMatthias November 7, 2023 15:53

continued protocol adapter section

6510941

github-actions bot reviewed Nov 9, 2023

View reviewed changes

java/plugin_concept.md Outdated Show resolved Hide resolved

rjayasinghe requested review from dimamost and removed request for beckermarc and BraunMatthias November 15, 2023 07:58

rename guide and smaller fixes

0084f20

github-actions bot reviewed Nov 15, 2023

View reviewed changes

dimamost reviewed Nov 16, 2023

View reviewed changes

java/plugin_concept.md Outdated Show resolved Hide resolved

java/plugin_concept.md Outdated Show resolved Hide resolved

rjayasinghe and others added 5 commits November 21, 2023 16:59

Apply suggestions from code review

02fa38d

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Apply suggestions from code review

59eae63

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Apply suggestions from code review

12accf5

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

fix typos

c5b3576

added missing interface name

5e83864

github-actions bot reviewed Nov 21, 2023

View reviewed changes

java/plugin_concept.md Outdated Show resolved Hide resolved

fixed further typo

741d607

rjayasinghe marked this pull request as ready for review November 21, 2023 16:07

Merge branch 'main' into java_plugin_docu

bb0438d

beckermarc reviewed Nov 24, 2023

View reviewed changes

rjayasinghe and others added 3 commits November 24, 2023 19:08

fix section about project layout for model reuse

6028e35

reworked event handler section

777b0dd

Update java/plugin_concept.md

491c170

Co-authored-by: Marc Becker <[email protected]>

t-bonk previously requested changes Nov 27, 2023

View reviewed changes

rjayasinghe added 2 commits November 29, 2023 19:26

extended section about event handler plugin

e956033

Merge remote-tracking branch 'origin/main' into java_plugin_docu

e1461d3

This comment was marked as resolved.

Sign in to view

rjayasinghe added 2 commits November 29, 2023 19:29

fix typo

9d98c09

add general considerations section

2f5f96a

This comment was marked as outdated.

Sign in to view

fix typo

5a3d6ce

correct further typos

dd18256

t-bonk approved these changes Dec 7, 2023

View reviewed changes

renejeglinsky reviewed Dec 11, 2023

View reviewed changes

java/plugin_concept.md Outdated Show resolved Hide resolved

renejeglinsky reviewed Dec 11, 2023

View reviewed changes

java/plugin_concept.md Outdated Show resolved Hide resolved

renejeglinsky reviewed Dec 11, 2023

View reviewed changes

edit

e516916

renejeglinsky reviewed Dec 13, 2023

View reviewed changes

spellcheck

72735ec

renejeglinsky approved these changes Dec 13, 2023

View reviewed changes

renejeglinsky added 2 commits December 13, 2023 10:40

renamed file

7784bd7

renamed file

f051ca1

renejeglinsky merged commit 31e8b5a into main Dec 13, 2023
4 checks passed

renejeglinsky deleted the java_plugin_docu branch December 13, 2023 09:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Java plugin docu #524

Java plugin docu #524

rjayasinghe commented Nov 7, 2023

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

beckermarc left a comment

t-bonk left a comment

This comment was marked as resolved.

This comment was marked as outdated.

rjayasinghe commented Nov 30, 2023

rjayasinghe commented Dec 7, 2023

t-bonk left a comment

renejeglinsky commented Dec 11, 2023

renejeglinsky Dec 11, 2023

rjayasinghe Dec 12, 2023

renejeglinsky Dec 13, 2023

renejeglinsky Dec 11, 2023 •

edited

Loading

renejeglinsky Dec 13, 2023

renejeglinsky commented Dec 13, 2023


		### Reference the Reuse Model in an Existing CAP Java Project

		Projects wanting to import the content simply add a Maven dependency to the reuse package to their `pom.xml` in the `<dependencies>` section.


		## Custom Protocol Adapters {#protocol-adapter}

		In CAP Java, the protocol adapter is the mechanism to implement inbound communication (another service or the UI) to the CAP service in development. The task of a protocol adapter is to translate any incoming requests of a defined protocol to CQL statements that then can be executed on locally defined CDS services. CAP Java comes with 3 protocol adapters (OData V2 and V4, and HCQL) but can be extended with custom implementations. In this section we'll have a deeper look on how such a protocol adapter can be built and registered with the CAP Java runtime.

Java plugin docu #524

Java plugin docu #524

Conversation

rjayasinghe commented Nov 7, 2023

github-actions bot left a comment

Choose a reason for hiding this comment

Linting Errors

Spelling Mistakes

github-actions bot left a comment

Choose a reason for hiding this comment

Spelling Mistakes

github-actions bot left a comment

Choose a reason for hiding this comment

Spelling Mistakes

github-actions bot left a comment

Choose a reason for hiding this comment

Spelling Mistakes

beckermarc left a comment

Choose a reason for hiding this comment

t-bonk left a comment

Choose a reason for hiding this comment

This comment was marked as resolved.

This comment was marked as outdated.

rjayasinghe commented Nov 30, 2023

rjayasinghe commented Dec 7, 2023

t-bonk left a comment

Choose a reason for hiding this comment

renejeglinsky commented Dec 11, 2023

renejeglinsky Dec 11, 2023

Choose a reason for hiding this comment

rjayasinghe Dec 12, 2023

Choose a reason for hiding this comment

renejeglinsky Dec 13, 2023

Choose a reason for hiding this comment

renejeglinsky Dec 11, 2023 • edited Loading

Choose a reason for hiding this comment

renejeglinsky Dec 13, 2023

Choose a reason for hiding this comment

renejeglinsky commented Dec 13, 2023

renejeglinsky Dec 11, 2023 •

edited

Loading