This is an automated email from the ASF dual-hosted git repository.
casion pushed a commit to branch dev-1.3.1-errorcode
in repository https://gitbox.apache.org/repos/asf/incubator-linkis.git
The following commit(s) were added to refs/heads/dev-1.3.1-errorcode by this
push:
new 9567e598f [linkis-cs-client]module errorcode optimization and
documentation (#3567)
9567e598f is described below
commit 9567e598fc173b23a7fc880114340272a480bf1c
Author: 成彬彬 <[email protected]>
AuthorDate: Sun Oct 16 13:21:51 2022 +0800
[linkis-cs-client]module errorcode optimization and documentation (#3567)
---
docs/errorcode/linkis-cs-client-errorcode.md | 16 +++++
.../client/errorcode/CsClientErrorCodeSummary.java | 79 ++++++++++++++++++++++
.../linkis/cs/client/http/HttpContextClient.java | 47 +++++++++----
3 files changed, 127 insertions(+), 15 deletions(-)
diff --git a/docs/errorcode/linkis-cs-client-errorcode.md
b/docs/errorcode/linkis-cs-client-errorcode.md
new file mode 100644
index 000000000..e5f626fad
--- /dev/null
+++ b/docs/errorcode/linkis-cs-client-errorcode.md
@@ -0,0 +1,16 @@
+## linkis-cs-client errorcode
+
+| module name(模块名) | error code(错误码) | describe(描述) |enumeration name(枚举)|
Exception Class(类名)|
+| -------- | -------- | ----- |-----|-----|
+|linkis-cs-client |80015|create context
failed(创建上下文失败)|CREATE_CONTEXT_FAILED|CsClientErrorCodeSummary|
+|linkis-cs-client |80015|get context value
failed(获取上下文值失败)|GET_CONTEXT_VALUE_FAILED|CsClientErrorCodeSummary|
+|linkis-cs-client |80015|update context
failed(更新上下文失败)|UPDATE_CONTEXT_FAILED|CsClientErrorCodeSummary|
+|linkis-cs-client |80015|reset context
failed(重置上下文失败)|RESET_CONTEXT_FAILED|CsClientErrorCodeSummary|
+|linkis-cs-client |80015|remove context
failed(刪除上下文失败)|REMOVE_CONTEXT_FAILED|CsClientErrorCodeSummary|
+|linkis-cs-client |80015|bind context id failed(绑定上下文 ID
失败)|BIND_CONTEXTID_FAILED|CsClientErrorCodeSummary|
+|linkis-cs-client |80015|search condition
failed(搜索失败)|SEARCH_CONDITION_FAILED|CsClientErrorCodeSummary|
+|linkis-cs-client |80015|execute
failed(执行失败)|EXECUTE_FALIED|CsClientErrorCodeSummary|
+|linkis-cs-client |80017|searchHAIDByTime
failed(搜索HAIDByTime失败)|HAIDBYTIME_FAILED|CsClientErrorCodeSummary|
+|linkis-cs-client |80017|batch Clear Context By HAID failed(通过 HAID
批量清除上下文失败)|CLEAR_CONTEXT_HAID_FAILED|CsClientErrorCodeSummary|
+
+
diff --git
a/linkis-public-enhancements/linkis-context-service/linkis-cs-client/src/main/java/org/apache/linkis/cs/client/errorcode/CsClientErrorCodeSummary.java
b/linkis-public-enhancements/linkis-context-service/linkis-cs-client/src/main/java/org/apache/linkis/cs/client/errorcode/CsClientErrorCodeSummary.java
new file mode 100644
index 000000000..bbd99796c
--- /dev/null
+++
b/linkis-public-enhancements/linkis-context-service/linkis-cs-client/src/main/java/org/apache/linkis/cs/client/errorcode/CsClientErrorCodeSummary.java
@@ -0,0 +1,79 @@
+/*
+ * 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.linkis.cs.client.errorcode;
+
+public enum CsClientErrorCodeSummary {
+ CREATE_CONTEXT_FAILED(80015, "create context failed(创建上下文失败)", "create
context failed(创建上下文失败)"),
+ GET_CONTEXT_VALUE_FAILED(
+ 80015, "get context value failed(获取上下文值失败)", "get context value
failed(获取上下文值失败)"),
+ UPDATE_CONTEXT_FAILED(80015, "update context failed(更新上下文失败)", "update
context failed(更新上下文失败)"),
+ RESET_CONTEXT_FAILED(80015, "reset context failed(重置上下文失败)", "reset context
failed(重置上下文失败)"),
+ REMOVE_CONTEXT_FAILED(80015, "remove context failed(刪除上下文失败)", "remove
context failed(刪除上下文失败)"),
+ BIND_CONTEXTID_FAILED(
+ 80015, "bind context id failed(绑定上下文 ID 失败)", "bind context id
failed(绑定上下文 ID 失败)"),
+ SEARCH_CONDITION_FAILED(80015, "search condition failed(搜索失败)", "search
condition failed(搜索失败)"),
+ EXECUTE_FALIED(80015, "execute failed(执行失败)", "execute failed(执行失败)"),
+ HAIDBYTIME_FAILED(
+ 80017, "searchHAIDByTime failed(搜索HAIDByTime失败)", "searchHAIDByTime
failed(搜索HAIDByTime失败)"),
+ CLEAR_CONTEXT_HAID_FAILED(
+ 80017,
+ "batch Clear Context By HAID failed(通过 HAID 批量清除上下文失败)",
+ "batch Clear Context By HAID failed(通过 HAID 批量清除上下文失败)");
+
+ /** (errorCode)错误码 */
+ private int errorCode;
+ /** (errorDesc)错误描述 */
+ private String errorDesc;
+ /** Possible reasons for the error(错误可能出现的原因) */
+ private String comment;
+
+ CsClientErrorCodeSummary(int errorCode, String errorDesc, String comment) {
+ this.errorCode = errorCode;
+ this.errorDesc = errorDesc;
+ this.comment = comment;
+ }
+
+ public int getErrorCode() {
+ return errorCode;
+ }
+
+ public void setErrorCode(int errorCode) {
+ this.errorCode = errorCode;
+ }
+
+ public String getErrorDesc() {
+ return errorDesc;
+ }
+
+ public void setErrorDesc(String errorDesc) {
+ this.errorDesc = errorDesc;
+ }
+
+ public String getComment() {
+ return comment;
+ }
+
+ public void setComment(String comment) {
+ this.comment = comment;
+ }
+
+ @Override
+ public String toString() {
+ return "errorCode: " + this.errorCode + ", errorDesc:" + this.errorDesc;
+ }
+}
diff --git
a/linkis-public-enhancements/linkis-context-service/linkis-cs-client/src/main/java/org/apache/linkis/cs/client/http/HttpContextClient.java
b/linkis-public-enhancements/linkis-context-service/linkis-cs-client/src/main/java/org/apache/linkis/cs/client/http/HttpContextClient.java
index a5ecfc807..a4730d486 100644
---
a/linkis-public-enhancements/linkis-context-service/linkis-cs-client/src/main/java/org/apache/linkis/cs/client/http/HttpContextClient.java
+++
b/linkis-public-enhancements/linkis-context-service/linkis-cs-client/src/main/java/org/apache/linkis/cs/client/http/HttpContextClient.java
@@ -54,6 +54,8 @@ import java.util.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+import static org.apache.linkis.cs.client.errorcode.CsClientErrorCodeSummary.*;
+
/** Description: HttpContextClient是ContextClient的使用Http方式进行通信的具体实现 一般可以将其做成单例
*/
public class HttpContextClient extends AbstractContextClient {
@@ -116,7 +118,8 @@ public class HttpContextClient extends
AbstractContextClient {
result = dwsHttpClient.execute(contextCreateAction);
} catch (Exception e) {
LOGGER.error("create context failed", e);
- ExceptionHelper.throwErrorException(80015, "create context failed", e);
+ ExceptionHelper.throwErrorException(
+ CREATE_CONTEXT_FAILED.getErrorCode(),
CREATE_CONTEXT_FAILED.getErrorDesc(), e);
}
if (result instanceof ContextCreateResult) {
ContextCreateResult contextCreateResult = (ContextCreateResult) result;
@@ -159,7 +162,8 @@ public class HttpContextClient extends
AbstractContextClient {
result = dwsHttpClient.execute(contextCreateAction);
} catch (Exception e) {
LOGGER.error("create context failed", e);
- ExceptionHelper.throwErrorException(80015, "create context failed", e);
+ ExceptionHelper.throwErrorException(
+ CREATE_CONTEXT_FAILED.getErrorCode(),
CREATE_CONTEXT_FAILED.getErrorDesc(), e);
}
if (result instanceof ContextCreateResult) {
ContextCreateResult contextCreateResult = (ContextCreateResult) result;
@@ -218,7 +222,8 @@ public class HttpContextClient extends
AbstractContextClient {
result = dwsHttpClient.execute(contextGetValueAction);
} catch (Exception e) {
LOGGER.error("get context value id: {} , key: {} failed", contextIDStr,
contextKeyStr, e);
- ExceptionHelper.throwErrorException(80015, "get context value failed",
e);
+ ExceptionHelper.throwErrorException(
+ GET_CONTEXT_VALUE_FAILED.getErrorCode(),
GET_CONTEXT_VALUE_FAILED.getErrorDesc(), e);
}
if (result instanceof ContextGetValueResult) {
ContextGetValueResult contextGetValueResult = (ContextGetValueResult)
result;
@@ -265,7 +270,8 @@ public class HttpContextClient extends
AbstractContextClient {
result = dwsHttpClient.execute(contextSetKeyValueAction);
} catch (Exception e) {
LOGGER.error("update context failed", e);
- ExceptionHelper.throwErrorException(80015, "update context failed", e);
+ ExceptionHelper.throwErrorException(
+ UPDATE_CONTEXT_FAILED.getErrorCode(),
UPDATE_CONTEXT_FAILED.getErrorDesc(), e);
}
if (result instanceof ContextSetKeyValueResult) {
ContextSetKeyValueResult contextSetKeyValueResult =
(ContextSetKeyValueResult) result;
@@ -302,7 +308,8 @@ public class HttpContextClient extends
AbstractContextClient {
result = dwsHttpClient.execute(contextResetValueAction);
} catch (Exception e) {
LOGGER.error("reset contextID {}, contextKey {} failed", contextIdStr,
contextKeyStr, e);
- ExceptionHelper.throwErrorException(80015, "reset context failed", e);
+ ExceptionHelper.throwErrorException(
+ RESET_CONTEXT_FAILED.getErrorCode(),
RESET_CONTEXT_FAILED.getErrorDesc(), e);
}
if (result instanceof ContextResetResult) {
ContextResetResult contextResetResult = (ContextResetResult) result;
@@ -340,7 +347,8 @@ public class HttpContextClient extends
AbstractContextClient {
result = dwsHttpClient.execute(contextResetIDAction);
} catch (Exception e) {
LOGGER.error("reset contextID {} failed", contextIdStr, e);
- ExceptionHelper.throwErrorException(80015, "reset context failed", e);
+ ExceptionHelper.throwErrorException(
+ RESET_CONTEXT_FAILED.getErrorCode(),
RESET_CONTEXT_FAILED.getErrorDesc(), e);
}
if (result instanceof ContextResetIDResult) {
ContextResetIDResult contextResetResult = (ContextResetIDResult) result;
@@ -381,7 +389,8 @@ public class HttpContextClient extends
AbstractContextClient {
result = dwsHttpClient.execute(contextRemoveAction);
} catch (Exception e) {
LOGGER.error("remove context id {} context key {} failed", contextIdStr,
contextIdStr, e);
- ExceptionHelper.throwErrorException(80015, "remove context failed", e);
+ ExceptionHelper.throwErrorException(
+ REMOVE_CONTEXT_FAILED.getErrorCode(),
REMOVE_CONTEXT_FAILED.getErrorDesc(), e);
}
if (result instanceof ContextRemoveResult) {
ContextRemoveResult contextRemoveResult = (ContextRemoveResult) result;
@@ -417,7 +426,8 @@ public class HttpContextClient extends
AbstractContextClient {
result = dwsHttpClient.execute(action);
} catch (Exception e) {
LOGGER.error("set value failed", e);
- ExceptionHelper.throwErrorException(80015, "update context failed", e);
+ ExceptionHelper.throwErrorException(
+ UPDATE_CONTEXT_FAILED.getErrorCode(),
REMOVE_CONTEXT_FAILED.getErrorDesc(), e);
}
if (result instanceof ContextSetKeyValueResult) {
ContextSetKeyValueResult contextSetKeyValueResult =
(ContextSetKeyValueResult) result;
@@ -448,7 +458,8 @@ public class HttpContextClient extends
AbstractContextClient {
result = dwsHttpClient.execute(contextBindIDAction);
} catch (Exception e) {
LOGGER.error("bind context id {} failed", contextIDStr, e);
- ExceptionHelper.throwErrorException(80015, "bind context id failed", e);
+ ExceptionHelper.throwErrorException(
+ BIND_CONTEXTID_FAILED.getErrorCode(),
BIND_CONTEXTID_FAILED.getErrorDesc(), e);
}
if (result instanceof ContextBindIDResult) {
ContextBindIDResult contextBindIDResult = (ContextBindIDResult) result;
@@ -486,7 +497,8 @@ public class HttpContextClient extends
AbstractContextClient {
result = dwsHttpClient.execute(contextBindKeyAction);
} catch (Exception e) {
LOGGER.error("bind context id {} context key {} failed", contextIDStr,
contextKeyStr, e);
- ExceptionHelper.throwErrorException(80015, "bind context key failed", e);
+ ExceptionHelper.throwErrorException(
+ BIND_CONTEXTID_FAILED.getErrorCode(),
BIND_CONTEXTID_FAILED.getErrorDesc(), e);
}
if (result instanceof ContextBindKeyResult) {
ContextBindKeyResult contextBindKeyResult = (ContextBindKeyResult)
result;
@@ -568,7 +580,8 @@ public class HttpContextClient extends
AbstractContextClient {
result = dwsHttpClient.execute(contextSearchContextAction);
} catch (Exception e) {
LOGGER.error("search condition failed", e);
- ExceptionHelper.throwErrorException(80015, "search condition failed", e);
+ ExceptionHelper.throwErrorException(
+ SEARCH_CONDITION_FAILED.getErrorCode(),
SEARCH_CONDITION_FAILED.getErrorDesc(), e);
}
if (result instanceof ContextSearchResult) {
ContextSearchResult contextSearchResult = (ContextSearchResult) result;
@@ -751,7 +764,8 @@ public class HttpContextClient extends
AbstractContextClient {
result = execute(action);
} catch (Exception e) {
LOGGER.error("searchHAIDByTime failed, {}", e.getMessage(), e);
- ExceptionHelper.throwErrorException(80017, "searchHAIDByTime failed.",
e);
+ ExceptionHelper.throwErrorException(
+ HAIDBYTIME_FAILED.getErrorCode(), HAIDBYTIME_FAILED.getErrorDesc(),
e);
}
if (result instanceof ContextSearchIDByTimeResult) {
ContextSearchIDByTimeResult contextSearchIDByTimeResult =
@@ -789,7 +803,8 @@ public class HttpContextClient extends
AbstractContextClient {
result = execute(action);
} catch (Exception e) {
LOGGER.error("batchClearContextByHAID failed, {}", e.getMessage(), e);
- ExceptionHelper.throwErrorException(80017, "batchClearContextByHAID
failed.", e);
+ ExceptionHelper.throwErrorException(
+ CLEAR_CONTEXT_HAID_FAILED.getErrorCode(),
CLEAR_CONTEXT_HAID_FAILED.getErrorDesc(), e);
}
if (result instanceof ContextClearByIDResult) {
ContextClearByIDResult contextClearByIDResult = (ContextClearByIDResult)
result;
@@ -838,7 +853,8 @@ public class HttpContextClient extends
AbstractContextClient {
result = execute(action);
} catch (Exception e) {
LOGGER.error("batchClearContextByTime failed, {}", e.getMessage(), e);
- ExceptionHelper.throwErrorException(80017, "batchClearContextByTime
failed.", e);
+ ExceptionHelper.throwErrorException(
+ CLEAR_CONTEXT_HAID_FAILED.getErrorCode(),
CLEAR_CONTEXT_HAID_FAILED.getErrorDesc(), e);
}
if (result instanceof ContextClearByTimeResult) {
ContextClearByTimeResult contextClearByTimeResult =
(ContextClearByTimeResult) result;
@@ -859,7 +875,8 @@ public class HttpContextClient extends
AbstractContextClient {
return dwsHttpClient.execute(action);
} catch (Exception e) {
LOGGER.error("execute failed", e);
- ExceptionHelper.throwErrorException(80015, "execute failed", e);
+ ExceptionHelper.throwErrorException(
+ EXECUTE_FALIED.getErrorCode(), EXECUTE_FALIED.getErrorDesc(), e);
}
return null;
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
