Skip to content

Review #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
/.gradle/
/bin/
.project
Binary file added DynamoDB-Link-User-Guide.docx
Binary file not shown.
Binary file added DynamoDB-Link-User-Guide.pdf
Binary file not shown.
67 changes: 7 additions & 60 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,72 +1,20 @@
# dslink-java-v2-example
# DSLINK_JAVA_V2_DYNAMODB

* Java - version 1.8 and up.
* [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0)


## Overview

This is a simple link that can be copied and used as boilerplate for a new Java DSLink.
Link to connect to DynamoDB databases built in Java SDK v2. After installing and staring the link, connect to a existing database through "Connect" action on the root node. Once connected, new databases will show up as children nodes of the root node. Use the "Query/Scan/Put/BatchPut/Update/Delete" action to run NoSQL Queries on the database.

If you are not familiar with DSA and links, an overview can be found at
[here](http://iot-dsa.org/get-started/how-dsa-works).

This link was built using the DSLink Java SDK which can be found
[here](https://github.com/iot-dsa-v2/sdk-dslink-java-v2).


## Creating a New Link

When creating a new link from this source material, you should do the following:

1. Edit the code
- Change the package and directories to match your organization.
2. Modify build.gradle
- group - Your organization's identifier.
- You will probably need to change your dependencies.
3. Modify LICENSE
- At the very least, change the copyright holder.
4. Modify dslink.json
- Change name, version, and description.
- For DSA v1, set dsa-version to "1.0". Use "2.0" for DSA v2.
- Change main, this is the path to the shell script used to launch the link. It is
created by the distZip task.
- Change the value of the config named "main-node". This must be the fully qualified
class name of your main node.
5. Edit this README
- Please maintain a helpful readme.
- Change the title.
- Maintain the current version number.
- Change the license if necessary.
- Provide an overview of the link's purpose. Keep the text linking to the DSA overview
and core SDK for context.
- Remove this section (Creating a New Link).
- Update the Link Architecture to match your node hierarchy.
- Update the Node Guide accordingly.
- Acknowledge any 3rd party libraries you use.
- Maintain a version history.

## Link Architecture

This section outlines the hierarchy of nodes defined by this link.
To understand link usage, view the [DynamoDB Link User Guide](https://github.com/iot-dsa-v2/dslink-java-v2-dynamodb/blob/master/DynamoDB-Link-User-Guide.docx).

- _MainNode_ - The root node of the link.
- _ExampleChild_ - There is no child, this is just a documentation example.


## MainNode

This is the root node of the link. It has a counter that is updated on a short interval,
only when the node is subscribed. It also has a simple action to reset the counter.

_Actions_
- Reset - Resets the counter to 0.

_Values_
- Counter - Automatically updates whenever the node is subscribed.
If you are not familiar with DSA, an overview can be found at
[here](http://iot-dsa.org/get-started/how-dsa-works).

_Child Nodes_
- There are no child nodes.
This link was built using the Java DSLink SDK which can be found
[here](https://github.com/iot-dsa-v2/sdk-dslink-java).


## Acknowledgements
Expand All @@ -77,4 +25,3 @@ This software contains unmodified binary redistributions of
[sdk-dslink-java-v2](https://github.com/iot-dsa-v2/sdk-dslink-java-v2), which is licensed
and available under the Apache License 2.0. An original copy of the license agreement can be found
at https://github.com/iot-dsa-v2/sdk-dslink-java-v2/blob/master/LICENSE