Feature/lattice 2228 external atlas access

src/main/java/com/openlattice/authorization/PermissionsApi.java

@@ -20,9 +20,7 @@
 
 import retrofit2.http.*;
 
-import java.util.Collection;
-import java.util.List;
-import java.util.Map;
+import java.util.*;
 
 /**
  * @author Ho Chung Siu
@@ -36,8 +34,12 @@ public interface PermissionsApi {
     String CONTROLLER = "/permissions";
     String BASE       = SERVICE + CONTROLLER;
 
-    String EXPLAIN = "/explain";
-    String UPDATE = "/update";
+    String EXPLAIN       = "/explain";
+    String UPDATE        = "/update";
+
+    String ID           = "id";
+    String ID_PATH      = "/{" + ID + "}";
+
 
     /**
      * Adds, removes, or sets the ace for a particular acl key. Successful only if user is the owner of acl key.

src/main/java/com/openlattice/authorization/securable/SecurableObjectType.java

@@ -35,5 +35,7 @@ public enum SecurableObjectType {
     AppType,
     Principal,
     Role,
-    Unknown
+    Unknown,
+    OrganizationExternalDatabaseTable,
+    OrganizationExternalDatabaseColumn
 }

src/main/java/com/openlattice/client/serialization/SerializationConstants.java

@@ -65,6 +65,8 @@ public final class SerializationConstants {
     public static final String CHILD_CLAUSES                    = "childClauses";
     public static final String CHILD_QUERIES                    = "childQueries";
     public static final String CLAUSES                          = "clauses";
+    public static final String COLUMNS                          = "columns";
+    public static final String COLUMN_IDS_BY_TABLE_ID           = "columnIdsByTableId";
     public static final String COMPARISON                       = "comparison";
     public static final String CONFIG                           = "config";
     public static final String CONFLICTS                        = "conflicts";
@@ -142,6 +144,7 @@ public final class SerializationConstants {
     public static final String IS_DESCENDING                    = "isDescending";
     public static final String IS_DST                           = "isDst";
     public static final String IS_OWNER                         = "isOwner";
+    public static final String IS_PRIMARY_KEY                   = "isPrimaryKey";
     public static final String KEYWORD                          = "kw";
     public static final String KEY_FIELD                        = "key";
     public static final String LAST_INDEX                       = "lastIndex";
@@ -188,6 +191,7 @@ public final class SerializationConstants {
     public static final String PERMISSIONS_MAP                  = "permissionsMap";
     public static final String PHONE_NUMBER                     = "phoneNumber";
     public static final String PII_FIELD                        = "pii";
+    public static final String ORDINAL_POSITION                 = "ordinalPosition";
     public static final String PRESENT                          = "present";
     public static final String PRINCIPAL                        = "principal";
     public static final String PRINCIPAL_PATHS                  = "principalPaths";
@@ -232,6 +236,7 @@ public final class SerializationConstants {
     public static final String SYNC_IDS                         = "syncIds";
     public static final String SYNC_TICKETS                     = "syncTickets";
     public static final String TAGS                             = "tags";
+    public static final String TABLE_ID                         = "tableId";
     public static final String TARGET                           = "target";
     public static final String TEMPLATE                         = "template";
     public static final String TIMESTAMP                        = "timestamp";

src/main/java/com/openlattice/mapstores/TestDataFactory.java

@@ -36,6 +36,8 @@
 import com.openlattice.edm.type.EntityType;
 import com.openlattice.edm.type.PropertyType;
 import com.openlattice.organization.Organization;
+import com.openlattice.organization.OrganizationExternalDatabaseColumn;
+import com.openlattice.organization.OrganizationExternalDatabaseTable;
 import com.openlattice.organization.roles.Role;
 import com.openlattice.postgres.IndexType;
 import com.openlattice.requests.PermissionsRequestDetails;
@@ -585,4 +587,30 @@ public static EntitySetCollection entitySetCollection() {
         );
     }
 
+    public static OrganizationExternalDatabaseColumn organizationExternalDatabaseColumn() {
+        OrganizationExternalDatabaseTable table = organizationExternalDatabaseTable();
+        return new OrganizationExternalDatabaseColumn(
+                UUID.randomUUID(),
+                randomAlphanumeric( 5 ),
+                randomAlphanumeric( 5 ),
+                Optional.of(randomAlphanumeric( 5 )),
+                table.getId(),
+                UUID.randomUUID(),
+                randomAlphabetic( 5 ),
+                r.nextBoolean(),
+                r.nextInt( 1000 )
+        );
+    }
+
+
+    public static OrganizationExternalDatabaseTable organizationExternalDatabaseTable() {
+        return new OrganizationExternalDatabaseTable(
+                UUID.randomUUID(),
+                randomAlphanumeric( 5 ),
+                randomAlphanumeric( 5 ),
+                Optional.of(randomAlphanumeric( 5 )),
+                UUID.randomUUID()
+        );
+    }
+
 }

src/main/java/com/openlattice/organization/OrganizationsApi.java

@@ -19,23 +19,14 @@
 package com.openlattice.organization;
 
 import com.openlattice.directory.pojo.Auth0UserBasic;
-import com.openlattice.notifications.sms.SmsEntitySetInformation;
 import com.openlattice.organization.roles.Role;
-import java.util.EnumSet;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-import java.util.UUID;
-import retrofit2.http.Body;
-import retrofit2.http.DELETE;
-import retrofit2.http.GET;
-import retrofit2.http.HTTP;
-import retrofit2.http.POST;
-import retrofit2.http.PUT;
-import retrofit2.http.Path;
+
+import java.util.*;
+
+import retrofit2.http.*;
 
 public interface OrganizationsApi {
-    String ASSEMBLE     = "/assemble";
+    String ASSEMBLE          = "/assemble";
     String CONTROLLER        = "/organizations";
     String DESCRIPTION       = "/description";
     String EMAIL_DOMAIN      = "email-domain";
@@ -53,11 +44,12 @@ public interface OrganizationsApi {
     String PRINCIPALS        = "/principals";
     String PRINCIPAL_ID      = "pid";
     String PRINCIPAL_ID_PATH = "/{" + PRINCIPAL_ID + "}";
-    String REFRESH      = "/refresh";
-    String REFRESH_RATE = "/refresh-rate";
+    String REFRESH           = "/refresh";
+    String REFRESH_RATE      = "/refresh-rate";
     String ROLES             = "/roles";
-    String ROLE_ID      = "roleId";
-    String ROLE_ID_PATH = "/{" + ROLE_ID + "}";
+    String ROLE_ID           = "roleId";
+    String ROLE_ID_PATH      = "/{" + ROLE_ID + "}";
+
     /*
      * These determine the service routing for the LB
      */
@@ -258,4 +250,4 @@ Void removeRoleFromUser(
             @Path( ROLE_ID ) UUID roleId,
             @Path( USER_ID ) String userId );
 
-}
+}

src/main/kotlin/com/openlattice/organization/OrganizationExternalDatabaseApi.kt

@@ -0,0 +1,137 @@
+package com.openlattice.organization
+
+import retrofit2.http.*
+import java.util.*
+
+interface OrganizationExternalDatabaseApi {
+
+    companion object {
+        /* These determine the service routing */
+        const val SERVICE = "/datastore"
+        const val CONTROLLER = "/organization-database"
+        const val BASE = SERVICE + CONTROLLER
+
+        const val EXTERNAL_DATABASE = "/external-database"
+        const val EXTERNAL_DATABASE_COLUMN = "/external-database-column"
+        const val EXTERNAL_DATABASE_TABLE = "/external-database-table"
+
+        const val ID = "id"
+        const val ID_PATH = "/{$ID}"
+        const val TABLE_NAME = "tableName"
+        const val TABLE_NAME_PATH = "/{$TABLE_NAME}"
+        const val COLUMN_NAME = "columnName"
+        const val COLUMN_NAME_PATH = "/{$COLUMN_NAME}"
+        const val SQL_TYPE = "sqlType"
+        const val SQL_TYPE_PATH = "/{$SQL_TYPE}"
+        const val USER_ID = "userId"
+        const val USER_ID_PATH = "/{$USER_ID:.*}"
+    }
+
+    //create
+    /**
+     * Creates a securable OrganizationExternalDatabaseTable object, which represents an
+     * organization's table in an external database. The table must already exist in the database
+     * @param organizationId The organization's UUID
+     * @param organizationExternalDatabaseTable The object to be created
+     */
+    @POST(BASE + ID_PATH + EXTERNAL_DATABASE_TABLE)
+    fun createExternalDatabaseTable(@Path(ID) organizationId: UUID,
+                                    @Body organizationExternalDatabaseTable: OrganizationExternalDatabaseTable): UUID
+
+    /**
+     * Creates a securable OrganizationExternalDatabaseColumn object, which represents a
+     * column within an organization's table in an external database. The table and column must
+     * already exist in the database
+     * @param organizationId The organization's UUID
+     * @param organizationExternalDatabaseColumn The object to be created
+     */
+    @POST(BASE + ID_PATH + EXTERNAL_DATABASE_COLUMN)
+    fun createExternalDatabaseColumn(@Path(ID) organizationId: UUID,
+                                     @Body organizationExternalDatabaseColumn: OrganizationExternalDatabaseColumn): UUID
+
+    /**
+     *
+     * @param organizationId The organization's UUID
+     * @param userId The user to be given trusted status
+     * @param ipAddresses The set of ip addresses (as strings) from which users will be trusted
+     */
+    @POST(BASE + ID_PATH + USER_ID_PATH + EXTERNAL_DATABASE)
+    fun addTrustedUser(
+            @Path(ID) organizationId: UUID,
+            @Path(USER_ID) userId: String,
+            @Body ipAddresses: Set<String>)
+
+    //get
+    /**
+     * Gets an OrganizationExternalDatabaseTable object, which represents an
+     * organization's table in an external database
+     * @param organizationId The organization's UUID
+     * @param tableName The exact name of the table in the database
+     */
+    @GET(BASE + ID_PATH + TABLE_NAME_PATH + EXTERNAL_DATABASE_TABLE)
+    fun getExternalDatabaseTable(
+            @Path(ID) organizationId: UUID, @Path(TABLE_NAME) tableName: String): OrganizationExternalDatabaseTable
+
+    /**
+     * Gets an OrganizationExternalDatabaseColumn object, which represents a column
+     * within an organization's table in an external database
+     * @param organizationId The organization's UUID
+     * @param tableName The exact name of the table in the database
+     * @param columnName The exact name of the column in the database
+     */
+    @GET(BASE + ID_PATH + TABLE_NAME_PATH + COLUMN_NAME_PATH + EXTERNAL_DATABASE_COLUMN)
+    fun getExternalDatabaseColumn(
+            @Path(ID) organizationId: UUID, @Path(TABLE_NAME) tableName: String, @Path(COLUMN_NAME) columnName: String): OrganizationExternalDatabaseColumn
+
+
+    //delete
+    /**
+     * Deletes an OrganizationExternalDatabaseTable object, which represents an
+     * organization's table in an external database. This deletes both the object
+     * and the table in the database. It is a hard delete
+     * @param organizationId The organization's UUID
+     * @param tableName The exact name of the table in the database
+     */
+    @DELETE(BASE + ID_PATH + TABLE_NAME_PATH + EXTERNAL_DATABASE_TABLE)
+    fun deleteExternalDatabaseTable(
+            @Path(ID) organizationId: UUID,
+            @Path(TABLE_NAME) tableName: String)
+
+    /**
+     * Deletes an OrganizationExternalDatabaseColumn object, which represents a column
+     * within an organization's table in an external database. This deletes both the object
+     * and the column in the database. It is a hard delete
+     * @param organizationId The organization's UUID
+     * @param tableName The exact name of the table in the database
+     * @param columnName The exact name of the column in the database
+     */
+    @DELETE(BASE + ID_PATH + TABLE_NAME_PATH + COLUMN_NAME_PATH + EXTERNAL_DATABASE_COLUMN)
+    fun deleteExternalDatabaseColumn(
+            @Path(ID) organizationId: UUID,
+            @Path(TABLE_NAME) tableName: String,
+            @Path(COLUMN_NAME) columnName: String)
+
+    /**
+     * Deletes multiple OrganizationExternalDatabaseTable objects and the tables they represent
+     * in the database. It is a hard delete
+     * @param organizationId The organization's UUID
+     * @param tableNames The exact names of the tables in the database
+     */
+    @DELETE(BASE + ID_PATH + EXTERNAL_DATABASE_TABLE)
+    fun deleteExternalDatabaseTables(
+            @Path(ID) organizationId: UUID,
+            @Body tableNames: Set<String>)
+
+    /**
+     * Deletes multiple OrganizationExternalDatabaseColumn objects and the columns they represent
+     * within an organization's table in an external database. It is a hard delete
+     * @param organizationId The organization's UUID
+     * @param tableName The exact name of the table in the database
+     * @param columnNames The exact names of the columns in the database
+     */
+    @DELETE(BASE + ID_PATH + TABLE_NAME_PATH + EXTERNAL_DATABASE_COLUMN)
+    fun deleteExternalDatabaseColumns(
+            @Path(ID) organizationId: UUID,
+            @Path(TABLE_NAME) tableName: String,
+            @Body columnNames: Set<String>)
+}

src/main/kotlin/com/openlattice/organization/OrganizationExternalDatabaseColumn.kt

@@ -0,0 +1,54 @@
+package com.openlattice.organization
+
+import com.fasterxml.jackson.annotation.JsonCreator
+import com.fasterxml.jackson.annotation.JsonIgnore
+import com.fasterxml.jackson.annotation.JsonProperty
+import com.openlattice.authorization.securable.AbstractSecurableObject
+import com.openlattice.authorization.securable.SecurableObjectType
+import com.openlattice.client.serialization.SerializationConstants
+import org.apache.olingo.commons.api.edm.FullQualifiedName
+import java.util.*
+
+class OrganizationExternalDatabaseColumn
+
+/**
+ * Creates a securable object for an organization's entire database in Atlas
+ *
+ * @param id An optional UUID that will be automatically generated if not provided
+ * @param name The name of the column
+ * @param title A title for the object
+ * @param description A description for the object
+ * @param tableId The id of the table that contains this column
+ * @param organizationId The id of the organization that owns this column
+ */
+
+@JsonCreator
+constructor(
+        @JsonProperty(SerializationConstants.ID_FIELD) id: Optional<UUID>,
+        @JsonProperty(SerializationConstants.NAME_FIELD) var name: String,
+        @JsonProperty(SerializationConstants.TITLE_FIELD) title: String,
+        @JsonProperty(SerializationConstants.DESCRIPTION_FIELD) description: Optional<String>,
+        @JsonProperty(SerializationConstants.TABLE_ID) var tableId: UUID,
+        @JsonProperty(SerializationConstants.ORGANIZATION_ID) var organizationId: UUID,
+        @JsonProperty(SerializationConstants.DATATYPE_FIELD) var dataType: String,
+        @JsonProperty(SerializationConstants.IS_PRIMARY_KEY) var isPrimaryKey: Boolean,
+        @JsonProperty(SerializationConstants.ORDINAL_POSITION) var ordinalPosition: Int
+) : AbstractSecurableObject(id, title, description) {
+
+    constructor(
+            id: UUID,
+            name: String,
+            title: String,
+            description: Optional<String>,
+            tableId: UUID,
+            organizationId: UUID,
+            dataType: String,
+            isPrimaryKey: Boolean,
+            ordinalPosition: Int
+    ) : this(Optional.of(id), name, title, description, tableId, organizationId, dataType, isPrimaryKey, ordinalPosition)
+
+    @JsonIgnore
+    override fun getCategory(): SecurableObjectType {
+        return SecurableObjectType.OrganizationExternalDatabaseColumn
+    }
+}