Java
Get Started with Java Development on the atPlatform.
Setting Up Your Development Environment
1. Install Java
The first step in getting your developer environment ready, is to install Java 8 or higher on your local machine.
2. Install Maven
Next step is to install maven and add it to your PATH. Maven is a great tool for managing Java projects and will be useful for development atPlatform applications.
3. Clone the Java Client
Fork our at_java
repository
Create a new directory on your local machine where you want the java client source code to live. Change directory (cd) into this directory and git clone your fork.
Git clone: git clone <your_fork_url>
so that the source code is on your local machine.
4. Build at_java/at_client
Compile at_java/at_client:
- Ensure you are in the at_client directory:
cd at_java/at_client
. - Run
mvn install
- You should see
[INFO] BUILD SUCCESS
Registration CLI
Be sure you’ve fully set up your development environment. Also ensure you’ve built and deployed the project by running
mvn install
under theat_java/at_client
directory.Our next step is to run the
Register.java
CLI to register a new atSign will be onboarded and a set of .atKeys will be generated. You can do this by running:
Linux
java -cp "target/client-1.0-SNAPSHOT.jar:target/lib/*" org.atsign.client.cli.Register <email@email.com>
Windows
java -cp "target/client-1.0-SNAPSHOT.jar;target/lib/*" org.atsign.client.cli.Register <email@email.com>
- If successful, the output should be similar:
Getting free atsign
Got atsign: @64husky26
Sending one-time-password to :<email@email.com>
Got response: Sent Successfully
Enter OTP received on: <email@email.com>
- You will get a OTP (one-time password) in your entered email. Be sure to enter the OTP as received because it is case-sensitive. If successful, output should be similar to as follows:
xxxx
Validating one-time-password
Got response: Verified
- IMPORTANT: There will be a newly generated .atKeys file for your new atSign in
~/.atsign/keys
. Congratulations, you’ve successfully registered a new atSign in the Java client. Note: The default properties inconfig.yaml
point to the production environment. Your new atSign will be registered to the root that is defined inconfig.yaml