WeIdentity-Kit文档 ======================= 总体介绍 -------- WeIdentity-Kit给WeIdentity提供了多种实用工具，包括不同传输协议、鉴权流程和对可验证凭证（VC）的多种格式转化。 体验使用WeIdentity-Kit ---- 前提条件 ~~~~~~~~ 运行 WeIdentity-Kit 需要提前使用 WeIdentity 部署工具完成部署，请参考\ `WeIdentity JAVA SDK安装部署 <./one-stop-experience.html>`__\ 完成部署，并参照\ `Java应用集成章节 <./weidentity-build-with-deploy.html#weid-java-sdk>`__\ 完成 weid-sample 的配置。 代码结构说明 ------------ .. code-block:: text ├─ app：测试小工具 ├─ amop：amop通讯相关接口 ├─ auth：基于WeIdentity的鉴权流程 ├─ constant：系统常量相关 └─ crypto：数据的加密方式 ├─ AesCryptoService: 对称加密 ├─ EciesCryptoService: Ecies非对称加密 └─ RsaCryptoService: RSA非对称加密 ├─ endpoint: 端口注册服务 ├─ exception: 异常定义 └─ protocol：接口参数相关定义 ├─ request: 接口入参定义 └─ response: 接口出参定义 └─ transmission：传输协议定义 ├─ http: http传输方式定义 └─ amop: amop传输方式定义 └─ transportation：数据的转化方式 ├─ JsonTransportationImpl: 数据转化Json ├─ PdfTransportationImpl: 数据转化PDF └─ QrCodeTransportationImpl: 数据转化二维码 └─ util：工具类实现 接口列表 -------- AmopService ^^^^^^^^^^^^^^^^^ 1. registerCallback ~~~~~~~~~~~~~~~~~~~ **基本信息** .. code-block:: text 接口名称:com.webank.weid.rpc.AmopService.registerCallback 接口定义:void registerCallback(Integer directRouteMsgType, AmopCallback directRouteCallback) 接口描述: 注册AMOP回调处理。 **接口入参**\ : java.lang.Integer .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - directRouteMsgType - Integer - Y - AMOP消息类型 - com.webank.weid.rpc.callback.WeIdAmopCallback .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - object - AmopCallback - 处理消息的callback对象 - 机构需继承并且重写onPush(AmopCommonArgs arg) **接口返回**\ : 无; ---- 2. request ~~~~~~~~~~~~~~~~~~~ **基本信息** .. code-block:: text 接口名称: com.webank.weid.rpc.AmopService.request 接口定义: ResponseData request(String toOrgId, AmopCommonArgs args) 接口描述: AMOP请求Server。 **接口入参**\ : java.lang.String .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - toOrgId - String - Y - 目标机构编码 - com.webank.weid.protocol.amop.AmopCommonArgs .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - messageId - String - N - 消息编号 - * - fromOrgId - String - N - 消息来源机构编号 - * - toOrgId - String - N - 消息目标机构编号 - * - message - String - Y - 请求body - **接口返回**\ : com.webank.weid.protocol.response.ResponseData\; .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - kitErrorCode - Integer - 返回结果码 - * - errorMessage - String - 返回结果描述 - * - result - AmopResponse - AMOP响应 - 业务数据 com.webank.weid.protocol.response.AmopResponse .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - result - String - AMOP消息响应body - * - kitErrorCode - Integer - 业务结果编码 - * - errorMessage - String - 业务结果描述 - * - messageId - String - 消息编号 - **此方法返回code** .. list-table:: :header-rows: 1 * - enum - code - desc * - SUCCESS - 0 - 成功 * - UNKNOW_ERROR - 160003 - 未知异常 * - DIRECT_ROUTE_REQUEST_TIMEOUT - 160009 - AMOP超时 * - DIRECT_ROUTE_MSG_BASE_ERROR - 160010 - AMOP异常 ---- 3. getPolicyAndChallenge ~~~~~~~~~~~~~~~~~~~ **基本信息** .. code-block:: text 接口名称: com.webank.weid.rpc.AmopService.getPolicyAndChallenge 接口定义: ResponseData getPolicyAndChallenge(String orgId, Integer policyId, String targetUserWeId) 接口描述: 通过AMOP获取PolicyAndChallenge。 **接口入参**\ : java.lang.String .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - toOrgId - String - Y - 目标机构编码 - java.lang.Integer .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - policyId - String - Y - 策略编号 - java.lang.String .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - targetUserWeId - String - Y - 需要被challenge的WeIdentity DID - **接口返回**\ : com.webank.weid.protocol.response.ResponseData\; .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - kitErrorCode - Integer - 返回结果码 - * - errorMessage - String - 返回结果描述 - * - result - PolicyAndChallenge - - 业务数据 com.webank.weid.protocol.base.PolicyAndChallenge .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - presentationPolicyE - PresentationPolicyE - 策略信息 - * - challenge - Challenge - - com.webank.weid.protocol.base.PresentationPolicyE .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - id - Integer - polcyId - 策略编号 * - orgId - String - 机构编号 - * - version - Integer - 版本 - * - policyPublisherWeId - String - WeIdentity DID - 创建policy机构的WeIdentity DID * - policy - Map - 策略配置 - key:CPTID, value:披露策略对象 * - extra - Map - 扩展字段 - com.webank.weid.protocol.base.Challenge .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - weId - String - WeIdentity DID - policy提供给指定的WeIdentity DID * - version - Integer - 版本 - * - nonce - String - 随机字符串 - **此方法返回code** .. list-table:: :header-rows: 1 * - enum - code - desc * - SUCCESS - 0 - 成功 * - POLICY_SERVICE_NOT_EXISTS - 100701 - policyService不存在 * - POLICY_SERVICE_CALL_FAIL - 100702 - policyService调用未知异常 * - UNKNOW_ERROR - 160003 - 未知异常 * - ILLEGAL_INPUT - 160004 - 参数非法 * - DIRECT_ROUTE_REQUEST_TIMEOUT - 160009 - AMOP超时 * - DIRECT_ROUTE_MSG_BASE_ERROR - 160010 - AMOP异常 ---- 4. requestPolicyAndPreCredential ~~~~~~~~~~~~~~~~~~~ **基本信息** .. code-block:: text 接口名称: com.webank.weid.rpc.AmopService.requestPolicyAndPreCredential 接口定义: ResponseData requestPolicyAndPreCredential(String orgId, GetPolicyAndPreCredentialArgs args) 接口描述: 通过AMOP获取PolicyAndChallenge和preCredential，在用户向issuer请求发zkp类型的credential时调用。 **接口入参**\ : java.lang.String .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - toOrgId - String - Y - 目标机构编码 - com.webank.weid.protocol.amop.GetPolicyAndPreCredentialArgs .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - policyId - String - Y - 策略编号 - * - targetUserWeId - String - Y - 目前用户WeID - * - cptId - String - Y - CPT 编号 - * - claim - String - Y - 用户claim - **接口返回**\ : com.webank.weid.protocol.response.ResponseData\; com.webank.weid.protocol.base.PolicyAndPreCredential .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - kitErrorCode - Integer - 返回结果码 - * - errorMessage - String - 返回结果描述 - * - result - PolicyAndChallenge - - 业务数据 * - preCredential - CredentialPojo - - 基于CPT 110的元数据的Credential * - extra - Map - - 附加信息 com.webank.weid.protocol.base.PolicyAndChallenge .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - presentationPolicyE - PresentationPolicyE - 策略信息 - * - challenge - Challenge - - com.webank.weid.protocol.base.PresentationPolicyE .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - id - Integer - polcyId - 策略编号 * - orgId - String - 机构编号 - * - version - Integer - 版本 - * - policyPublisherWeId - String - WeIdentity DID - 创建policy机构的WeIdentity DID * - policy - Map - 策略配置 - key:CPTID, value:披露策略对象 * - extra - Map - 扩展字段 - com.webank.weid.protocol.base.Challenge .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - weId - String - WeIdentity DID - policy提供给指定的WeIdentity DID * - version - Integer - 版本 - * - nonce - String - 随机字符串 - **此方法返回code** .. list-table:: :header-rows: 1 * - enum - code - desc * - SUCCESS - 0 - 成功 * - POLICY_SERVICE_NOT_EXISTS - 100701 - policyService不存在 * - POLICY_SERVICE_CALL_FAIL - 100702 - policyService调用未知异常 * - UNKNOW_ERROR - 160003 - 未知异常 * - ILLEGAL_INPUT - 160004 - 参数非法 * - DIRECT_ROUTE_REQUEST_TIMEOUT - 160009 - AMOP超时 * - DIRECT_ROUTE_MSG_BASE_ERROR - 160010 - AMOP异常 ---- 5. requestIssueCredential ~~~~~~~~~~~~~~~~~~~ **基本信息** .. code-block:: text 接口名称: com.webank.weid.rpc.AmopService.requestIssueCredential 接口定义: ResponseData requestIssueCredential(String orgId, RequestIssueCredentialArgs args) 接口描述: 通过AMOP获取zkp类型的Credential，在用户向issuer请求发zkp类型的credential时调用。 **接口入参**\ : java.lang.String .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - toOrgId - String - Y - 目标机构编码 - com.webank.weid.protocol.amop.RequestIssueCredentialArgs .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - policyAndPreCredential - PolicyAndPreCredential - Y - policyAndChanllenge和基于元数据的precredential - * - credentialList - List - Y - 用户根据policy向issuer提供的credential列表 - * - claim - String - Y - 用户要填入的claim - * - auth - WeIdAuthentication - Y - 用户私钥信息 - com.webank.weid.protocol.base.PolicyAndPreCredential .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - policyAndChallenge - PolicyAndChallenge - - 业务数据 * - preCredential - CredentialPojo - - 基于CPT 110的元数据的Credential * - extra - Map - - 附加信息 com.webank.weid.protocol.base.PolicyAndChallenge .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - presentationPolicyE - PresentationPolicyE - 策略信息 - * - challenge - Challenge - - com.webank.weid.protocol.base.PresentationPolicyE .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - id - Integer - polcyId - 策略编号 * - orgId - String - 机构编号 - * - version - Integer - 版本 - * - policyPublisherWeId - String - WeIdentity DID - 创建policy机构的WeIdentity DID * - policy - Map - 策略配置 - key:CPTID, value:披露策略对象 * - extra - Map - 扩展字段 - com.webank.weid.protocol.base.Challenge .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - weId - String - WeIdentity DID - policy提供给指定的WeIdentity DID * - version - Integer - 版本 - * - nonce - String - 随机字符串 - **接口返回**\ : com.webank.weid.protocol.response.ResponseData\; com.webank.weid.protocol.base.RequestIssueCredentialResponse .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - kitErrorCode - Integer - 返回结果码 - * - errorMessage - String - 返回结果描述 - * - credentialPojo - CredentialPojo - - 业务数据 * - credentialSignature - String - - credential的签名 * - issuerNonce - String - - issuer提供的随机数 **此方法返回code** .. list-table:: :header-rows: 1 * - enum - code - desc * - SUCCESS - 0 - 成功 * - POLICY_SERVICE_NOT_EXISTS - 100701 - policyService不存在 * - POLICY_SERVICE_CALL_FAIL - 100702 - policyService调用未知异常 * - UNKNOW_ERROR - 160003 - 未知异常 * - ILLEGAL_INPUT - 160004 - 参数非法 * - DIRECT_ROUTE_REQUEST_TIMEOUT - 160009 - AMOP超时 * - DIRECT_ROUTE_MSG_BASE_ERROR - 160010 - AMOP异常 ---- 6. getEncryptKey ~~~~~~~~~~~~~~~~~~~ **基本信息** .. code-block:: text 接口名称: com.webank.weid.rpc.AmopService.getEncryptKey 接口定义: ResponseData getEncryptKey(String toOrgId, GetEncryptKeyArgs args) 接口描述: 通过AMOP获取密钥数据。 **接口入参**\ : .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - toOrgId - String - Y - 目标机构编码 - * - args - GetEncryptKeyArgs - Y - 密钥请求数据 - com.webank.weid.protocol.amop.GetEncryptKeyArgs .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - keyId - String - Y - 用于获取数据的Id - * - version - Version - Y - sdk版本信息 - * - messageId - String - Y - 消息Id - * - fromOrgId - String - Y - 数据来源机构 - * - toOrgId - String - Y - 数据目标机构 - **接口返回**\ : com.webank.weid.protocol.response.ResponseData\; .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - kitErrorCode - Integer - 返回结果码 - * - errorMessage - String - 返回结果描述 - * - result - GetEncryptKeyResponse - - 业务数据 com.webank.weid.protocol.response.GetEncryptKeyResponse .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - encryptKey - String - 密钥数据 - * - kitErrorCode - Integer - 错误码 - * - errorMessage - String - 错误描述 - **此方法返回code** .. list-table:: :header-rows: 1 * - enum - code - desc * - SUCCESS - 0 - 成功 * - ENCRYPT_KEY_NOT_EXISTS - 100700 - 无法获取秘钥 * - PRESISTENCE_DATA_KEY_INVALID - 100901 - dataKey无效 * - UNKNOW_ERROR - 160003 - 未知异常 * - DIRECT_ROUTE_REQUEST_TIMEOUT - 160009 - AMOP超时 * - DIRECT_ROUTE_MSG_BASE_ERROR - 160010 - AMOP异常 * - SQL_EXECUTE_FAILED - 160011 - SQL执行异常 * - SQL_GET_CONNECTION_ERROR - 160013 - 获取数据源连接异常 ---- JsonTransportation ^^^^^^^^^^^^^^^^^ 1. specify ~~~~~~~~~~~~~~~~~~~ **基本信息** .. code-block:: text 接口名称: com.webank.weid.suite.api.transportation.inf.JsonTransportation.specify 接口定义: JsonTransportation specify(List verifierWeIdList) 接口描述: 指定transportation的认证者,用于权限控制。 **接口入参**\ : java.util.List .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - verifierWeIdList - List - N - verifierWeId列表 - **接口返回**\ : com.webank.weid.suite.api.transportation.inf.JsonTransportation; **调用示例** .. code-block:: java JsonTransportation jsonTransportation =TransportationFactory.build(TransportationType.JSON); String weId = "did:weid:1000:0x0106595955ce4713fd169bfa68e599eb99ca2e9f"; List verifierWeIdList = new ArrayList(); verifierWeIdList.add(weId); jsonTransportation = jsonTransportation.specify(verifierWeIdList); **时序图** .. mermaid:: sequenceDiagram participant 调用者 participant JsonTransportation participant WeIdService participant 区块链 调用者->>JsonTransportation: 调用specify() JsonTransportation->>JsonTransportation: 入参非空、格式及合法性检查 opt 入参校验失败 JsonTransportation-->>调用者: 报错，提示参数不合法并退出 end loop 遍历每个WeID JsonTransportation->>WeIdService: 判断WeID的合法性，以及存在性，调用isWeIdExist()方法 WeIdService->>区块链: 查询该WeID是否存在 区块链-->>WeIdService: 返回查询结果 WeIdService-->>JsonTransportation: 返回查询结果 opt WeID不存在 JsonTransportation-->>调用者: 报错，提示WeID不存在 end JsonTransportation->>JsonTransportation: 放入verifier list里 end JsonTransportation-->>调用者: 返回成功 ---- 2. serialize ~~~~~~~~~~~~~~~~~~~ **基本信息** .. code-block:: text 接口名称: com.webank.weid.suite.api.transportation.inf.JsonTransportation.serialize 接口定义: ResponseData serialize(T object,ProtocolProperty property) 接口描述: 用于序列化对象,要求对象实现JsonSerializer接口。 **接口入参**\ : .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - object - - Y - 待序列化对象 - * - property - ProtocolProperty - Y - 协议配置 - **接口返回**\ : com.webank.weid.protocol.response.ResponseData\; .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - kitErrorCode - Integer - 返回结果码 - * - errorMessage - String - 返回结果描述 - * - result - String - 序列化后的字符串数据 - 业务数据 **此方法返回code** .. list-table:: :header-rows: 1 * - enum - code - desc * - SUCCESS - 0 - 成功 * - TRANSPORTATION_BASE_ERROR - 100800 - transportation基本未知异常 * - TRANSPORTATION_PROTOCOL_PROPERTY_ERROR - 100801 - 协议配置异常 * - TRANSPORTATION_PROTOCOL_ENCODE_ERROR - 100803 - 协议配置Encode异常 * - TRANSPORTATION_PROTOCOL_DATA_INVALID - 100805 - 协议数据无效 * - TRANSPORTATION_ENCODE_BASE_ERROR - 100807 - Encode基本未知异常 * - PRESISTENCE_DATA_KEY_INVALID - 100901 - dataKey无效 * - UNKNOW_ERROR - 160003 - 未知异常 * - BASE_ERROR - 160007 - weId基础未知异常 * - DATA_TYPE_CASE_ERROR - 160008 - 数据转换异常 * - SQL_EXECUTE_FAILED - 160011 - SQL执行异常 * - SQL_GET_CONNECTION_ERROR - 160013 - 获取数据源连接异常 **调用示例** .. code-block:: java String weId = "did:weid:1000:0x0106595955ce4713fd169bfa68e599eb99ca2e9f"; List verifierWeIdList = new ArrayList(); verifierWeIdList.add(weId); PresentationE presentation; //原文方式调用 ResponseData result1 = TransportationFactory .build(TransportationType.JSON) .specify(verifierWeIdList) .serialize(presentation,new ProtocolProperty(EncodeType.ORIGINAL)); //密文方式调用 ResponseData result2 = TransportationFactory .build(TransportationType.JSON) .specify(verifierWeIdList) .serialize(presentation,new ProtocolProperty(EncodeType.CIPHER)); **时序图** .. mermaid:: sequenceDiagram participant 调用者 participant JsonTransportation 调用者->>JsonTransportation: 调用serialize() JsonTransportation->>JsonTransportation: 入参非空、格式及合法性检查 opt 入参校验失败 JsonTransportation-->>调用者: 报错，提示参数不合法并退出 end JsonTransportation->>JsonTransportation: 拼装Json格式的协议头数据 JsonTransportation->>JsonTransportation: 判断是采用加密方式还是非加密方式 opt 非加密方式 JsonTransportation->>JsonTransportation: 将presentation原文放入协议里 end opt 加密方式 JsonTransportation->>EncodeProcessor: 调用encode方法 EncodeProcessor->>EncodeProcessor: 采用AES算法，生成对称加密秘钥 EncodeProcessor->>persistence: 保存至存储库里 persistence-->>EncodeProcessor: 返回 EncodeProcessor-->>JsonTransportation: 返回加密之后的presentation数据 JsonTransportation->>JsonTransportation: 将presentation密文放入协议里 end JsonTransportation->>DataToolUtils: 调用objToJsonStrWithNoPretty()将协议序列化成Json数据 DataToolUtils-->>JsonTransportation:返回包含presentation的Json数据 JsonTransportation-->>调用者: 返回成功 ---- 3. deserialize ~~~~~~~~~~~~~~~~~~~ **基本信息** .. code-block:: text 接口名称: com.webank.weid.suite.api.transportation.inf.JsonTransportation.deserialize 接口定义: ResponseData deserialize(WeIdAuthentication weIdAuthentication, String transString,Class clazz) 接口描述: 用于反序列化对象,要求目标对象实现JsonSerializer接口。 **接口入参**\ : .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - weIdAuthentication - WeIdAuthentication - Y - 调用者身份信息 - * - transString - String - Y - 待序列化对象 - * - clazz - Class - Y - 目标类型 - **接口返回**\ : com.webank.weid.protocol.response.ResponseData\; .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - kitErrorCode - Integer - 返回结果码 - * - errorMessage - String - 返回结果描述 - * - result - - 反序列化后的对象 - 业务数据 **此方法返回code** .. list-table:: :header-rows: 1 * - enum - code - desc * - SUCCESS - 0 - 成功 * - ENCRYPT_KEY_NOT_EXISTS - 100700 - 无法获取秘钥 * - TRANSPORTATION_BASE_ERROR - 100800 - transportation基本未知异常 * - TRANSPORTATION_PROTOCOL_VERSION_ERROR - 100802 - 协议版本错误 * - TRANSPORTATION_PROTOCOL_ENCODE_ERROR - 100803 - 协议配置Encode异常 * - TRANSPORTATION_PROTOCOL_DATA_INVALID - 100805 - 协议数据无效 * - TRANSPORTATION_ENCODE_BASE_ERROR - 100807 - Encode基本未知异常 * - PRESISTENCE_DATA_KEY_INVALID - 100901 - dataKey无效 * - UNKNOW_ERROR - 160003 - 未知异常 * - BASE_ERROR - 160007 - weId基础未知异常 * - DATA_TYPE_CASE_ERROR - 160008 - 数据转换异常 * - DIRECT_ROUTE_REQUEST_TIMEOUT - 160009 - AMOP超时 * - DIRECT_ROUTE_MSG_BASE_ERROR - 160010 - AMOP异常 * - SQL_EXECUTE_FAILED - 160011 - SQL执行异常 * - SQL_GET_CONNECTION_ERROR - 160013 - 获取数据源连接异常 **调用示例** .. code-block:: java String weId = "did:weid:1000:0x0106595955ce4713fd169bfa68e599eb99ca2e9f"; List verifierWeIdList = new ArrayList(); verifierWeIdList.add(weId); String transString=""; WeIdAuthentication weIdAuthentication; //原文方式调用反序列化 ResponseData result1 = TransportationFactory .build(TransportationType.JSON) .deserialize(weIdAuthentication,transString,PresentationE.class); **时序图** .. mermaid:: sequenceDiagram participant 调用者 participant JsonTransportation 调用者->>JsonTransportation: 调用deserialize() JsonTransportation->>JsonTransportation: 入参非空、格式及合法性检查 opt 入参校验失败 JsonTransportation-->>调用者: 报错，提示参数不合法并退出 end JsonTransportation->>DataToolUtils: 调用deserialize()方法，反序列化协议数据 DataToolUtils-->>JsonTransportation:返回Json格式的协议数据 JsonTransportation->>JsonTransportation: 解析协议，判断是采用加密方式还是非加密方式 opt 非加密方式 JsonTransportation->>DataToolUtils: 调用deserialize方法将协议里的presentation反序列化为对象 DataToolUtils-->>JsonTransportation: 返回PresentationE对象 end opt 加密方式 JsonTransportation->>EncodeProcessor: 调用decode方法 EncodeProcessor->>User Agent: 发送AMOP请求，获取对称加密秘钥 User Agent-->>EncodeProcessor: 返回加密秘钥 EncodeProcessor->>EncodeProcessor: 解密协议数据 EncodeProcessor-->>JsonTransportation: 返回解密后的presentation数据 JsonTransportation->>DataToolUtils: 调用deserialize方法将协议里的presentation反序列化 DataToolUtils-->>JsonTransportation: 返回PresentationE对象presentation反序列化为对象 end JsonTransportation-->>调用者: 返回成功 ---- QrCodeTransportation ^^^^^^^^^^^^^^^^^ 1. specify ~~~~~~~~~~~~~~~~~~~ **基本信息** .. code-block:: text 接口名称: com.webank.weid.suite.api.transportation.inf.QrCodeTransportation.specify 接口定义: JsonTransportation specify(List verifierWeIdList) 接口描述: 指定transportation的认证者,用于权限控制。 **接口入参**\ : java.util.List .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - verifierWeIdList - List - N - verifierWeId列表 - **接口返回**\ : com.webank.weid.suite.api.transportation.inf.JsonTransportation; **调用示例** .. code-block:: java Transportation transportation =TransportationFactory.build(TransportationType.QR_CODE); String weId = "did:weid:1000:0x0106595955ce4713fd169bfa68e599eb99ca2e9f"; List verifierWeIdList = new ArrayList(); verifierWeIdList.add(weId); transportation = transportation.specify(verifierWeIdList); **时序图** .. mermaid:: sequenceDiagram participant 调用者 participant QrCodeTransportation participant WeIdService participant 区块链 调用者->>QrCodeTransportation: 调用specify() QrCodeTransportation->>QrCodeTransportation: 入参非空、格式及合法性检查 opt 入参校验失败 QrCodeTransportation-->>调用者: 报错，提示参数不合法并退出 end loop 遍历每个WeID QrCodeTransportation->>WeIdService: 判断WeID的合法性，以及存在性，调用isWeIdExist()方法 WeIdService->>区块链: 查询该WeID是否存在 区块链-->>WeIdService: 返回查询结果 WeIdService-->>QrCodeTransportation: 返回查询结果 opt WeID不存在 QrCodeTransportation-->>调用者: 报错，提示WeID不存在 end QrCodeTransportation->>QrCodeTransportation: 放入verifier list里 end QrCodeTransportation-->>调用者: 返回成功 ---- 2. serialize ~~~~~~~~~~~~~~~~~~~ **基本信息** .. code-block:: text 接口名称: com.webank.weid.suite.api.transportation.inf.QrCodeTransportation.serialize 接口定义: ResponseData serialize(T object,ProtocolProperty property) 接口描述: 用于序列化对象,要求对象实现JsonSerializer接口，此接口仅支持数据模式 **接口入参**\ : .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - object - - Y - 待序列化对象 - * - property - ProtocolProperty - Y - 协议配置 - **接口返回**\ : com.webank.weid.protocol.response.ResponseData\; .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - kitErrorCode - Integer - 返回结果码 - * - errorMessage - String - 返回结果描述 - * - result - String - 序列化后的字符串数据 - 业务数据 **此方法返回code** .. list-table:: :header-rows: 1 * - enum - code - desc * - SUCCESS - 0 - 成功 * - TRANSPORTATION_PROTOCOL_PROPERTY_ERROR - 100801 - 协议配置异常 * - TRANSPORTATION_PROTOCOL_ENCODE_ERROR - 100803 - 协议配置Encode异常 * - TRANSPORTATION_PROTOCOL_DATA_INVALID - 100805 - 协议数据无效 * - TRANSPORTATION_ENCODE_BASE_ERROR - 100807 - Encode基本未知异常 * - PRESISTENCE_DATA_KEY_INVALID - 100901 - id无效 * - UNKNOW_ERROR - 160003 - 未知异常 * - BASE_ERROR - 160007 - weId基础未知异常 * - SQL_EXECUTE_FAILED - 160011 - SQL执行异常 * - SQL_GET_CONNECTION_ERROR - 160013 - 获取数据源连接异常 **调用示例** .. code-block:: java String weId = "did:weid:1000:0x0106595955ce4713fd169bfa68e599eb99ca2e9f"; List verifierWeIdList = new ArrayList(); verifierWeIdList.add(weId); PresentationE presentation; //数据模式 //原文方式调用 ResponseData result1 = TransportationFactory .build(TransportationType.QR_CODE) .specify(verifierWeIdList) .serialize(presentation,new ProtocolProperty(EncodeType.ORIGINAL)); //密文方式调用 ResponseData result2 = TransportationFactory .build(TransportationType.QR_CODE) .specify(verifierWeIdList) .serialize(presentation,new ProtocolProperty(EncodeType.CIPHER)); **时序图** .. mermaid:: sequenceDiagram participant 调用者 participant QrCodeTransportation 调用者->>QrCodeTransportation: 调用serialize() QrCodeTransportation->>QrCodeTransportation: 入参非空、格式及合法性检查 opt 入参校验失败 QrCodeTransportation-->>调用者: 报错，提示参数不合法并退出 end QrCodeTransportation->>QrCodeTransportation: 拼装协议头数据 QrCodeTransportation->>QrCodeTransportation: 判断是采用加密方式还是非加密方式 opt 非加密方式 QrCodeTransportation->>QrCodeTransportation: 将presentation原文放入协议里 end opt 加密方式 QrCodeTransportation->>EncodeProcessor: 调用encode方法 EncodeProcessor->>EncodeProcessor: 采用AES算法，生成对称加密秘钥 EncodeProcessor->>persistence: 保存至存储库里 persistence-->>EncodeProcessor: 返回 EncodeProcessor-->>QrCodeTransportation: 返回加密之后的presentation数据 QrCodeTransportation->>QrCodeTransportation: 将presentation密文放入协议里 end QrCodeTransportation-->>调用者: 返回QRCode协议数据 ---- 3. serialize ~~~~~~~~~~~~~~~~~~~ **基本信息** .. code-block:: text 接口名称: com.webank.weid.suite.api.transportation.inf.QrCodeTransportation.serialize 接口定义: ResponseData serialize(WeIdAuthentication weIdAuthentication, T object,ProtocolProperty property) 接口描述: 用于序列化对象,要求对象实现JsonSerializer接口，此接口支持将纯数据编入二维码协议，也支持将资源Id编入二维码协议进行远程下载 **接口入参**\ : .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - weIdAuthentication - WeIdAuthentication - Y - 调用者身份信息 - * - object - - Y - 待序列化对象 - * - property - ProtocolProperty - Y - 协议配置 - **接口返回**\ : com.webank.weid.protocol.response.ResponseData\; .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - kitErrorCode - Integer - 返回结果码 - * - errorMessage - String - 返回结果描述 - * - result - String - 序列化后的字符串数据 - 业务数据 **此方法返回code** .. list-table:: :header-rows: 1 * - enum - code - desc * - SUCCESS - 0 - 成功 * - TRANSPORTATION_PROTOCOL_PROPERTY_ERROR - 100801 - 协议配置异常 * - TRANSPORTATION_PROTOCOL_ENCODE_ERROR - 100803 - 协议配置Encode异常 * - TRANSPORTATION_PROTOCOL_DATA_INVALID - 100805 - 协议数据无效 * - TRANSPORTATION_ENCODE_BASE_ERROR - 100807 - Encode基本未知异常 * - PRESISTENCE_DATA_KEY_INVALID - 100901 - id无效 * - UNKNOW_ERROR - 160003 - 未知异常 * - BASE_ERROR - 160007 - weId基础未知异常 * - SQL_EXECUTE_FAILED - 160011 - SQL执行异常 * - SQL_GET_CONNECTION_ERROR - 160013 - 获取数据源连接异常 **调用示例** .. code-block:: java String weId = "did:weid:1000:0x0106595955ce4713fd169bfa68e599eb99ca2e9f"; List verifierWeIdList = new ArrayList(); verifierWeIdList.add(weId); PresentationE presentation; WeIdAuthentication weIdAuthentication; //数据模式 //原文方式调用 ResponseData result1 = TransportationFactory .build(TransportationType.QR_CODE) .specify(verifierWeIdList) .serialize(weIdAuthentication, presentation,new ProtocolProperty(EncodeType.ORIGINAL)); //密文方式调用 ResponseData result2 = TransportationFactory .build(TransportationType.QR_CODE) .specify(verifierWeIdList) .serialize(weIdAuthentication, presentation,new ProtocolProperty(EncodeType.CIPHER)); //下载模式 //原文方式调用 ResponseData result3 = TransportationFactory .build(TransportationType.QR_CODE) .specify(verifierWeIdList) .serialize(weIdAuthentication, presentation,new ProtocolProperty(EncodeType.ORIGINAL, TransMode.DOWNLOAD_MODE)); //密文方式调用 ResponseData result4 = TransportationFactory .build(TransportationType.QR_CODE) .specify(verifierWeIdList) .serialize(weIdAuthentication, presentation,new ProtocolProperty(EncodeType.CIPHER, TransMode.DOWNLOAD_MODE)); **时序图** .. mermaid:: sequenceDiagram participant 调用者 participant QrCodeTransportation 调用者->>QrCodeTransportation: 调用serialize() QrCodeTransportation->>QrCodeTransportation: 入参非空、格式及合法性检查 opt 入参校验失败 QrCodeTransportation-->>调用者: 报错，提示参数不合法并退出 end QrCodeTransportation->>QrCodeTransportation: 拼装协议头数据 QrCodeTransportation->>QrCodeTransportation: 判断是采用加密方式还是非加密方式 opt 非加密方式 QrCodeTransportation->>QrCodeTransportation: 将presentation原文放入协议里 end opt 加密方式 QrCodeTransportation->>EncodeProcessor: 调用encode方法 EncodeProcessor->>EncodeProcessor: 采用AES算法，生成对称加密秘钥 EncodeProcessor->>persistence: 保存至存储库里 persistence-->>EncodeProcessor: 返回 EncodeProcessor-->>QrCodeTransportation: 返回加密之后的presentation数据 QrCodeTransportation->>QrCodeTransportation: 将presentation密文放入协议里 end QrCodeTransportation-->>调用者: 返回QRCode协议数据 ---- 4. deserialize ~~~~~~~~~~~~~~~~~~~ **基本信息** .. code-block:: text 接口名称: com.webank.weid.suite.api.transportation.inf.QrCodeTransportation.deserialize 接口定义: ResponseData deserialize(WeIdAuthentication weIdAuthentication, String transString,Class clazz) 接口描述: 用于反序列化对象,要求目标对象实现JsonSerializer接口。 **接口入参**\ : .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - weIdAuthentication - WeIdAuthentication - Y - 调用者身份信息 - * - transString - String - Y - 待序列化对象 - * - clazz - Class - Y - 目标类型 - **接口返回**\ : com.webank.weid.protocol.response.ResponseData\; .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - kitErrorCode - Integer - 返回结果码 - * - errorMessage - String - 返回结果描述 - * - result - - 反序列化后的对象 - 业务数据 **此方法返回code** .. list-table:: :header-rows: 1 * - enum - code - desc * - SUCCESS - 0 - 成功 * - ENCRYPT_KEY_NOT_EXISTS - 100700 - 无法获取秘钥 * - TRANSPORTATION_PROTOCOL_VERSION_ERROR - 100802 - 协议版本错误 * - TRANSPORTATION_PROTOCOL_STRING_INVALID - 100804 - 协议字符串无效 * - TRANSPORTATION_ENCODE_BASE_ERROR - 100807 - Encode基本未知异常 * - PRESISTENCE_DATA_KEY_INVALID - 100901 - id无效 * - UNKNOW_ERROR - 160003 - 未知异常 * - BASE_ERROR - 160007 - weId基础未知异常 * - DATA_TYPE_CASE_ERROR - 160008 - 数据转换异常 * - DIRECT_ROUTE_REQUEST_TIMEOUT - 160009 - AMOP超时 * - DIRECT_ROUTE_MSG_BASE_ERROR - 160010 - AMOP异常 * - SQL_EXECUTE_FAILED - 160011 - SQL执行异常 * - SQL_GET_CONNECTION_ERROR - 160013 - 获取数据源连接异常 **调用示例** .. code-block:: java String weId = "did:weid:1000:0x0106595955ce4713fd169bfa68e599eb99ca2e9f"; List verifierWeIdList = new ArrayList(); verifierWeIdList.add(weId); String transString=""; WeIdAuthentication weIdAuthentication; //调用反序列化 ResponseData result1 = TransportationFactory .build(TransportationType.QR_CODE) .deserialize(weIdAuthentication, transString, PresentationE.class); **时序图** .. mermaid:: sequenceDiagram participant 调用者 participant QrCodeTransportation 调用者->>QrCodeTransportation: 调用deserialize() QrCodeTransportation->>QrCodeTransportation: 入参非空、格式及合法性检查 opt 入参校验失败 QrCodeTransportation-->>调用者: 报错，提示参数不合法并退出 end QrCodeTransportation->>QrCodeTransportation: 解析协议，判断是采用加密方式还是非加密方式 opt 非加密方式 QrCodeTransportation->>DataToolUtils: 调用deserialize方法将协议里的presentation反序列化为对象 DataToolUtils-->>QrCodeTransportation: 返回PresentationE对象 end opt 加密方式 QrCodeTransportation->>EncodeProcessor: 调用decode方法 EncodeProcessor->>User Agent: 发送AMOP请求，获取对称加密秘钥 User Agent-->>EncodeProcessor: 返回加密秘钥 EncodeProcessor->>EncodeProcessor: 解密协议数据 EncodeProcessor-->>QrCodeTransportation: 返回解密后的presentation数据 QrCodeTransportation->>DataToolUtils: 调用deserialize方法将协议里的presentation反序列化 DataToolUtils-->>QrCodeTransportation: 返回PresentationE对象presentation反序列化为对象 end QrCodeTransportation-->>调用者: 返回成功 ---- BarCodeTransportation ^^^^^^^^^^^^^^^^^ 1. specify ~~~~~~~~~~~~~~~~~~~ **基本信息** .. code-block:: text 接口名称: com.webank.weid.suite.api.transportation.inf.Transportation.specify 接口定义: Transportation specify(List verifierWeIdList) 接口描述: 指定transportation的认证者,用于权限控制。 **接口入参**\ : java.util.List .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - verifierWeIdList - List - N - verifierWeId列表 - **接口返回**\ : com.webank.weid.suite.api.transportation.inf.JsonTransportation; **调用示例** .. code-block:: java Transportation transportation =TransportationFactory.build(TransportationType.QR_CODE); String weId = "did:weid:1000:0x0106595955ce4713fd169bfa68e599eb99ca2e9f"; List verifierWeIdList = new ArrayList(); verifierWeIdList.add(weId); transportation = transportation.specify(verifierWeIdList); **时序图** .. mermaid:: sequenceDiagram participant 调用者 participant Transportation participant WeIdService participant 区块链 调用者->>Transportation: 调用specify() Transportation->>Transportation: 入参非空、格式及合法性检查 opt 入参校验失败 Transportation-->>调用者: 报错，提示参数不合法并退出 end loop 遍历每个WeID Transportation->>WeIdService: 判断WeID的合法性，以及存在性，调用isWeIdExist()方法 WeIdService->>区块链: 查询该WeID是否存在 区块链-->>WeIdService: 返回查询结果 WeIdService-->>Transportation: 返回查询结果 opt WeID不存在 Transportation-->>调用者: 报错，提示WeID不存在 end Transportation->>Transportation: 放入verifier list里 end Transportation-->>调用者: 返回成功 ---- 2. serialize ~~~~~~~~~~~~~~~~~~~ **基本信息** .. code-block:: text 接口名称: com.webank.weid.suite.api.transportation.inf.Transportation.serialize 接口定义: ResponseData serialize(WeIdAuthentication weIdAuthentication, T object,ProtocolProperty property) 接口描述: 用于序列化对象,要求对象实现JsonSerializer接口，接口将资源数据存入数据库，然后通过资源Id来进行关联，并将资源Id编入协议字符串中 **接口入参**\ : .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - weIdAuthentication - WeIdAuthentication - Y - 调用者身份信息 - * - object - - Y - 待序列化对象 - * - property - ProtocolProperty - Y - 协议配置 - **接口返回**\ : com.webank.weid.protocol.response.ResponseData\; .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - kitErrorCode - Integer - 返回结果码 - * - errorMessage - String - 返回结果描述 - * - result - String - 序列化后的字符串数据 - 业务数据 **此方法返回code** .. list-table:: :header-rows: 1 * - enum - code - desc * - SUCCESS - 0 - 成功 * - TRANSPORTATION_PROTOCOL_PROPERTY_ERROR - 100801 - 协议配置异常 * - TRANSPORTATION_PROTOCOL_ENCODE_ERROR - 100803 - 协议配置Encode异常 * - TRANSPORTATION_PROTOCOL_DATA_INVALID - 100805 - 协议数据无效 * - TRANSPORTATION_ENCODE_BASE_ERROR - 100807 - Encode基本未知异常 * - PRESISTENCE_DATA_KEY_INVALID - 100901 - id无效 * - UNKNOW_ERROR - 160003 - 未知异常 * - BASE_ERROR - 160007 - weId基础未知异常 * - SQL_EXECUTE_FAILED - 160011 - SQL执行异常 * - SQL_GET_CONNECTION_ERROR - 160013 - 获取数据源连接异常 **调用示例** .. code-block:: java String weId = "did:weid:1000:0x0106595955ce4713fd169bfa68e599eb99ca2e9f"; List verifierWeIdList = new ArrayList(); verifierWeIdList.add(weId); PresentationE presentation; //下载模式 //原文方式调用 ResponseData result3 = TransportationFactory .build(TransportationType.QR_CODE) .specify(verifierWeIdList) .serialize(presentation,new ProtocolProperty(EncodeType.ORIGINA)); //密文方式调用 ResponseData result4 = TransportationFactory .build(TransportationType.QR_CODE) .specify(verifierWeIdList) .serialize(presentation,new ProtocolProperty(EncodeType.CIPHER)); **时序图** .. mermaid:: sequenceDiagram participant 调用者 participant Transportation 调用者->>Transportation: 调用serialize() Transportation->>Transportation: 入参非空、格式及合法性检查 opt 入参校验失败 Transportation-->>调用者: 报错，提示参数不合法并退出 end Transportation->>Transportation: 拼装协议头数据 Transportation->>Transportation: 判断是采用加密方式还是非加密方式 opt 非加密方式 Transportation->>Transportation: 将presentation原文放入协议里 end opt 加密方式 Transportation->>EncodeProcessor: 调用encode方法 EncodeProcessor->>EncodeProcessor: 采用AES算法，生成对称加密秘钥 EncodeProcessor->>persistence: 保存至存储库里 persistence-->>EncodeProcessor: 返回 EncodeProcessor-->>Transportation: 返回加密之后的presentation数据 Transportation->>Transportation: 将presentation密文放入协议里 end Transportation-->>调用者: 返回QRCode协议数据 ---- 3. deserialize ~~~~~~~~~~~~~~~~~~~ **基本信息** .. code-block:: text 接口名称: com.webank.weid.suite.api.transportation.inf.Transportation.deserialize 接口定义: ResponseData deserialize(WeIdAuthentication weIdAuthentication, String transString,Class clazz) 接口描述: 用于反序列化对象,要求目标对象实现JsonSerializer接口。 **接口入参**\ : .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - weIdAuthentication - WeIdAuthentication - Y - 调用者身份信息 - * - transString - String - Y - 待序列化对象 - * - clazz - Class - Y - 目标类型 - **接口返回**\ : com.webank.weid.protocol.response.ResponseData\; .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - kitErrorCode - Integer - 返回结果码 - * - errorMessage - String - 返回结果描述 - * - result - - 反序列化后的对象 - 业务数据 **此方法返回code** .. list-table:: :header-rows: 1 * - enum - code - desc * - SUCCESS - 0 - 成功 * - ENCRYPT_KEY_NOT_EXISTS - 100700 - 无法获取秘钥 * - TRANSPORTATION_PROTOCOL_VERSION_ERROR - 100802 - 协议版本错误 * - TRANSPORTATION_PROTOCOL_STRING_INVALID - 100804 - 协议字符串无效 * - TRANSPORTATION_ENCODE_BASE_ERROR - 100807 - Encode基本未知异常 * - PRESISTENCE_DATA_KEY_INVALID - 100901 - id无效 * - UNKNOW_ERROR - 160003 - 未知异常 * - BASE_ERROR - 160007 - weId基础未知异常 * - DATA_TYPE_CASE_ERROR - 160008 - 数据转换异常 * - DIRECT_ROUTE_REQUEST_TIMEOUT - 160009 - AMOP超时 * - DIRECT_ROUTE_MSG_BASE_ERROR - 160010 - AMOP异常 * - SQL_EXECUTE_FAILED - 160011 - SQL执行异常 * - SQL_GET_CONNECTION_ERROR - 160013 - 获取数据源连接异常 **调用示例** .. code-block:: java String weId = "did:weid:1000:0x0106595955ce4713fd169bfa68e599eb99ca2e9f"; List verifierWeIdList = new ArrayList(); verifierWeIdList.add(weId); String transString=""; WeIdAuthentication weIdAuthentication; //调用反序列化 ResponseData result1 = TransportationFactory .build(TransportationType.BAR_CODE) .deserialize(weIdAuthentication, transString, PresentationE.class); ---- PdfTransportation ^^^^^^^^^^^^^^^^^ 1. specify ~~~~~~~~~~~~~~~~~~~ **基本信息** .. code-block:: text 接口名称: com.webank.weid.suite.api.transportation.inf.PdfTransportation.specify 接口定义: PdfTransportation specify(List verifierWeIdList) 接口描述: 指定transportation的认证者,用于权限控制。 **接口入参**\ : java.util.List .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - verifierWeIdList - List - N - verifierWeId列表 - **接口返回**\ : com.webank.weid.suite.api.transportation.inf.PdfTransportation; **调用示例** .. code-block:: java PPdfTransportation pdfTransportation = TransportationFactory.newPdfTransportation(); String weId = "did:weid:1000:0x0106595955ce4713fd169bfa68e599eb99ca2e9f"; List verifierWeIdList = new ArrayList(); verifierWeIdList.add(weId); pdfTransportation = PdfTransportation.specify(verifierWeIdList); ---- 2. serialize ~~~~~~~~~~~~~~~~~~~ **基本信息** .. code-block:: text 接口名称: com.webank.weid.suite.api.transportation.inf.PdfTransportation.serialize 接口定义: ResponseData serialize(T object, ProtocolProperty property, WeIdAuthentication weIdAuthentication); 接口描述: 用于序列化对象,要求对象实现JsonSerializer接口 **接口入参**\ : .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - object - - Y - 待序列化对象 - * - property - ProtocolProperty - Y - 协议配置 - * - weIdAuthentication - WeIdAuthentication - Y - WeID公私钥信息 - **接口返回**\ : com.webank.weid.protocol.response.ResponseData\; .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - kitErrorCode - Integer - 返回结果码 - * - errorMessage - String - 返回结果描述 - * - result - byte[] - 序列化后PDF文件的byte数组 - 业务数据 **此方法返回code** .. list-table:: :header-rows: 1 * - enum - code - desc * - SUCCESS - 0 - 成功 * - CREDENTIAL_ISSUER_MISMATCH - 100403 - issuerWeId跟Credential中的issuer不匹配 * - CREDENTIAL_EVIDENCE_SIGNATURE_BROKEN - 100431 - 存证签名异常 * - CREDENTIAL_EVIDENCE_BASE_ERROR - 100500 - Evidence标准错误 * - CREDENTIAL_EVIDENCE_HASH_MISMATCH - 100501 - Evidence Hash不匹配 * - TRANSPORTATION_BASE_ERROR - 100800 - transportation基本未知异常 * - TRANSPORTATION_PROTOCOL_PROPERTY_ERROR - 100801 - 协议配置异常 * - TRANSPORTATION_PROTOCOL_ENCODE_ERROR - 100803 - 协议配置Encode异常 * - TRANSPORTATION_ENCODE_BASE_ERROR - 100807 - Encode基本未知异常 * - TRANSPORTATION_PDF_TRANSFER_ERROR - 100808 - Pdf转换异常 * - WEID_AUTHORITY_INVALID - 100109 - 授权信息无效 * - WEID_PRIVATEKEY_DOES_NOT_MATCH - 100106 - 私钥与WeIdentity DID不匹配 * - WEID_DOES_NOT_EXIST - 100104 - WeIdentity DID不存在 * - PRESISTENCE_DATA_KEY_INVALID - 100901 - dataKey无效 * - DATA_TYPE_CASE_ERROR - 160008 - 数据转换异常 * - SQL_EXECUTE_FAILED - 160011 - SQL执行异常 * - SQL_GET_CONNECTION_ERROR - 160013 - 获取数据源连接异常 **调用示例** .. code-block:: java String weId = "did:weid:1000:0x0106595955ce4713fd169bfa68e599eb99ca2e9f"; List verifierWeIdList = new ArrayList(); verifierWeIdList.add(weId); PresentationE presentation; WeIdAuthentication weIdAuthentication = new WeIdAuthentication();; //原文方式调用 ResponseData result1 = TransportationFactory .newPdfTransportation() .specify(verifierWeIdList) .serialize(presentation,new ProtocolProperty(EncodeType.ORIGINAL),weIdAuthentication); //密文方式调用 ResponseData result2 = TransportationFactory .newPdfTransportation() .specify(verifierWeIdList) .serialize(presentation,new ProtocolProperty(EncodeType.CIPHER),weIdAuthentication); ---- 3. serialize ~~~~~~~~~~~~~~~~~~~ **基本信息** .. code-block:: text 接口名称: com.webank.weid.suite.api.transportation.inf.PdfTransportation.serialize 接口定义: ResponseData serialize(T object, ProtocolProperty property, WeIdAuthentication weIdAuthentication,String outputPdfFilePath); 接口描述: 用于序列化对象并输出PDF文件,要求对象实现JsonSerializer接口 **接口入参**\ : .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - object - - Y - 待序列化对象 - * - property - ProtocolProperty - Y - 协议配置 - * - weIdAuthentication - WeIdAuthentication - Y - WeID公私钥信息 - * - outputPdfFilePath - String - Y - 输出文件的路径 - **接口返回**\ : com.webank.weid.protocol.response.ResponseData\; .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - kitErrorCode - Integer - 返回结果码 - * - errorMessage - String - 返回结果描述 - * - result - Boolean - 序列化生成文件的结果 - **此方法返回code** .. list-table:: :header-rows: 1 * - enum - code - desc * - SUCCESS - 0 - 成功 * - CREDENTIAL_ISSUER_MISMATCH - 100403 - issuerWeId跟Credential中的issuer不匹配 * - CREDENTIAL_EVIDENCE_SIGNATURE_BROKEN - 100431 - 存证签名异常 * - CREDENTIAL_EVIDENCE_BASE_ERROR - 100500 - Evidence标准错误 * - CREDENTIAL_EVIDENCE_HASH_MISMATCH - 100501 - Evidence Hash不匹配 * - TRANSPORTATION_BASE_ERROR - 100800 - transportation基本未知异常 * - TRANSPORTATION_PROTOCOL_PROPERTY_ERROR - 100801 - 协议配置异常 * - TRANSPORTATION_PROTOCOL_ENCODE_ERROR - 100803 - 协议配置Encode异常 * - TRANSPORTATION_ENCODE_BASE_ERROR - 100807 - Encode基本未知异常 * - TRANSPORTATION_PDF_TRANSFER_ERROR - 100808 - Pdf转换异常 * - WEID_AUTHORITY_INVALID - 100109 - 授权信息无效 * - WEID_PRIVATEKEY_DOES_NOT_MATCH - 100106 - 私钥与WeIdentity DID不匹配 * - WEID_DOES_NOT_EXIST - 100104 - WeIdentity DID不存在 * - PRESISTENCE_DATA_KEY_INVALID - 100901 - dataKey无效 * - ILLEGAL_INPUT - 160004 - 参数非法 * - DATA_TYPE_CASE_ERROR - 160008 - 数据转换异常 * - SQL_EXECUTE_FAILED - 160011 - SQL执行异常 * - SQL_GET_CONNECTION_ERROR - 160013 - 获取数据源连接异常 **调用示例** .. code-block:: java String weId = "did:weid:1000:0x0106595955ce4713fd169bfa68e599eb99ca2e9f"; List verifierWeIdList = new ArrayList(); verifierWeIdList.add(weId); PresentationE presentation; WeIdAuthentication weIdAuthentication = new WeIdAuthentication();; //原文方式调用 ResponseData result1 = TransportationFactory .newPdfTransportation() .specify(verifierWeIdList) .serialize(presentation,new ProtocolProperty(EncodeType.ORIGINAL),weIdAuthentication,"./"); //密文方式调用 ResponseData result2 = TransportationFactory .newPdfTransportation() .specify(verifierWeIdList) .serialize(presentation,new ProtocolProperty(EncodeType.CIPHER),weIdAuthentication,"./"); ---- 4. serializeWithTemplate ~~~~~~~~~~~~~~~~~~~ **基本信息** .. code-block:: text 接口名称: com.webank.weid.suite.api.transportation.inf.PdfTransportation.serializeWithTemplate 接口定义: ResponseData serializeWithTemplate(T object, ProtocolProperty property, WeIdAuthentication weIdAuthentication,String inputPdfTemplatePath); 接口描述: 用于序列化对象,要求对象实现JsonSerializer接口 **接口入参**\ : .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - object - - Y - 待序列化对象 - * - property - ProtocolProperty - Y - 协议配置 - * - weIdAuthentication - WeIdAuthentication - Y - WeID公私钥信息 - * - inputPdfTemplatePath - String - Y - 指定模板位置 - **接口返回**\ : com.webank.weid.protocol.response.ResponseData\; .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - kitErrorCode - Integer - 返回结果码 - * - errorMessage - String - 返回结果描述 - * - result - byte[] - 序列化后PDF文件的byte数组 - 业务数据 **此方法返回code** .. list-table:: :header-rows: 1 * - enum - code - desc * - SUCCESS - 0 - 成功 * - CREDENTIAL_ISSUER_MISMATCH - 100403 - issuerWeId跟Credential中的issuer不匹配 * - CREDENTIAL_EVIDENCE_SIGNATURE_BROKEN - 100431 - 存证签名异常 * - CREDENTIAL_EVIDENCE_BASE_ERROR - 100500 - Evidence标准错误 * - CREDENTIAL_EVIDENCE_HASH_MISMATCH - 100501 - Evidence Hash不匹配 * - TRANSPORTATION_BASE_ERROR - 100800 - transportation基本未知异常 * - TRANSPORTATION_PROTOCOL_PROPERTY_ERROR - 100801 - 协议配置异常 * - TRANSPORTATION_PROTOCOL_ENCODE_ERROR - 100803 - 协议配置Encode异常 * - TRANSPORTATION_ENCODE_BASE_ERROR - 100807 - Encode基本未知异常 * - TRANSPORTATION_PDF_TRANSFER_ERROR - 100808 - Pdf转换异常 * - WEID_AUTHORITY_INVALID - 100109 - 授权信息无效 * - WEID_PRIVATEKEY_DOES_NOT_MATCH - 100106 - 私钥与WeIdentity DID不匹配 * - WEID_DOES_NOT_EXIST - 100104 - WeIdentity DID不存在 * - PRESISTENCE_DATA_KEY_INVALID - 100901 - dataKey无效 * - ILLEGAL_INPUT - 160004 - 参数非法 * - DATA_TYPE_CASE_ERROR - 160008 - 数据转换异常 * - SQL_EXECUTE_FAILED - 160011 - SQL执行异常 * - SQL_GET_CONNECTION_ERROR - 160013 - 获取数据源连接异常 **调用示例** .. code-block:: java String weId = "did:weid:1000:0x0106595955ce4713fd169bfa68e599eb99ca2e9f"; List verifierWeIdList = new ArrayList(); verifierWeIdList.add(weId); PresentationE presentation; WeIdAuthentication weIdAuthentication = new WeIdAuthentication(); //原文方式调用 ResponseData result1 = TransportationFactory .newPdfTransportation() .specify(verifierWeIdList) .serializeWithTemplate( presentation, new ProtocolProperty(EncodeType.ORIGINAL), weIdAuthentication, "./test-template.pdf"); //密文方式调用 ResponseData result2 = TransportationFactory .newPdfTransportation() .specify(verifierWeIdList) .serializeWithTemplate( presentation, new ProtocolProperty(EncodeType.CIPHER), weIdAuthentication, "./test-template.pdf"); ---- 5. serializeWithTemplate ~~~~~~~~~~~~~~~~~~~ **基本信息** .. code-block:: text 接口名称: com.webank.weid.suite.api.transportation.inf.PdfTransportation.serializeWithTemplate 接口定义: ResponseData serializeWithTemplate(T object, ProtocolProperty property, WeIdAuthentication weIdAuthentication,String inputPdfTemplatePath,String outputPdfFilePath); 接口描述: 用于序列化对象,要求对象实现JsonSerializer接口 **接口入参**\ : .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - object - - Y - 待序列化对象 - * - property - ProtocolProperty - Y - 协议配置 - * - weIdAuthentication - WeIdAuthentication - Y - WeID公私钥信息 - * - inputPdfTemplatePath - String - Y - 指定模板位置 - * - outputPdfFilePath - String - Y - 输出PDF文件位置 - **接口返回**\ : com.webank.weid.protocol.response.ResponseData\; .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - kitErrorCode - Integer - 返回结果码 - * - errorMessage - String - 返回结果描述 - * - result - Boolean - 序列化生成文件的结果 - **此方法返回code** .. list-table:: :header-rows: 1 * - enum - code - desc * - SUCCESS - 0 - 成功 * - CREDENTIAL_ISSUER_MISMATCH - 100403 - issuerWeId跟Credential中的issuer不匹配 * - CREDENTIAL_EVIDENCE_SIGNATURE_BROKEN - 100431 - 存证签名异常 * - CREDENTIAL_EVIDENCE_BASE_ERROR - 100500 - Evidence标准错误 * - CREDENTIAL_EVIDENCE_HASH_MISMATCH - 100501 - Evidence Hash不匹配 * - TRANSPORTATION_BASE_ERROR - 100800 - transportation基本未知异常 * - TRANSPORTATION_PROTOCOL_PROPERTY_ERROR - 100801 - 协议配置异常 * - TRANSPORTATION_PROTOCOL_ENCODE_ERROR - 100803 - 协议配置Encode异常 * - TRANSPORTATION_ENCODE_BASE_ERROR - 100807 - Encode基本未知异常 * - TRANSPORTATION_PDF_TRANSFER_ERROR - 100808 - Pdf转换异常 * - WEID_AUTHORITY_INVALID - 100109 - 授权信息无效 * - WEID_PRIVATEKEY_DOES_NOT_MATCH - 100106 - 私钥与WeIdentity DID不匹配 * - WEID_DOES_NOT_EXIST - 100104 - WeIdentity DID不存在 * - PRESISTENCE_DATA_KEY_INVALID - 100901 - dataKey无效 * - ILLEGAL_INPUT - 160004 - 参数非法 * - DATA_TYPE_CASE_ERROR - 160008 - 数据转换异常 * - SQL_EXECUTE_FAILED - 160011 - SQL执行异常 * - SQL_GET_CONNECTION_ERROR - 160013 - 获取数据源连接异常 **调用示例** .. code-block:: java String weId = "did:weid:1000:0x0106595955ce4713fd169bfa68e599eb99ca2e9f"; List verifierWeIdList = new ArrayList(); verifierWeIdList.add(weId); PresentationE presentation; WeIdAuthentication weIdAuthentication = new WeIdAuthentication(); //原文方式调用 ResponseData result1 = TransportationFactory .newPdfTransportation() .specify(verifierWeIdList) .serializeWithTemplate( presentation, new ProtocolProperty(EncodeType.ORIGINAL), weIdAuthentication, "./test-template.pdf", "./"); //密文方式调用 ResponseData result2 = TransportationFactory .newPdfTransportation() .specify(verifierWeIdList) .serializeWithTemplate( presentation, new ProtocolProperty(EncodeType.CIPHER), weIdAuthentication, "./test-template.pdf", "./"); ---- 6. deserialize ~~~~~~~~~~~~~~~~~~~ **基本信息** .. code-block:: text 接口名称: com.webank.weid.suite.api.transportation.inf.PdfTransportation.deserialize 接口定义: ResponseData deserialize(byte[] pdfTransportation, Class clazz, WeIdAuthentication weIdAuthentication); 接口描述: 用于反序列化对象,要求目标对象实现JsonSerializer接口。 **接口入参**\ : .. list-table:: :header-rows: 1 * - 名称 - 类型 - 非空 - 说明 - 备注 * - pdfTransportation - byte[ ] - Y - 待反序列化的包含PDF信息的byte数组 - * - clazz - Class - Y - 目标类型 - * - weIdAuthentication - WeIdAuthentication - Y - WeID公私钥信息 - **接口返回**\ : com.webank.weid.protocol.response.ResponseData\; .. list-table:: :header-rows: 1 * - 名称 - 类型 - 说明 - 备注 * - kitErrorCode - Integer - 返回结果码 - * - errorMessage - String - 返回结果描述 - * - result - - 反序列化后的对象 - 业务数据 **此方法返回code** .. list-table:: :header-rows: 1 * - enum - code - desc * - SUCCESS - 0 - 成功 * - ENCRYPT_KEY_NOT_EXISTS - 100700 - 无法获取秘钥 * - TRANSPORTATION_BASE_ERROR - 100800 - transportation基本未知异常 * - TRANSPORTATION_PROTOCOL_VERSION_ERROR - 100802 - 协议版本错误 * - TRANSPORTATION_PROTOCOL_ENCODE_ERROR - 100803 - 协议配置Encode异常 * - TRANSPORTATION_PROTOCOL_DATA_INVALID - 100805 - 协议数据无效 * - TRANSPORTATION_ENCODE_BASE_ERROR - 100807 - Encode基本未知异常 * - PRESISTENCE_DATA_KEY_INVALID - 100901 - dataKey无效 * - UNKNOW_ERROR - 160003 - 未知异常 * - BASE_ERROR - 160007 - weId基础未知异常 * - DATA_TYPE_CASE_ERROR - 160008 - 数据转换异常 * - DIRECT_ROUTE_REQUEST_TIMEOUT - 160009 - AMOP超时 * - DIRECT_ROUTE_MSG_BASE_ERROR - 160010 - AMOP异常 * - SQL_EXECUTE_FAILED - 160011 - SQL执行异常 * - SQL_GET_CONNECTION_ERROR - 160013 - 获取数据源连接异常 **调用示例** .. code-block:: java String weId = "did:weid:1000:0x0106595955ce4713fd169bfa68e599eb99ca2e9f"; List verifierWeIdList = new ArrayList(); verifierWeIdList.add(weId); PresentationE presentation; WeIdAuthentication weIdAuthentication = new WeIdAuthentication(); //序列化 ResponseData result = TransportationFactory .newPdfTransportation() .specify(verifierWeIdList) .serialize(presentation,new ProtocolProperty(EncodeType.ORIGINAL),weIdAuthentication); //序列化 ResponseData result1 = TransportationFactory .newPdfTransportation() .specify(verifierWeIdList) .serialize(presentation,new ProtocolProperty(EncodeType.CIPHER),weIdAuthentication); //原文方式调用反序列化 ResponseData resDeserialize = TransportationFactory .newPdfTransportation() .deserialize(response.getResult(),PresentationE.class,weIdAuthentication); //密文方式调用反序列化 ResponseData resDeserialize1 = TransportationFactory .newJsonTransportation() .deserialize(response1.getResult(),PresentationE.class,weIdAuthentication); ----