This is an automated email from the ASF dual-hosted git repository.
luchunliang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/inlong.git
The following commit(s) were added to refs/heads/master by this push:
new 1b63af3e1f [INLONG-9671][Manager] Adding JDBC URL checks to the
updateAuditSource method (#9673)
1b63af3e1f is described below
commit 1b63af3e1f208602f60b5ce19af7413443c3027c
Author: Hao <[email protected]>
AuthorDate: Tue Feb 6 18:42:46 2024 +0800
[INLONG-9671][Manager] Adding JDBC URL checks to the updateAuditSource
method (#9673)
* [INLONG-9671][Manager] Adding JDBC URL checks to the updateAuditSource
method
* foramt code
* Implementing AuditSourceOperator functionality
* add AuditSourceType class
* add comment
* Optimizing Elasticsearch Operator
---
.../manager/common/consts/AuditSourceType.java | 25 +++++++++++
.../inlong/manager/common/enums/ErrorCodeEnum.java | 4 ++
.../service/audit/AbstractAuditSourceOperator.java | 29 +++++++++++++
.../audit/AuditSourceClickhouseOperator.java | 48 +++++++++++++++++++++
.../audit/AuditSourceElasticsearchOperator.java | 50 ++++++++++++++++++++++
.../service/audit/AuditSourceMysqlOperator.java | 49 +++++++++++++++++++++
.../service/audit/InlongAuditSourceOperator.java | 44 +++++++++++++++++++
.../audit/InlongAuditSourceOperatorFactory.java | 47 ++++++++++++++++++++
.../service/core/impl/AuditServiceImpl.java | 7 +++
9 files changed, 303 insertions(+)
diff --git
a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/consts/AuditSourceType.java
b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/consts/AuditSourceType.java
new file mode 100644
index 0000000000..48ed33be28
--- /dev/null
+++
b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/consts/AuditSourceType.java
@@ -0,0 +1,25 @@
+/*
+ * 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.inlong.manager.common.consts;
+
+/**
+ * Audit Source Type
+ */
+public enum AuditSourceType {
+ MYSQL, CLICKHOUSE, ELASTICSEARCH
+}
diff --git
a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/enums/ErrorCodeEnum.java
b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/enums/ErrorCodeEnum.java
index 9d20be566d..e797335e45 100644
---
a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/enums/ErrorCodeEnum.java
+++
b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/enums/ErrorCodeEnum.java
@@ -151,6 +151,10 @@ public enum ErrorCodeEnum {
AUDIT_ID_TYPE_NOT_SUPPORTED(4001, "Audit id type '%s' not supported"),
+ AUDIT_SOURCE_TYPE_NOT_SUPPORTED(4002, "Audit Source type '%s' not
supported"),
+
+ AUDIT_SOURCE_URL_NOT_SUPPORTED(4003, "Audit Source URL '%s' not
supported"),
+
TENANT_NOT_EXIST(5001, "Tenant '%s' is not exist"),
;
diff --git
a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/audit/AbstractAuditSourceOperator.java
b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/audit/AbstractAuditSourceOperator.java
new file mode 100644
index 0000000000..13b958ae99
--- /dev/null
+++
b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/audit/AbstractAuditSourceOperator.java
@@ -0,0 +1,29 @@
+/*
+ * 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.inlong.manager.service.audit;
+
+/**
+ * Default of Audit Source Operator.
+ */
+public abstract class AbstractAuditSourceOperator implements
InlongAuditSourceOperator {
+
+ @Override
+ public Boolean accept(String type) {
+ return getType().equals(type.toUpperCase());
+ }
+}
diff --git
a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/audit/AuditSourceClickhouseOperator.java
b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/audit/AuditSourceClickhouseOperator.java
new file mode 100644
index 0000000000..a015f16954
--- /dev/null
+++
b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/audit/AuditSourceClickhouseOperator.java
@@ -0,0 +1,48 @@
+/*
+ * 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.inlong.manager.service.audit;
+
+import org.apache.inlong.manager.common.consts.AuditSourceType;
+import org.apache.inlong.manager.common.enums.ErrorCodeEnum;
+import org.apache.inlong.manager.common.exceptions.BusinessException;
+
+import org.apache.commons.lang3.StringUtils;
+import org.springframework.stereotype.Service;
+
+/**
+ * Audit source clickhouse operator.
+ */
+@Service
+public class AuditSourceClickhouseOperator extends AbstractAuditSourceOperator
{
+
+ private static final String CLICKHOUSE_URL_PREFIX = "jdbc:clickhouse://";
+
+ @Override
+ public String getType() {
+ return AuditSourceType.CLICKHOUSE.name();
+ }
+
+ @Override
+ public String convertTo(String url) {
+ if (StringUtils.isNotBlank(url) &&
url.startsWith(CLICKHOUSE_URL_PREFIX)) {
+ return url;
+ }
+
+ throw new
BusinessException(String.format(ErrorCodeEnum.AUDIT_SOURCE_URL_NOT_SUPPORTED.getMessage(),
url));
+ }
+}
diff --git
a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/audit/AuditSourceElasticsearchOperator.java
b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/audit/AuditSourceElasticsearchOperator.java
new file mode 100644
index 0000000000..1c2bba0a67
--- /dev/null
+++
b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/audit/AuditSourceElasticsearchOperator.java
@@ -0,0 +1,50 @@
+/*
+ * 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.inlong.manager.service.audit;
+
+import org.apache.inlong.manager.common.consts.AuditSourceType;
+import org.apache.inlong.manager.common.enums.ErrorCodeEnum;
+import org.apache.inlong.manager.common.exceptions.BusinessException;
+
+import org.apache.commons.lang3.StringUtils;
+import org.springframework.stereotype.Service;
+
+/**
+ * Audit source elasticsearch operator.
+ */
+@Service
+public class AuditSourceElasticsearchOperator extends
AbstractAuditSourceOperator {
+
+ private static final String ES_HTTP_HOST_PREFIX = "http://";;
+ private static final String ES_HTTPS_HOST_PREFIX = "https://";;
+
+ @Override
+ public String getType() {
+ return AuditSourceType.ELASTICSEARCH.name();
+ }
+
+ @Override
+ public String convertTo(String url) {
+ if (StringUtils.isNotBlank(url)
+ && (url.startsWith(ES_HTTP_HOST_PREFIX) ||
url.startsWith(ES_HTTPS_HOST_PREFIX))) {
+ return url;
+ }
+
+ throw new
BusinessException(String.format(ErrorCodeEnum.AUDIT_SOURCE_URL_NOT_SUPPORTED.getMessage(),
url));
+ }
+}
diff --git
a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/audit/AuditSourceMysqlOperator.java
b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/audit/AuditSourceMysqlOperator.java
new file mode 100644
index 0000000000..448345e0ff
--- /dev/null
+++
b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/audit/AuditSourceMysqlOperator.java
@@ -0,0 +1,49 @@
+/*
+ * 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.inlong.manager.service.audit;
+
+import org.apache.inlong.manager.common.consts.AuditSourceType;
+import org.apache.inlong.manager.common.enums.ErrorCodeEnum;
+import org.apache.inlong.manager.common.exceptions.BusinessException;
+import org.apache.inlong.manager.pojo.util.MySQLSensitiveUrlUtils;
+
+import org.apache.commons.lang3.StringUtils;
+import org.springframework.stereotype.Service;
+
+/**
+ * Audit source mysql operator.
+ */
+@Service
+public class AuditSourceMysqlOperator extends AbstractAuditSourceOperator {
+
+ private static final String MYSQL_JDBC_PREFIX = "jdbc:mysql://";
+
+ @Override
+ public String getType() {
+ return AuditSourceType.MYSQL.name();
+ }
+
+ @Override
+ public String convertTo(String url) {
+ if (StringUtils.isNotBlank(url) && url.startsWith(MYSQL_JDBC_PREFIX)) {
+ return MySQLSensitiveUrlUtils.filterSensitive(url);
+ }
+
+ throw new
BusinessException(String.format(ErrorCodeEnum.AUDIT_SOURCE_URL_NOT_SUPPORTED.getMessage(),
url));
+ }
+}
diff --git
a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/audit/InlongAuditSourceOperator.java
b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/audit/InlongAuditSourceOperator.java
new file mode 100644
index 0000000000..faafb977f1
--- /dev/null
+++
b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/audit/InlongAuditSourceOperator.java
@@ -0,0 +1,44 @@
+/*
+ * 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.inlong.manager.service.audit;
+
+/**
+ * Interface of the inlong audit source operator.
+ */
+public interface InlongAuditSourceOperator {
+
+ /**
+ * Determines whether the current instance matches the specified type.
+ */
+ Boolean accept(String type);
+
+ /**
+ * Get the Audit Source type.
+ *
+ * @return audit source type string
+ */
+ String getType();
+
+ /**
+ * Convert the URL.
+ *
+ * @param url audit source url
+ * @return converted url string
+ */
+ String convertTo(String url);
+}
diff --git
a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/audit/InlongAuditSourceOperatorFactory.java
b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/audit/InlongAuditSourceOperatorFactory.java
new file mode 100644
index 0000000000..e38b75635c
--- /dev/null
+++
b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/audit/InlongAuditSourceOperatorFactory.java
@@ -0,0 +1,47 @@
+/*
+ * 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.inlong.manager.service.audit;
+
+import org.apache.inlong.manager.common.enums.ErrorCodeEnum;
+import org.apache.inlong.manager.common.exceptions.BusinessException;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Service;
+
+import java.util.List;
+
+/**
+ * Factory for {@link InlongAuditSourceOperator}.
+ */
+@Service
+public class InlongAuditSourceOperatorFactory {
+
+ @Autowired
+ private List<InlongAuditSourceOperator> auditSourceOperatorList;
+
+ /**
+ * Get an inlong Audit Source operator instance via the given type
+ */
+ public InlongAuditSourceOperator getInstance(String type) {
+ return auditSourceOperatorList.stream()
+ .filter(inst -> inst.accept(type))
+ .findFirst()
+ .orElseThrow(() -> new BusinessException(
+
String.format(ErrorCodeEnum.AUDIT_SOURCE_TYPE_NOT_SUPPORTED.getMessage(),
type)));
+ }
+}
diff --git
a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/AuditServiceImpl.java
b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/AuditServiceImpl.java
index 264911fb60..bcec3b926b 100644
---
a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/AuditServiceImpl.java
+++
b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/AuditServiceImpl.java
@@ -45,6 +45,8 @@ import
org.apache.inlong.manager.pojo.audit.AuditSourceResponse;
import org.apache.inlong.manager.pojo.audit.AuditVO;
import org.apache.inlong.manager.pojo.user.LoginUserUtils;
import org.apache.inlong.manager.pojo.user.UserRoleCode;
+import org.apache.inlong.manager.service.audit.InlongAuditSourceOperator;
+import
org.apache.inlong.manager.service.audit.InlongAuditSourceOperatorFactory;
import org.apache.inlong.manager.service.core.AuditService;
import org.apache.inlong.manager.service.resource.sink.ck.ClickHouseConfig;
import org.apache.inlong.manager.service.resource.sink.es.ElasticsearchApi;
@@ -142,6 +144,8 @@ public class AuditServiceImpl implements AuditService {
private AuditSourceEntityMapper auditSourceMapper;
@Autowired
private InlongGroupEntityMapper inlongGroupMapper;
+ @Autowired
+ private InlongAuditSourceOperatorFactory auditSourceOperatorFactory;
@PostConstruct
public void initialize() {
@@ -178,6 +182,9 @@ public class AuditServiceImpl implements AuditService {
@Override
public Integer updateAuditSource(AuditSourceRequest request, String
operator) {
+ InlongAuditSourceOperator auditSourceOperator =
auditSourceOperatorFactory.getInstance(request.getType());
+ request.setUrl(auditSourceOperator.convertTo(request.getUrl()));
+
String offlineUrl = request.getOfflineUrl();
if (StringUtils.isNotBlank(offlineUrl)) {
auditSourceMapper.offlineSourceByUrl(offlineUrl);
