Release 1.0.0

Author: brice-ruppen

CODE_OF_CONDUCT.md

@@ -0,0 +1,80 @@
+# Community Code of Conduct
+
+**Version 1.2 
+August 19, 2020**
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as 
+community members, contributors, committers, and project leaders pledge 
+to make participation in our project and our community a harassment-free 
+experience for everyone, regardless of age, body size, disability, ethnicity, 
+sex characteristics, gender identity and expression, level of experience, 
+education, socio-economic status, nationality, personal appearance, race, 
+religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+With the support of the Eclipse Foundation staff (the “Staff”), project committers 
+and leaders are responsible for clarifying the standards of acceptable behavior and 
+are expected to take appropriate and fair corrective action in response to any 
+instances of unacceptable behavior.
+
+Project committers and leaders have the right and responsibility to remove, edit, 
+or reject comments, commits, code, wiki edits, issues, and other contributions that 
+are not aligned to this Code of Conduct, or to ban temporarily or permanently any 
+contributor for other behaviors that they deem inappropriate, threatening, offensive, 
+or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when an 
+individual is representing the Eclipse Foundation project or its community in public 
+spaces. Examples of representing a project or community include posting via an official 
+social media account, or acting as a project representative at an online or offline 
+event. Representation of a project may be further defined and clarified by project 
+committers, leaders, or the EMO.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported 
+by contacting the Staff at codeofconduct@eclipse.org. All complaints will be reviewed 
+and investigated and will result in a response that is deemed necessary and appropriate 
+to the circumstances. The Staff is obligated to maintain confidentiality with regard to 
+the reporter of an incident. Further details of specific enforcement policies may be 
+posted separately.
+
+Project committers or leaders who do not follow the Code of Conduct in good faith may 
+face temporary or permanent repercussions as determined by the Staff.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,72 @@
+# Contributing to 'Eclipse Keyple' Java implementation
+
+Thanks for your interest in this project.
+
+## Project description
+
+'Eclipse Keyple' Java implementation is a project containing all the content of the Java implementation of the [Eclipse Keyple](https://keyple.org/) API.
+
+* https://github.com/eclipse/keyple-java
+
+## Eclipse Contributor Agreement
+
+Before your contribution can be accepted by the project team contributors must
+electronically sign the Eclipse Contributor Agreement (ECA).
+
+* http://www.eclipse.org/legal/ECA.php
+
+Commits that are provided by non-committers must have a Signed-off-by field in
+the footer indicating that the author is aware of the terms by which the
+contribution has been provided to the project. The non-committer must
+additionally have an Eclipse Foundation account and must have a signed Eclipse
+Contributor Agreement (ECA) on file.
+
+For more information, please see the Eclipse Committer Handbook:
+https://www.eclipse.org/projects/handbook/#resources-commit
+
+## Eclipse Contributor Agreement
+
+Before your contribution can be accepted by the project team contributors must
+electronically sign the Eclipse Contributor Agreement (ECA).
+
+* http://www.eclipse.org/legal/ECA.php
+
+Commits that are provided by non-committers must have a Signed-off-by field in
+the footer indicating that the author is aware of the terms by which the
+contribution has been provided to the project. The non-committer must
+additionally have an Eclipse Foundation account and must have a signed Eclipse
+Contributor Agreement (ECA) on file.
+
+For more information, please see the Eclipse Committer Handbook:
+https://www.eclipse.org/projects/handbook/#resources-commit
+
+## Contribute via Fork
+You need a [GitHub](https://github.com/join) and an [Eclipse](https://accounts.eclipse.org/user/register) account for which you signed the [Eclipse Contributor Agreement](https://accounts.eclipse.org/user/login?destination=user/eca).
+
+ 1. Fork the repository on GitHub 
+ 1. Check if there is a [Jira issue](https://keyple.atlassian.net/projects/KEYP) for what you want to work on or create one.
+ 1. Announce in the comments section that you want to work on the issue. Also describe the solution you want to implement. To improve the chances for your contribution to be accepted, you'll want to wait for the feedback of the committers. 
+ 1. Create a new branch from *develop* for your changes. Name it after the Jira number, e.g. *KEYP-XXX_[descriptionofchanges]*.
+ 1. Implement your changes. 
+ 1. Rebase on *develop*.
+ 1. Run **./gradlew spotlessApply && android/gradlew spotlessApply** to format the code and add licence headers to the files.
+ 1. Run **./gradlew check && android/gradlew check** (to check code formatting and run tests)
+ 1. Commit using [Sign off](https://git-scm.com/docs/git-commit#git-commit--s) with the same email address you are using for your Eclipse account. Use descriptive and meaningful commit messages. In particular, start the first line of the commit message with the number of the issue that the commit addresses, e.g. *KEYP-XXX [descriptionofchanges]*.
+ 1. Push your changes to your forked repository.
+ 1. Create a [pull request (PR)](https://help.github.com/articles/using-pull-requests/) to *develop*.
+ 1. After submitting, do not use your branch for any other development, otherwise further changes that you make will be visible in the PR. 
+
+## Contributing for Committers
+You're a committer if you have write-access to the Keyple git-repositories.
+
+ 1. Make sure there is a [Jira issue](https://keyple.atlassian.net/projects/KEYP) for what you want to work on or create one.
+ 1. Assign the issue to yourself.
+ 1. Create a local git branch from *develop*. Name it after the Jira number, e.g. *KEYP-XXX_[descriptionofchanges]*.
+ 1. Implement your changes. 
+ 1. Rebase on *develop*.
+ 1. Run **./gradlew spotlessApply && android/gradlew spotlessApply** to format the code and add licence headers to the files.
+ 1. Run **./gradlew check && android/gradlew check** (to check code formatting and run tests)
+ 1. Commit using [Sign off](https://git-scm.com/docs/git-commit#git-commit--s) with the same email address you are using for your Eclipse account. Use descriptive and meaningful commit messages. In particular, start the first line of the commit message with the number of the issue that the commit addresses, e.g. *KEYP-XXX Update Keyple Core Unit tests*.
+ 1. Push the branch into the repository.
+ 1. Create a pull request and ask somebody who is familiar with the code you modified to review it.
+ 1. If the reviewer approves and all checks are OK, merge using squash commit.

Jenkinsfile

@@ -20,11 +20,16 @@ pipeline {
             }
             steps{
                 container('java-builder') {
+                    configFileProvider(
+                        [configFile(fileId: 'gradle.properties',
+                            targetLocation: '/home/jenkins/agent/gradle.properties')]) {
+                        sh 'ln -s /home/jenkins/agent/gradle.properties /home/jenkins/.gradle/gradle.properties'
+                        /* Read key Id in gradle.properties */
+                        sh 'head -1 /home/jenkins/.gradle/gradle.properties'
+                    }
                     withCredentials([
                         file(credentialsId: 'secret-subkeys.asc',
                             variable: 'KEYRING')]) {
-                        sh 'ln -s /home/jenkins/agent/gradle.properties /home/jenkins/.gradle/gradle.properties'
-                        
                         /* Import GPG keyring with --batch and trust the keys non-interactively in a shell build step */
                         sh 'gpg1 --batch --import "${KEYRING}"'
                         sh 'gpg1 --list-secret-keys'
@@ -33,12 +38,6 @@ pipeline {
                         sh 'for fpr in $(gpg1 --list-keys --with-colons  | awk -F: \'/fpr:/ {print $10}\' | sort -u); do echo -e "5\ny\n" |  gpg1 --batch --command-fd 0 --expert --edit-key ${fpr} trust; done'
                         sh 'ls -l  /home/jenkins/.gnupg/'
                     }
-                    configFileProvider(
-                        [configFile(fileId: 'gradle.properties',
-                            targetLocation: '/home/jenkins/agent/gradle.properties')]) {
-                        /* Read key Id in gradle.properties */
-                        sh 'head -1 /home/jenkins/.gradle/gradle.properties'
-                    }
                 }
             }
         }
@@ -85,15 +84,28 @@ pipeline {
             steps{
                 container('java-builder') {
                     sh 'keytool -genkey -v -keystore ~/.android/debug.keystore -storepass android -alias androiddebugkey -keypass android -dname "CN=Android Debug,O=Android,C=US" -keyalg RSA -keysize 2048 -validity 90'
-                    
-                    sh "./gradlew -b java/example/calypso/remotese/build.gradle check -P keyple_version=${keypleVersion}"
-                    
-                    dir('java/example/calypso/android/nfc/') {
+
+                    dir('java/example/generic/android/nfc/') {
                         sh "./gradlew assembleDebug -P keyple_version=${keypleVersion}"
                     }
-                    dir('java/example/calypso/android/omapi') {
+                    dir('java/example/generic/android/omapi') {
                         sh "./gradlew assembleDebug -P keyple_version=${keypleVersion}"
                     }
+                    dir('java/example/generic/distributed/UseCase7_PoolReaderServerSide_Webservice') {
+                        sh "./gradlew assemble -P keyple_version=${keypleVersion}"
+                    }
+                    dir('java/example/generic/distributed/UseCase1_ReaderClientSide_Webservice') {
+                        sh "./gradlew assemble -P keyple_version=${keypleVersion}"
+                    }
+                    dir('java/example/generic/distributed/UseCase1_ReaderClientSide_Websocket') {
+                        sh "./gradlew assemble -P keyple_version=${keypleVersion}"
+                    }
+                    dir('java/example/calypso') {
+                        sh "./gradlew assemble -P keyple_version=${keypleVersion}"
+                    }
+                    dir('java/example/generic/standalone') {
+                        sh "./gradlew assemble -P keyple_version=${keypleVersion}"
+                    }
                 }
             }
         }
@@ -122,7 +134,9 @@ pipeline {
                 catchError(buildResult: 'SUCCESS', message: 'Unable to log code quality to Sonar.', stageResult: 'FAILURE') {
                     container('java-builder') {
                         withCredentials([string(credentialsId: 'sonarcloud-token', variable: 'SONAR_LOGIN')]) {
+                            sh './gradlew --stop'
                             sh './gradlew codeQuality --info'
+                            sh './gradlew --stop'
                         }
                     }
                 }
@@ -137,7 +151,9 @@ pipeline {
                     container('java-builder') {
                         dir('android') {
                             withCredentials([string(credentialsId: 'sonarcloud-token', variable: 'SONAR_LOGIN')]) {
-                                sh './gradlew codeQuality'
+                                sh './gradlew --stop'
+                                sh './gradlew codeQuality --info'
+                                sh './gradlew --stop'
                             }
                         }
                     }
@@ -156,7 +172,9 @@ pipeline {
                         sh './gradlew :java:component:keyple-core:uploadArchives ${uploadParams}'
                         sh './gradlew :java:component:keyple-calypso:uploadArchives ${uploadParams}'
                         sh './gradlew :java:component:keyple-plugin:keyple-plugin-pcsc:uploadArchives ${uploadParams}'
-                        sh './gradlew :java:component:keyple-plugin:keyple-plugin-remotese:uploadArchives ${uploadParams}'
+                        sh './gradlew :java:component:keyple-distributed:keyple-distributed-network:uploadArchives ${uploadParams}'
+                        sh './gradlew :java:component:keyple-distributed:keyple-distributed-local:uploadArchives ${uploadParams}'
+                        sh './gradlew :java:component:keyple-distributed:keyple-distributed-remote:uploadArchives ${uploadParams}'
                         sh './gradlew :java:component:keyple-plugin:keyple-plugin-stub:uploadArchives ${uploadParams}'
                         sh './gradlew --stop'
                     }
@@ -193,10 +211,12 @@ pipeline {
                     sh 'cp ./java/component/keyple-calypso/build/libs/keyple-java-calypso*.jar ./repository/java'
                     sh 'cp ./java/component/keyple-core/build/libs/keyple-java-core*.jar ./repository/java'
                     sh 'cp ./java/component/keyple-plugin/pcsc/build/libs/keyple-java-plugin*.jar ./repository/java'
-                    sh 'cp ./java/component/keyple-plugin/remotese/build/libs/keyple-java-plugin*.jar ./repository/java'
+                    sh 'cp ./java/component/keyple-distributed/network/build/libs/keyple-java-distributed*.jar ./repository/java'
+                    sh 'cp ./java/component/keyple-distributed/local/build/libs/keyple-java-distributed*.jar ./repository/java'
+                    sh 'cp ./java/component/keyple-distributed/remote/build/libs/keyple-java-distributed*.jar ./repository/java'
                     sh 'cp ./java/component/keyple-plugin/stub/build/libs/keyple-java-plugin*.jar ./repository/java'
-                    sh 'cp ./java/example/calypso/android/nfc/build/outputs/apk/debug/*.apk ./repository/android'
-                    sh 'cp ./java/example/calypso/android/omapi/build/outputs/apk/debug/*.apk ./repository/android'
+                    sh 'cp ./java/example/generic/android/nfc/build/outputs/apk/debug/*.apk ./repository/android'
+                    sh 'cp ./java/example/generic/android/omapi/build/outputs/apk/debug/*.apk ./repository/android'
                     sh 'cp ./android/keyple-plugin/android-nfc/build/outputs/aar/keyple-android-plugin*.aar ./repository/android'
                     sh 'cp ./android/keyple-plugin/android-omapi/build/outputs/aar/keyple-android-plugin*.aar ./repository/android'
                     sh 'ls -R ./repository'

NOTICE.md

@@ -1,10 +1,9 @@
-# Notices for Keyple Java, Tools for Committers
+# Notices for 'Eclipse Keyple' Java implementation
 
-This content is produced and maintained by the Eclipse keyple, Tools for
-Committers project.
+This content is produced and maintained by the Eclipse Keyple project.
 
  * Project home: https://projects.eclipse.org/projects/iot.keyple
-
+ 
 ## Supported platforms
 - Java SE 1.6 compact2
 - Android 4.4 KitKat API level 19
@@ -17,6 +16,12 @@ Committers project.
 - example: source for the generic and Calypso implementation examples.
 - keyple-integration: source for the integration code (SDK).
 
+## Trademarks
+ 
+ * Eclipse Keyple and the Eclipse Keyple project are Trademarks of the Eclipse Foundation, Inc.
+ * Eclipse® is a Trademark of the Eclipse Foundation, Inc.
+ * Eclipse Foundation is a Trademark of the Eclipse Foundation, Inc.
+ 
 ## Copyright
 
 All content is the property of the respective authors or their employers.
@@ -35,18 +40,23 @@ SPDX-License-Identifier: EPL-2.0
 
 The project maintains the following source code repositories:
 
- * https://github.com/eclipse/keyple.git
- 
+* https://github.com/eclipse/keyple
+* https://github.com/eclipse/keyple-website
+* https://github.com/eclipse/keyple-java
+* https://github.com/eclipse/keyple-cpp
+* https://github.com/eclipse/keyple-ops
 
 ## Contributors
    *   Pierre Terrée - API specification
-   *   Jean-Pierre Fortune - plugin PCSC, keyple Core and Keyple Calypso
-   *   Olivier Delcroix - plugins Android, plugin Remote SE
+   *   Jean-Pierre Fortune - Keyple Core, Keyple Calypso, PCSC plugin and Stub plugin
+   *   Olivier Delcroix - Keyple Distributed and Android plugins
    *   Florent Clairambault - Keyple Core
-   *   Paulo Barreto - integration and demo
-   *   Meddy Menzikoff - Android plugins and Examples 
+   *   Paulo Barreto - Integration and Demo apps
+   *   Meddy Menzikoff - Android plugins and Examples
+   *   Andrei Cristea - Keyple Core, Keyple Distributed and Keyple Calypso
+   *   Youssef Amrani - Android plugins and demo apps
+   *   Brice Ruppen - DevOps
 
-
 ## Third-party Content
 
 Google Gson (2.2.4)