Merge pull request #121 from JeremyTubongbanua/changes-5

content_dev/docs/sdk/java/_index.md

@@ -1,15 +1,12 @@
 ---
-layout: list
+layout: codelab-list
 
-title: "Java Reference" # The title (ON THE PAGE)
-lead: | # The lead below the title (ON THE PAGE)
-  Build a Java application using the atPlatform.
+title: Java # Title of the codelab
+lead: Learn how the Java SDK works
+description: Learn how to use the atPlatform Java SDK
 
-description: | # SEO Description of the page (Shows in google and atsign.dev search)
-    Add end-to-end encryption and data privacy to your Java applications and IoT devices running Java
-
-draft: false # Change this to "true" to hide the page
-toc: true # Change this to "false" to hide the table of contents
-autolinks: true # Change this to "false" to hide the automatic links below your content
-weight: 2 # For list pages, higher is first.
+doneLink: /sdk/java/ # Where to send them if they press "Done" at the end of the Codelab
+exitLink: /sdk/ # Where to send them to if they press "Exit Codelab"
+weight: 2
+order: 1
 ---

content_dev/docs/sdk/java/getting-started/clis.md → content_dev/docs/sdk/java/clis.md

@@ -6,7 +6,7 @@ description: | # SEO Description for this step
   Keys in Java are different from the Dart SDK AtKeys
 
 draft: false # TODO CHANGE THIS TO FALSE WHEN YOU ARE READY TO PUBLISH THE PAGE
-order: 8 # Ordering of the steps
+order: 10 # Ordering of the steps
 ---
 
 There are various CLIs (command-line interfaces) that uses the Java SDK to interact with a secondary server. 
@@ -37,4 +37,3 @@ If you want to interact with the atProtocol through a command-line experience, s
 | Delete   | delete something that was previously shared | rootUrl, other atSign, name of shared key including namespace |
 | Scan     | for seeing what keys exist in the secondary and view metadata | rootUrl, atSign, verbose true or false, scan regex |
 | REPL     | use raw atProtocol, handles PKAM auth | rootUrl, atSign, seeEncryptedNotifications true or false |
-

content_dev/docs/sdk/java/getting-started/getting-secondary.md → content_dev/docs/sdk/java/getting-secondary.md

@@ -6,7 +6,7 @@ description: | # SEO Description for this step
   There are a number to get the address of a secondary server belonging to an atSign.
 
 draft: false # TODO CHANGE THIS TO FALSE WHEN YOU ARE READY TO PUBLISH THE PAGE
-order: 2 # Ordering of the steps
+order: 4 # Ordering of the steps
 ---
 
 There are a number to get the address of a secondary server belonging to an atSign.

content_dev/docs/sdk/java/installation.md

@@ -0,0 +1,46 @@
+---
+layout: codelab
+
+title: Installation # Title of the codelab
+lead: Getting your development environment ready
+description: Learn about the core Atsign platform Flutter SDK services
+
+doneLink: /sdk/java/ # Where to send them if they press "Done" at the end of the Codelab
+exitLink: /sdk/java/ # Where to send them to if they press "Exit Codelab"
+order: 2
+---
+
+## Requirements
+
+There are two requirements for developing with `at_java` on your machine.
+
+1. [Java 8](https://www.java.com/en/download/) or higher
+2. [Maven](https://maven.apache.org/download.cgi)
+3. A code editor, see [getting started with Java](/start/java/)
+
+
+## Compile JAR
+
+If you'd like to use at_java as a dependency, you can compile `at_java` into a JAR by following the instructions below:
+1. `cd at_client` to be in the at_client directory.
+2. `mvn install`
+3. JAR file created in `target/` named similarly to `client-1.0-SNAPSHOT.jar`
+4. If you run into dependency issues, you may need to add the dependencies used by the `at_java`. Look in `at_client/pom.xml` and copy everything within the `<dependencies></dependencies>` tags and paste that in your `pom.xml` that you have in your Java project.
+
+## Maven Dependency
+
+Under construction
+
+## Cloning the Client
+
+If you'd like to make contributions or edit the client yourself, make a form of the repository by heading to the [repository](https://github.com/atsign-foundation/at_java) and clicking "[Fork](https://github.com/atsign-foundation/at_java/fork)" to fork the repository on your own GitHub account.
+
+Once forked, you can make changes to your own fork version of the repository.
+
+Get it on your local machine by doing the following (`.` is the directory you want to clone the repository in; in this case, we are cloning it in our current directory so be sure to `cd` into the directory you want the repository in):
+
+```git
+git clone https://github.com/<YOUR_GITHUB_USERNAME>/at_java.git .
+```
+
+

content_dev/docs/sdk/java/getting-started/instance/index.md → content_dev/docs/sdk/java/instance/index.md

@@ -6,7 +6,7 @@ description: | # SEO Description for this step
   Create an instance of AtClient with one of the various factory methods
 
 draft: false # TODO CHANGE THIS TO FALSE WHEN YOU ARE READY TO PUBLISH THE PAGE
-order: 1 # Ordering of the steps
+order: 3 # Ordering of the steps
 ---
 
 To create an instance of AtClient, use one of the factory methods. Note: you must have the `.atKeys` file in the `~/.atsign/keys` directory. You can generate a .atKeys file from using the Register CLI or Onboaring CLI if you already own the atSign.

content_dev/docs/sdk/java/introduction.md

@@ -0,0 +1,42 @@
+---
+layout: codelab
+
+title: Introduction # Title of the codelab
+lead: Learn some background information before diving into Java specifics.
+description: Learn about the core Atsign platform Java SDK services
+
+doneLink: /sdk/java/ # Where to send them if they press "Done" at the end of the Codelab
+exitLink: /sdk/java/ # Where to send them to if they press "Exit Codelab"
+order: 1
+---
+
+## atProtocol
+
+### Overview
+The atProtocol is the underlying network protocol used by the atPlatform. The atPlatform provides people, entities, and things with unique identifiers called atSigns.
+
+Each atSign creates its own public and private cryptographic key pair. The private keys are kept private and public keys made available globally through the atProtocol.
+
+The atProtocol provides verbs for interacting with fully qualified atSigns and the data in their secondary servers.
+
+#### Root Secondary
+When asking a Root Server for the lookup of a particular atSign the Root Server should respond with a null if the name does not exist and if the name exists the DNS name or address of the @server and the IP port number for that @sign should be returned. The Root Server is the only centralized feature controlled by Atsign.
+
+#### Secondary Servers
+Secondary servers are servers that belong to an atSign and hold data. All of the data in the secondary server is encrypted unless the owner specifically wants to make some data publicly available.
+
+## What is at_java?
+
+at_java is Atsign’s implementation of the atProtocol. Just like Atsign’s dart libraries, at_java allows you to interact with Atsign’s services like registering atSigns, onboarding, communicating with the root & secondary servers, and more.
+
+### Where can at_java be used?
+
+As long as the device running at_java has
+1. Internet
+2. Java 8 or higher
+
+Then at_java can be used to add simplicity and security to your Java applications and/or IoT devices running Java.
+
+at_java is perfect for those who want to interact with low-level atProtocol for whatever the use case is. Whether it be IoT devices sending end-to-end-encrypted data, sharing medical data between patients, or storing data in your Java apps that you can feel safe about owning; the possibilities are endless with the power of the atProtocol.
+
+As of writing this (July 20, 2022), at_java only has remote secondary implementation meaning that the device running this service must be connected to the internet.

content_dev/docs/sdk/java/getting-started/keys.md → content_dev/docs/sdk/java/keys.md

@@ -6,7 +6,7 @@ description: | # SEO Description for this step
   Learn about how Keys work in the Java SDK
 
 draft: false # TODO CHANGE THIS TO FALSE WHEN YOU ARE READY TO PUBLISH THE PAGE
-order: 3 # Ordering of the steps
+order: 5 # Ordering of the steps
 ---
 
 ### Overview

content_dev/docs/sdk/java/getting-started/privatehiddenkey.md → content_dev/docs/sdk/java/private-hidden-key.md

@@ -6,11 +6,17 @@ description: | # SEO Description for this step
   Learn how to put, get, and delete a PrivateHiddenKey in the Java SDK
 
 draft: false # TODO CHANGE THIS TO FALSE WHEN YOU ARE READY TO PUBLISH THE PAGE
-order: 7 # Ordering of the steps
+order: 9 # Ordering of the steps
 ---
 
 ### Putting a PrivateHiddenKey Example
 
+Not implemented yet
+
 ### Getting a PrivateHiddenKey Example
 
-### Deleting a PrivateHiddenKey Example
+Not implemented yet
+
+### Deleting a PrivateHiddenKey Example
+
+Not implemented yet

content_dev/docs/sdk/java/getting-started/publickey.md → content_dev/docs/sdk/java/public-key.md

@@ -6,7 +6,7 @@ description: | # SEO Description for this step
   Learn how to put, get, and delete a PublicKey in the Java SDK
 
 draft: false # TODO CHANGE THIS TO FALSE WHEN YOU ARE READY TO PUBLISH THE PAGE
-order: 4 # Ordering of the steps
+order: 6 # Ordering of the steps
 ---
 
 PublicKeys are meant for public data. Authorized or unauthorized users are able to know of the existence of these keys (via scan) and the data is not encrypted.

content_dev/docs/sdk/java/getting-started/selfkey.md → content_dev/docs/sdk/java/self-key.md

@@ -6,7 +6,7 @@ description: | # SEO Description for this step
   Learn how to put, get, and delete a SelfKey in the Java SDK
 
 draft: false # TODO CHANGE THIS TO FALSE WHEN YOU ARE READY TO PUBLISH THE PAGE
-order: 6 # Ordering of the steps
+order: 7 # Ordering of the steps
 ---
 
 SelfKeys hold data that are intended for the atSign owner of the secondary server. Data is encrypted with the symmetric selfEncryptionKey. 

content_dev/docs/sdk/java/getting-started/sharedkey.md → content_dev/docs/sdk/java/shared-key.md

@@ -6,7 +6,7 @@ description: | # SEO Description for this step
   Learn how to put, get-self, get-other, and delete a SharedKey in the Java SDK
 
 draft: false # TODO CHANGE THIS TO FALSE WHEN YOU ARE READY TO PUBLISH THE PAGE
-order: 5 # Ordering of the steps
+order: 7 # Ordering of the steps
 ---
 
 SharedKeys are for data you want to share with another atSign. The sharedBy atSign should be you. The sharedWith atSign should be the receiver. 
@@ -158,4 +158,4 @@ try {
     e.printStackTrace();
 }
 System.out.println(response);
-```
+```