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: docs/api/communication-profiles/generic-http-template.md
+6-3Lines changed: 6 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,10 @@ This page describes the Generic HTTP Communication Profile (CP), which templates
10
10
| Transfer protocol |[HTTP 1.1](https://datatracker.ietf.org/doc/html/rfc2616)|
11
11
| Data Encryption | N/A |
12
12
| Data Compression | N/A |
13
-
| Payload Format |[JSON](https://datatracker.ietf.org/doc/html/rfc8259) / Text |
13
+
14
+
## Payload Aspects
15
+
16
+
Generic HTTP - CP does not regulate the service payload format. Any format (JSON, XML, Plain Text, etc.) may be used that best fits the requirements of the given [Service](../../help/definitions.md#microservice-or-service). The chosen data format and implemented data model are mandatory to specify in the Interface Design Descriptions (IDD).
14
17
15
18
## Service Interface Template
16
19
@@ -64,9 +67,9 @@ If the access right is required to be proven, then an [Access Token](../../help/
64
67
65
68
---
66
69
67
-
### Payload
70
+
### Body
68
71
69
-
The data to be transmitted to or from a given [service-operation](../../help/definitions.md#service-operation) (endpoint). In case of hierarchical data, the payload must be in [JSON](https://datatracker.ietf.org/doc/html/rfc8259) data format and must be placed into the [HTTP Meassage Body](https://datatracker.ietf.org/doc/html/rfc2616#section-4.3). In case of non-hierarchical data, text data format can be used and placed into the [HTTP Meassage Body](https://datatracker.ietf.org/doc/html/rfc2616#section-4.3) or into the request [URI](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier) as URI encoded path variable or query parameter. It is mandatory to specify it in IDDs.
72
+
The data to be transmitted to or from a given [service-operation](../../help/definitions.md#service-operation) (endpoint). In case of hierarchical data, the body could be in [JSON](https://datatracker.ietf.org/doc/html/rfc8259)or in [XML](https://en.wikipedia.org/wiki/XML) or in any other suitable data format and should be placed into the [HTTP Meassage Body](https://datatracker.ietf.org/doc/html/rfc2616#section-4.3). In case of simple and non-hierarchical data, text data format can be used and placed into the [HTTP Meassage Body](https://datatracker.ietf.org/doc/html/rfc2616#section-4.3) or into the request [URI](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier) as URI encoded path variable or query parameter. It is mandatory to specify it in IDDs.
Copy file name to clipboardExpand all lines: docs/api/communication-profiles/generic-https-template.md
+4-1Lines changed: 4 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,10 @@ This page describes the Generic HTTPS Communication Profile (CP), which template
10
10
| Transfer protocol |[HTTP 1.1](https://datatracker.ietf.org/doc/html/rfc2616)|
11
11
| Data Encryption |[TLS](https://en.wikipedia.org/wiki/Transport_Layer_Security)|
12
12
| Data Compression | N/A |
13
-
| Payload Format |[JSON](https://datatracker.ietf.org/doc/html/rfc8259) / Text |
13
+
14
+
## Payload Aspects
15
+
16
+
Generic HTTPS - CP does not regulate the service payload format. Any format (JSON, XML, Plain Text, etc.) may be used that best fits the requirements of the given [Service](../../help/definitions.md#microservice-or-service). The chosen data format and implemented data model are mandatory to specify in the Interface Design Descriptions (IDD).
Copy file name to clipboardExpand all lines: docs/api/communication-profiles/generic-mqtt-template.md
+4-1Lines changed: 4 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,10 @@ This page describes the Generic MQTT Communication Profile (CP), which templates
10
10
| Transfer protocol |[MQTT 3.1](https://public.dhe.ibm.com/software/dw/webservices/ws-mqtt/mqtt-v3r1.html)[MQTT 3.1.1](https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html)|
11
11
| Data Encryption | N/A |
12
12
| Data Compression | N/A |
13
-
| Payload Format |[JSON](https://datatracker.ietf.org/doc/html/rfc8259)|
13
+
14
+
## Payload Aspects
15
+
16
+
Generic MQTT - CP regulates the message payload format and data model to be used, and it also regulates the service payload format (see the [message templates section](#message-templates)). However it does not regulate the service payload data model. All payload formats and data models are mandatory to specify in the Interface Design Descriptions (IDD).
Copy file name to clipboardExpand all lines: docs/api/communication-profiles/generic-mqtts-template.md
+4-1Lines changed: 4 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,10 @@ This page describes the Generic MQTTS Communication Profile (CP), which template
10
10
| Transfer protocol |[MQTT 3.1](https://public.dhe.ibm.com/software/dw/webservices/ws-mqtt/mqtt-v3r1.html)[MQTT 3.1.1](https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html)|
11
11
| Data Encryption |[TLS](https://en.wikipedia.org/wiki/Transport_Layer_Security)|
12
12
| Data Compression | N/A |
13
-
| Payload Format |[JSON](https://datatracker.ietf.org/doc/html/rfc8259)|
13
+
14
+
## Payload Aspects
15
+
16
+
Generic MQTTS - CP regulates the message payload format and data model to be used, and it also regulates the service payload format (see the [message templates section](./generic-mqtt-template.md#message-templates)). However it does not regulate the service payload data model. All payload formats and data models are mandatory to specify in the Interface Design Descriptions (IDD).
Copy file name to clipboardExpand all lines: docs/api/primitives.md
+3-4Lines changed: 3 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ A unique **String** of characters that is issued for a beneficiary system and is
6
6
7
7
## AccessTokenVariant
8
8
9
-
**String** value that specifies an exact token technology variant. The possible values are `TIME_LIMITED_TOKEN_AUTH`, `USAGE_LIMITED_TOKEN_AUTH`, `BASE64_SELF_CONTAINED_TOKEN_AUTH`, `RSA_SHA256_JSON_WEB_TOKEN_AUTH`, `RSA_SHA512_JSON_WEB_TOKEN_AUTH`.
9
+
**String** value that specifies an exact token technology variant. The possible values are `TIME_LIMITED_TOKEN_AUTH`, `USAGE_LIMITED_TOKEN_AUTH`, `BASE64_SELF_CONTAINED_TOKEN_AUTH`, `RSA_SHA256_JSON_WEB_TOKEN_AUTH`, `RSA_SHA512_JSON_WEB_TOKEN_AUTH`, `TRANSLATION_BRIDGE_TOKEN_AUTH`.
10
10
11
11
## Address
12
12
@@ -133,7 +133,6 @@ A **String** identifier of any suitable validator function chosen by the impleme
133
133
}
134
134
```
135
135
The validation and normalization happens according to the HTTP standards.
136
-
137
136
138
137
## Protocol
139
138
@@ -145,7 +144,7 @@ A Base64 **String** representation of the public byte array cryptographic key re
145
144
146
145
## SecurityPolicy
147
146
148
-
A **String** representation of security policies. The possible values are: `NONE`, `CERT_AUTH`, `TIME_LIMITED_TOKEN_AUTH`, `USAGE_LIMITED_TOKEN_AUTH`, `BASE64_SELF_CONTAINED_TOKEN_AUTH`, `RSA_SHA256_JSON_WEB_TOKEN_AUTH`, `RSA_SHA512_JSON_WEB_TOKEN_AUTH`.
147
+
A **String** representation of security policies. The possible values are: `NONE`, `CERT_AUTH`, `TIME_LIMITED_TOKEN_AUTH`, `USAGE_LIMITED_TOKEN_AUTH`, `BASE64_SELF_CONTAINED_TOKEN_AUTH`, `RSA_SHA256_JSON_WEB_TOKEN_AUTH`, `RSA_SHA512_JSON_WEB_TOKEN_AUTH`, `TRANSLATION_BRIDGE_TOKEN_AUTH`.
149
148
150
149
## ServiceInstanceID
151
150
@@ -176,7 +175,7 @@ A **String** identifier that is intended to be both human and machine-readable.
176
175
177
176
## TokenType
178
177
179
-
A **String** name that groups token technologies by usage characteristics. Can be `USAGE_LIMITED_TOKEN`, `TIME_LIMITED_TOKEN`or `SELF_CONTAINED_TOKEN`.
178
+
A **String** name that groups token technologies by usage characteristics. Can be `USAGE_LIMITED_TOKEN`, `TIME_LIMITED_TOKEN`, `SELF_CONTAINED_TOKEN` or `TRANSLATION_BRIDGE_TOKEN`.
If you think you have found a vulnerability, please report it to us through coordinated disclosure.
6
+
7
+
**Please do not report security vulnerabilities through public issues, discussions, or change requests.**
8
+
9
+
Instead, report it using one of the following ways:
10
+
11
+
* Contact the [Eclipse Foundation Security Team](mailto:security@eclipse-foundation.org) via email
12
+
* Create a [confidential issue](https://gitlab.eclipse.org/security/vulnerability-reports/-/issues/new?issuable_template=new_vulnerability) in the Eclipse Foundation Vulnerability Reporting Tracker
13
+
14
+
You can find more information about reporting and disclosure at the [Eclipse Foundation Security page](https://www.eclipse.org/security/).
15
+
16
+
## Found a Bug?
17
+
18
+
| Please open a GitHUB Issue in the related repository ||
19
+
|---|---|
20
+
| ServiceRegistry Core System |[:octicons-link-external-16::material-bug: report a bug](https://github.com/eclipse-arrowhead/ah5-core-java-spring/issues/new)|
21
+
| DynamicServiceOrchestration Core System |[:octicons-link-external-16::material-bug: report a bug](https://github.com/eclipse-arrowhead/ah5-core-java-spring/issues/new)|
22
+
| ConsumerAuthorization Core System |[:octicons-link-external-16::material-bug: report a bug](https://github.com/eclipse-arrowhead/ah5-core-java-spring/issues/new)|
23
+
| Authentication Core System |[:octicons-link-external-16::material-bug: report a bug](https://github.com/eclipse-arrowhead/ah5-core-java-spring/issues/new)|
24
+
| Blacklist Support System |[:octicons-link-external-16::material-bug: report a bug](https://github.com/eclipse-arrowhead/ah5-blacklist-java-spring/issues/new)|
25
+
|**Not sure where it belongs?**|[:octicons-link-external-16::material-bug: report a bug](https://github.com/eclipse-arrowhead/ah5-common-java-spring/issues/new)|
Copy file name to clipboardExpand all lines: docs/contribute/code-contribution.md
+6-3Lines changed: 6 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
-
# Contribute
1
+
# Code Contribution
2
2
3
3
## Eclipse Contributor Agreement
4
4
5
-
Since Arrowhead project is governed within the Eclipse Foundation, the authors of any contribution must agree and accept the [Eclipse Contributor Agreement ("ECA")](https://www.eclipse.org/legal/ECA.php).
5
+
Since Arrowhead project is governed within the [Eclipse Foundation](https://projects.eclipse.org/projects/iot.arrowhead), the authors of any contribution must agree and accept the [Eclipse Contributor Agreement ("ECA")](https://www.eclipse.org/legal/ECA.php).
6
6
7
7
Technically it means that contributors need an [Eclipse Fundation Account](https://accounts.eclipse.org/user/register?destination=user/edit) which makes possible to submit a signed ECA! GitHub Pull Requests could be accepted only when all the authors own an Eclipse Foundation Account with the signed ECA!
8
8
@@ -18,19 +18,22 @@ Use the command below to configure your git client globally:
18
18
19
19
Whithout the `--global` flag you can set the email address only for that specific project where the command was executed.
20
20
21
+
[Learn more from Eclipse Handbook.](https://www.eclipse.org/projects/handbook/#resources-commit)
22
+
21
23
## Way of contributing
22
24
23
25
1)**Fork (and not clone) the project repository.**
24
26
25
27
-[Working with forks](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks)
28
+
- For developing a completely new components, [open a ticket](https://github.com/eclipse-arrowhead/roadmap/issues/new)
26
29
27
30
2)**Create a new branch in your fork and from the `development` branch for your contribution.**
28
31
29
32
_(Creating and pushing new branches within a cloned repository is allowed only for official [Committers](https://projects.eclipse.org/projects/iot.arrowhead/who))_
30
33
31
34
3)**Take care of coding clean!**
32
35
33
-
- Stick to the [Implementation Structure](./implementation.md#implementation-structure)
36
+
- Stick to the [Implementation Structure](../home/implementation.md#implementation-structure)
34
37
-[Clean coding in Java](https://www.baeldung.com/java-clean-code)
35
38
-[A short summary of Java coding best practices](https://rhamedy.medium.com/a-short-summary-of-java-coding-best-practices-31283d0167d3)
ServiceRegistry Core System | [AH-serviceregistry-5.0.0.zip](https://github.com/eclipse-arrowhead/ah5-core-java-spring/releases/download/v5.0.0/AH-serviceregistry-5.0.0.zip)
10
+
DynamicServiceOrchestration Core System | [AH-serviceorchestration-dynamic-5.0.0.zip](https://github.com/eclipse-arrowhead/ah5-core-java-spring/releases/download/v5.0.0/AH-serviceorchestration-dynamic-5.0.0.zip)
11
+
ConsumerAuthorization Core System | [AH-consumerauthorization-5.0.0.zip](https://github.com/eclipse-arrowhead/ah5-core-java-spring/releases/download/v5.0.0/AH-consumerauthorization-5.0.0.zip)
12
+
Authentication Core System | [AH-authentication-5.0.0.zip](https://github.com/eclipse-arrowhead/ah5-core-java-spring/releases/download/v5.0.0/AH-authentication-5.0.0.zip)
13
+
Blacklist Support System | [AH-blacklist-5.0.0.zip](https://github.com/eclipse-arrowhead/ah5-blacklist-java-spring/releases/download/v5.0.0/AH-blacklist-5.0.0.zip)
| Local Cloud Profile |`TestCloud.Company.arrowhead.eu`|[TestCloud.p12](https://raw.githubusercontent.com/eclipse-arrowhead/ah5-common-java-spring/master/certificates/TestCloud.p12)|
ServiceRegistry Core System | [AH-serviceregistry-5.0.0-TESTBUILD-2.zip](https://github.com/eclipse-arrowhead/ah5-core-java-spring/releases/download/v5.0.0-TESTBUILD-2/AH-serviceregistry-5.0.0-TESTBUILD-2.zip)
19
+
DynamicServiceOrchestration Core System | [AH-serviceorchestration-dynamic-5.0.0-TESTBUILD-2.zip](https://github.com/eclipse-arrowhead/ah5-core-java-spring/releases/download/v5.0.0-TESTBUILD-2/AH-serviceorchestration-dynamic-5.0.0-TESTBUILD-2.zip)
20
+
ConsumerAuthorization Core System | [AH-consumerauthorization-5.0.0-TESTBUILD-2.zip](https://github.com/eclipse-arrowhead/ah5-core-java-spring/releases/download/v5.0.0-TESTBUILD-2/AH-consumerauthorization-5.0.0-TESTBUILD-2.zip)
21
+
Authentication Core System | [AH-authentication-5.0.0-TESTBUILD-2.zip](https://github.com/eclipse-arrowhead/ah5-core-java-spring/releases/download/v5.0.0-TESTBUILD-2/AH-authentication-5.0.0-TESTBUILD-2.zip)
22
+
Blacklist Support System | [AH-blacklist-5.0.0-TESTBUILD-2.zip](https://github.com/eclipse-arrowhead/ah5-blacklist-java-spring/releases/download/v5.0.0-TESTBUILD-2/AH-blacklist-5.0.0-TESTBUILD-2.zip)
ServiceRegistry Core System | [AH-serviceregistry-5.0.0-TESTBUILD-1.zip](https://github.com/eclipse-arrowhead/ah5-core-java-spring/releases/download/v5.0.0-TESTBUILD-1/arrowhead-serviceregistry-5.0.0-TESTBUILD-1.zip)
32
+
DynamicServiceOrchestration Core System | [AH-serviceorchestration-dynamic-5.0.0-TESTBUILD-1.zip](https://github.com/eclipse-arrowhead/ah5-core-java-spring/releases/download/v5.0.0-TESTBUILD-1/arrowhead-serviceorchestration-dynamic-5.0.0-TESTBUILD-1.zip)
33
+
Authentication Core System | [AH-authentication-5.0.0-TESTBUILD-1.zip](https://github.com/eclipse-arrowhead/ah5-core-java-spring/releases/download/v5.0.0-TESTBUILD-1/arrowhead-authentication-5.0.0-TESTBUILD-1.zip)
34
+
Blacklist Support System | [AH-blacklist-5.0.0-TESTBUILD-1.zip](https://github.com/eclipse-arrowhead/ah5-blacklist-java-spring/releases/download/v5.0.0-TESTBUILD-1/arrowhead-blacklist-5.0.0-TESTBUILD-1.zip)
ServiceRegistry Core System | [AH-serviceregistry-5.0.0-TESTBUILD-0.zip](https://github.com/eclipse-arrowhead/ah5-core-java-spring/releases/download/v5.0.0-TESTBUILD-0/arrowhead-serviceregistry-5.0.0-TESTBUILD-0.zip)
0 commit comments