KaTool-Security
Home
GetStart
  • AuthCenter
  • 适配SpringCloudGateWay
  • 适配Zuul
  • 网关中间件更换适配方案
  • 插件化鉴权
  • 注解文档
  • Restful响应文档
  • 内部方法文档
  • Auth中心RPC调用接口文档
  • 1.1.0.RELEASE之前
  • 1.1.0.RELEASE新概念
  • 参与贡献
  • 未来规划
  • KaTool
  • KaToolTest
  • 在github上修改本页面
  • Karos'Blog
Home
GetStart
  • AuthCenter
  • 适配SpringCloudGateWay
  • 适配Zuul
  • 网关中间件更换适配方案
  • 插件化鉴权
  • 注解文档
  • Restful响应文档
  • 内部方法文档
  • Auth中心RPC调用接口文档
  • 1.1.0.RELEASE之前
  • 1.1.0.RELEASE新概念
  • 参与贡献
  • 未来规划
  • KaTool
  • KaToolTest
  • 在github上修改本页面
  • Karos'Blog
  • 返回信息文档

返回信息文档

KaSecurityValidMessage

概述

KaSecurityValidMessage 是一个用于定义安全验证消息的Java类。该类包含了常见的安全验证结果及对应的消息,以及一些静态方法用于获取特定结果的实例。

类定义

@Data
@Builder(toBuilder = true)
@EqualsAndHashCode(callSuper = false)
@NoArgsConstructor
@AllArgsConstructor
@Accessors(chain = true)
public class KaSecurityValidMessage {
    // ... (类定义,包括静态常量、属性、构造方法等)

    Integer code;
    String message;

    // ... (静态方法,用于获取特定结果的实例)
}

静态常量

  • SUNKNOW_CODE: 表示成功的代码。
  • UNAUTH_CODE: 表示未授权的代码。
  • UNLOGIN_CODE: 表示未登录的代码。
  • UNKNOW_CODE: 表示未知错误的代码。

静态实例

  • SUCCESS_MESSAGE: 表示成功的消息实例。
  • INLOGIN_MESSAGE: 表示仅检查登录的消息实例。
  • NOAUTH_MESSAGE: 表示未授权的消息实例。
  • UNLOGIN_MESSAGE: 表示未登录的消息实例。
  • UNKNOW_MESSAGE: 表示未知错误的消息实例。

静态方法

success()

用于获取成功的消息实例。

public static KaSecurityValidMessage success(){
    return  SUCCESS_MESSAGE;
}

onlyLogin()

用于获取仅检查登录的消息实例。

public static KaSecurityValidMessage onlyLogin(){
    return INLOGIN_MESSAGE;
}

noAuth()

用于获取未授权的消息实例。

public static KaSecurityValidMessage noAuth(){
    return  NOAUTH_MESSAGE;
}

unLogin()

用于获取未登录的消息实例。

public static KaSecurityValidMessage unLogin(){
    return  UNLOGIN_MESSAGE;
}

unKnow()

用于获取未知错误的消息实例。

public static KaSecurityValidMessage unKnow(){
    return  UNKNOW_MESSAGE;
}

使用示例

// 获取成功的消息实例
KaSecurityValidMessage successMessage = KaSecurityValidMessage.success();

// 获取未登录的消息实例
KaSecurityValidMessage unLoginMessage = KaSecurityValidMessage.unLogin();

// 获取未知错误的消息实例
KaSecurityValidMessage unknowErrorMessage = KaSecurityValidMessage.unKnow();

以上示例展示了如何使用 KaSecurityValidMessage 类的静态方法获取特定消息实例。可以根据实际需要选择相应的实例,以便在应用中进行安全验证。

同时您可以通过Setter来进行自定义返回消息

Last Updated:
Contributors: ZonglinWu