← Exit Codelab
⏱ 6 mins remaining

Java

Learn how the Java SDK works

Steps in this module

  1. Introduction
  2. Installation
  3. Creating an instance of AtClient
  4. Getting Secondary.Address
  5. Key Types
  6. PublicKey interactions
  7. SelfKey interactions
  8. SharedKey interactions
  9. CLIs

SharedKey interactions

SharedKeys are for data you want to share with another atSign. The sharedBy atSign should be you. The sharedWith atSign should be the receiver.

Putting SharedKey Example

Learn how to create a SharedKey in your secondary. The sharedBy atSign should be you, the authenticated creator of the key, while the sharedWith atSign should be the recipient of the key.

// 1. establish constants
String ROOT_URL = "root.atsign.org:64";
String ATSIGN_STR_SHARED_BY = "@bob"; // my atSign (sharedBy)
String ATSIGN_STR_SHARED_WITH = "@alice"; // other atSign (sharedWith)
boolean VERBOSE = true;
String KEY_NAME = "test";
int ttl = 30 * 60 * 1000; // 30 minutes
String VALUE = "I like pizza";
// 2. create AtSign objects
AtSign sharedBy = new AtSign(ATSIGN_STR_SHARED_BY);
AtSign sharedWith = new AtSign(ATSIGN_STR_SHARED_WITH);
// 3. atClient factory method
AtClient atClient = null;
try {
    atClient = AtClient.withRemoteSecondary(ROOT_URL, sharedBy, VERBOSE);
} catch (AtException e)  {
    System.err.println("Failed to create AtClient instance " + e);
    e.printStackTrace();
}
// 4. create SharedKey instance
SharedKey sk = new KeyBuilders.SharedKeyBuilder(sharedBy, sharedWith).key(KEY_NAME).build();
sk.metadata.ttl = ttl;
// 5. put the key
String response = null;
try {
    response = atClient.put(sk, VALUE).get();
} catch (InterruptedException | ExecutionException e) {
    System.err.println("Failed to put key " + e);
    e.printStackTrace();
}
System.out.println(response);

Getting a SharedKey Other Example

Learn how to get a SharedKey that was sent by another atSign being sent to you. The sharedBy atSign should be the other atSign (the atSign that is sending the data to YOU), while the sharedWith atSign should be YOU.

// 1. establish constants
String ROOT_URL = "root.atsign.org:64";
String ATSIGN_STR_SHARED_BY = "@bob"; // their atSign (key is sharedBy this atSign)
String ATSIGN_STR_SHARED_WITH = "@alice"; // your atSign (key is sharedWith you)
boolean VERBOSE = true;
String KEY_NAME = "test";

// 2. create AtSign objects
AtSign sharedBy = new AtSign(ATSIGN_STR_SHARED_BY);
AtSign sharedWith = new AtSign(ATSIGN_STR_SHARED_WITH); // your atSign

// 3. atClient factory method
AtClient atClient = null;
try {
    atClient = AtClient.withRemoteSecondary(ROOT_URL, sharedWith, VERBOSE); // AtClient instance created with your atSign 
(sharedWith)
} catch (AtException e) {
    System.err.println("Failed to create AtClient instance " + e);
    e.printStackTrace();
}

// 4. create SharedKey instance
// key is sharedBy the other person and sharedWith you.
SharedKey sk = new KeyBuilders.SharedKeyBuilder(sharedBy, sharedWith).key(KEY_NAME).build();

// 5. get the key
String response = null;
try {
    response = atClient.get(sk).get();
} catch (InterruptedException | ExecutionException e) {
    System.err.println("Failed to get key " + e);
    e.printStackTrace();
}
System.out.println(response);

Getting a SharedKey Self Example

Learn how to get a SharedKey that is shared by you and is sent to another atSign. The sharedBy atSign should be YOU, the person sending the data, while the sharedWith atSign should be the other atSign, the atSign you are sharing the data with.

// 1. establish constants
String ROOT_URL = "root.atsign.org:64";
String ATSIGN_STR_SHARED_BY = "@bob"; // my atSign (sharedBy)
String ATSIGN_STR_SHARED_WITH = "@alice"; // other atSign (sharedWith)
boolean VERBOSE = true;
String KEY_NAME = "test";

// 2. create AtSign objects
AtSign sharedBy = new AtSign(ATSIGN_STR_SHARED_BY);
AtSign sharedWith = new AtSign(ATSIGN_STR_SHARED_WITH);

// 3. atClient factory method
AtClient atClient = null;
try {
    atClient = AtClient.withRemoteSecondary(ROOT_URL, sharedBy, VERBOSE);
} catch (AtException e) {
    System.err.println("Failed to create AtClient instance " + e);
    e.printStackTrace();
}

// 4. create SharedKey instance
SharedKey sk = new KeyBuilders.SharedKeyBuilder(sharedBy, sharedWith).key(KEY_NAME).build();

// 5. get the key
String response = null;
try {
    response = atClient.get(sk).get();
} catch (InterruptedException | ExecutionException e) {
    System.err.println("Failed to get key " + e);
    e.printStackTrace();
}
System.out.println(response);

Deleting a SharedKey Example

Learn how to delete a SharedKey from your secondary server. You can only delete SharedKeys that are sharedBy and created by you. If it is a SharedKey created by another atSign, you cannot delete it because it lives on their secondary server.

// 1. establish constants
String ROOT_URL = "root.atsign.org:64";
String ATSIGN_STR_SHARED_BY = "@bob"; // my atSign (sharedBy)
String ATSIGN_STR_SHARED_WITH = "@alice"; // other atSign (sharedWith)
boolean VERBOSE = true;
String KEY_NAME = "test";

// 2. create AtSign objects
AtSign sharedBy = new AtSign(ATSIGN_STR_SHARED_BY);
AtSign sharedWith = new AtSign(ATSIGN_STR_SHARED_WITH);

// 3. atClient factory method
AtClient atClient = null;
try {
    atClient = AtClient.withRemoteSecondary(ROOT_URL, sharedBy, VERBOSE);
} catch (AtException e) {
    System.err.println("Failed to create AtClient instance " + e);
    e.printStackTrace();
}

// 4. create SharedKey instance
SharedKey sk = new KeyBuilders.SharedKeyBuilder(sharedBy, sharedWith).key(KEY_NAME).build();

// 5. delete the key
String response = null;
try {
    response = atClient.delete(sk).get();
} catch (InterruptedException | ExecutionException e) {
    System.err.println(e);
    e.printStackTrace();
}
System.out.println(response);
Back
Next