Core: IRC: Implement Events Endpoint Request & Response Objects

api/src/main/java/org/apache/iceberg/catalog/CatalogObjectIdentifier.java

@@ -0,0 +1,111 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.iceberg.catalog;
+
+import java.util.Arrays;
+import java.util.function.Predicate;
+import java.util.regex.Pattern;
+import org.apache.iceberg.relocated.com.google.common.base.Joiner;
+import org.apache.iceberg.relocated.com.google.common.base.Preconditions;
+
+/**
+ * Reference to a named object in a {@link Catalog}, such as {@link Namespace}, {@link
+ * org.apache.iceberg.Table}, or {@link org.apache.iceberg.view.View}.
+ */
+public class CatalogObjectIdentifier {
+  private static final CatalogObjectIdentifier EMPTY_CATALOG_OBJECT =
+      new CatalogObjectIdentifier(new String[] {});
+  private static final Joiner DOT = Joiner.on(".");
+  private static final Predicate<String> CONTAINS_NULL_CHARACTER =
+      Pattern.compile("\u0000", Pattern.UNICODE_CHARACTER_CLASS).asPredicate();
+
+  public static CatalogObjectIdentifier empty() {
+    return EMPTY_CATALOG_OBJECT;
+  }
+
+  public static CatalogObjectIdentifier of(String... levels) {
+    Preconditions.checkArgument(
+        null != levels, "Cannot create CatalogObjectIdentifier from null array");
+    if (levels.length == 0) {
+      return empty();
+    }
+
+    for (String level : levels) {
+      Preconditions.checkNotNull(
+          level, "Cannot create a CatalogObjectIdentifier with a null level");
+      Preconditions.checkArgument(
+          !CONTAINS_NULL_CHARACTER.test(level),
+          "Cannot create a CatalogObjectIdentifier with the null-byte character");
+    }
+
+    return new CatalogObjectIdentifier(levels);
+  }
+
+  public static CatalogObjectIdentifier of(String name) {
+    Preconditions.checkNotNull(name, "Cannot create CatalogObjectIdentifier from null name");
+
+    return of(name.split("\\."));
+  }
+
+  private final String[] levels;
+
+  private CatalogObjectIdentifier(String[] levels) {
+    this.levels = levels;
+  }
+
+  public String[] levels() {
+    return levels;
+  }
+
+  public String level(int pos) {
+    return levels[pos];
+  }
+
+  public boolean isEmpty() {
+    return levels.length == 0;
+  }
+
+  public int length() {
+    return levels.length;
+  }
+
+  @Override
+  public boolean equals(Object other) {
+    if (this == other) {
+      return true;
+    }
+
+    if (other == null || getClass() != other.getClass()) {
+      return false;
+    }
+
+    CatalogObjectIdentifier catalogObjectIdentifier = (CatalogObjectIdentifier) other;
+    return Arrays.equals(levels, catalogObjectIdentifier.levels);
+  }
+
+  @Override
+  public int hashCode() {
+    return Arrays.hashCode(levels);
+  }
+
+  @Override
+  public String toString() {
+    return DOT.join(levels);
+  }
+}

api/src/main/java/org/apache/iceberg/catalog/CatalogObjectType.java

@@ -0,0 +1,55 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.iceberg.catalog;
+
+import java.util.Arrays;
+import org.apache.iceberg.relocated.com.google.common.base.Preconditions;
+
+/**
+ * Enum representing a CatalogObject i.e., {@link Namespace}, {@link org.apache.iceberg.Table}, or
+ * {@link org.apache.iceberg.view.View}.
+ */
+public enum CatalogObjectType {
+  NAMESPACE("namespace"),
+  TABLE("table"),
+  VIEW("view");
+
+  private final String type;
+
+  CatalogObjectType(String type) {
+    this.type = type;
+  }
+
+  public String type() {
+    return type;
+  }
+
+  public static CatalogObjectType fromType(String type) {
+    Preconditions.checkNotNull(type, "Invalid CatalogObjectType: null");
+    return Arrays.stream(CatalogObjectType.values())
+        .filter(catalogObjectType -> catalogObjectType.type.equalsIgnoreCase(type))
+        .findFirst()
+        .orElseThrow(() -> new IllegalArgumentException("Invalid CatalogObjectType: " + type));
+  }
+
+  @Override
+  public String toString() {
+    return type;
+  }
+}

api/src/main/java/org/apache/iceberg/catalog/CatalogObjectUuid.java

@@ -0,0 +1,81 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.iceberg.catalog;
+
+import java.util.Objects;
+import org.apache.iceberg.relocated.com.google.common.base.MoreObjects;
+import org.apache.iceberg.relocated.com.google.common.base.Preconditions;
+
+/**
+ * Identifies a {@link org.apache.iceberg.Table} or {@link org.apache.iceberg.view.View} by UUID.
+ */
+public class CatalogObjectUuid {
+  private final String uuid;
+
+  /** one of ["table", "view"]. Assign using {@link CatalogObjectType#type()} */
+  private final String type;
+
+  public CatalogObjectUuid(String uuid, String type) {
+    Preconditions.checkNotNull(uuid, "Invalid UUID: null");
+
+    if (uuid.isEmpty()) {
+      throw new IllegalArgumentException("Invalid UUID: empty");
+    }
+
+    if (!type.equals(CatalogObjectType.TABLE.type())
+        && !type.equals(CatalogObjectType.VIEW.type())) {
+      throw new IllegalArgumentException("Invalid type: " + type);
+    }
+
+    this.uuid = uuid;
+    this.type = type;
+  }
+
+  public String uuid() {
+    return uuid;
+  }
+
+  public String type() {
+    return type;
+  }
+
+  @Override
+  public String toString() {
+    return MoreObjects.toStringHelper(this).add("uuid", uuid).add("type", type).toString();
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) {
+      return true;
+    }
+
+    if (o == null || getClass() != o.getClass()) {
+      return false;
+    }
+
+    CatalogObjectUuid that = (CatalogObjectUuid) o;
+    return uuid.equals(that.uuid) && type.equals(that.type);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(uuid, type);
+  }
+}

api/src/test/java/org/apache/iceberg/catalog/TestCatalogObjectIdentifier.java

@@ -0,0 +1,66 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.iceberg.catalog;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
+
+import org.junit.jupiter.api.Test;
+
+public class TestCatalogObjectIdentifier {
+
+  @Test
+  public void testWithNullAndEmpty() {
+    assertThatThrownBy(() -> CatalogObjectIdentifier.of((String[]) null))
+        .isInstanceOf(IllegalArgumentException.class)
+        .hasMessage("Cannot create CatalogObjectIdentifier from null array");
+
+    assertThat(CatalogObjectIdentifier.of()).isEqualTo(CatalogObjectIdentifier.empty());
+  }
+
+  @Test
+  public void testCatalogObjectIdentifier() {
+    String[] levels = {"a", "b", "c", "d"};
+    CatalogObjectIdentifier catalogObjectIdentifier = CatalogObjectIdentifier.of(levels);
+    assertThat(catalogObjectIdentifier).isNotNull();
+    assertThat(catalogObjectIdentifier.levels()).hasSize(4);
+    assertThat(catalogObjectIdentifier).hasToString("a.b.c.d");
+    for (int i = 0; i < levels.length; i++) {
+      assertThat(catalogObjectIdentifier.level(i)).isEqualTo(levels[i]);
+    }
+  }
+
+  @Test
+  public void testWithNullInLevel() {
+    assertThatThrownBy(() -> CatalogObjectIdentifier.of("a", null, "b"))
+        .isInstanceOf(NullPointerException.class)
+        .hasMessage("Cannot create a CatalogObjectIdentifier with a null level");
+  }
+
+  @Test
+  public void testDisallowsCatalogObjectIdentifierWithNullByte() {
+    assertThatThrownBy(() -> CatalogObjectIdentifier.of("ac", "\u0000c", "b"))
+        .isInstanceOf(IllegalArgumentException.class)
+        .hasMessage("Cannot create a CatalogObjectIdentifier with the null-byte character");
+
+    assertThatThrownBy(() -> CatalogObjectIdentifier.of("ac", "c\0", "b"))
+        .isInstanceOf(IllegalArgumentException.class)
+        .hasMessage("Cannot create a CatalogObjectIdentifier with the null-byte character");
+  }
+}

api/src/test/java/org/apache/iceberg/catalog/TestCatalogObjectType.java

@@ -0,0 +1,45 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.iceberg.catalog;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
+
+import org.junit.jupiter.api.Test;
+
+public class TestCatalogObjectType {
+
+  @Test
+  void testFromType() {
+    assertThat(CatalogObjectType.fromType("namespace")).isEqualTo(CatalogObjectType.NAMESPACE);
+
+    assertThatThrownBy(() -> CatalogObjectType.fromType(null))
+        .isInstanceOf(NullPointerException.class)
+        .hasMessage("Invalid CatalogObjectType: null");
+
+    assertThatThrownBy(() -> CatalogObjectType.fromType("invalid_type"))
+        .isInstanceOf(IllegalArgumentException.class)
+        .hasMessage("Invalid CatalogObjectType: invalid_type");
+  }
+
+  @Test
+  void testToString() {
+    assertThat(CatalogObjectType.TABLE.toString()).isEqualTo("table");
+  }
+}