程序包 com.alibaba.nacos.plugin.auth.impl.controller

类 UserController

  • @RestController("user")
@RequestMapping({"/v1/auth","/v1/auth/users"})
public class UserController
extends java.lang.Object
    User related methods entry.
    作者:
    wfnuser, nkorange

    • 方法概要

      所有方法 实例方法 具体方法 已过时的方法 
      修饰符和类型 方法 说明
      java.lang.Object createUser​(java.lang.String username, java.lang.String password)
      Create a new user.
      java.lang.Object deleteUser​(java.lang.String username)
      Delete an existed user.
      com.alibaba.nacos.config.server.model.Page<User> fuzzySearchUser​(int pageNo, int pageSize, java.lang.String username)  
      com.alibaba.nacos.config.server.model.Page<User> getUsers​(int pageNo, int pageSize, java.lang.String username)
      Get paged users.
      private boolean hasPermission​(java.lang.String username, javax.servlet.http.HttpServletRequest request)  
      java.lang.Object login​(java.lang.String username, java.lang.String password, javax.servlet.http.HttpServletResponse response, javax.servlet.http.HttpServletRequest request)
      Login to Nacos
      java.util.List<java.lang.String> searchUsersLikeUsername​(java.lang.String username)
      Fuzzy matching username.
      com.alibaba.nacos.common.model.RestResult<java.lang.String> updatePassword​(java.lang.String oldPassword, java.lang.String newPassword)
      已过时。
      java.lang.Object updateUser​(java.lang.String username, java.lang.String newPassword, javax.servlet.http.HttpServletResponse response, javax.servlet.http.HttpServletRequest request)
      Update an user.

      • 从类继承的方法 java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • 字段详细资料

      • authenticationManager

        @Autowired
@Deprecated
private org.springframework.security.authentication.AuthenticationManager authenticationManager
        已过时。

      • authConfigs

        @Autowired
private com.alibaba.nacos.auth.config.AuthConfigs authConfigs

    • 构造器详细资料

      • UserController

        public UserController()

    • 方法详细资料

      • createUser

        @PostMapping
public java.lang.Object createUser​(@RequestParam
                                   java.lang.String username,
                                   @RequestParam
                                   java.lang.String password)
        Create a new user.
        参数:
        username - username
        password - password
        返回:
        ok if create succeed
        抛出:
        java.lang.IllegalArgumentException - if user already exist
        从以下版本开始:
        1.2.0

      • deleteUser

        @DeleteMapping
public java.lang.Object deleteUser​(@RequestParam
                                   java.lang.String username)
        Delete an existed user.
        参数:
        username - username of user
        返回:
        ok if deleted succeed, keep silent if user not exist
        从以下版本开始:
        1.2.0

      • updateUser

        @PutMapping
public java.lang.Object updateUser​(@RequestParam
                                   java.lang.String username,
                                   @RequestParam
                                   java.lang.String newPassword,
                                   javax.servlet.http.HttpServletResponse response,
                                   javax.servlet.http.HttpServletRequest request)
                            throws java.io.IOException
        Update an user.
        参数:
        username - username of user
        newPassword - new password of user
        response - http response
        request - http request
        返回:
        ok if update succeed
        抛出:
        java.lang.IllegalArgumentException - if user not exist or oldPassword is incorrect
        java.io.IOException
        从以下版本开始:
        1.2.0

      • hasPermission

        private boolean hasPermission​(java.lang.String username,
                              javax.servlet.http.HttpServletRequest request)
                       throws org.springframework.web.HttpSessionRequiredException
        抛出:
        org.springframework.web.HttpSessionRequiredException

      • getUsers

        @GetMapping(params="search=accurate")
public com.alibaba.nacos.config.server.model.Page<User> getUsers​(@RequestParam
                                                                 int pageNo,
                                                                 @RequestParam
                                                                 int pageSize,
                                                                 @RequestParam(name="username",required=false,defaultValue="")
                                                                 java.lang.String username)
        Get paged users.
        参数:
        pageNo - number index of page
        pageSize - size of page
        返回:
        A collection of users, empty set if no user is found
        从以下版本开始:
        1.2.0

      • fuzzySearchUser

        @GetMapping(params="search=blur")
public com.alibaba.nacos.config.server.model.Page<User> fuzzySearchUser​(@RequestParam
                                                                        int pageNo,
                                                                        @RequestParam
                                                                        int pageSize,
                                                                        @RequestParam(name="username",required=false,defaultValue="")
                                                                        java.lang.String username)

      • login

        @PostMapping("/login")
public java.lang.Object login​(@RequestParam
                              java.lang.String username,
                              @RequestParam
                              java.lang.String password,
                              javax.servlet.http.HttpServletResponse response,
                              javax.servlet.http.HttpServletRequest request)
                       throws com.alibaba.nacos.plugin.auth.exception.AccessException
        Login to Nacos

        This methods uses username and password to require a new token.

        参数:
        username - username of user
        password - password
        response - http response
        request - http request
        返回:
        new token of the user
        抛出:
        com.alibaba.nacos.plugin.auth.exception.AccessException - if user info is incorrect

      • updatePassword

        @PutMapping("/password")
@Deprecated
public com.alibaba.nacos.common.model.RestResult<java.lang.String> updatePassword​(@RequestParam("oldPassword")
                                                                                  java.lang.String oldPassword,
                                                                                  @RequestParam("newPassword")
                                                                                  java.lang.String newPassword)
        已过时。
        Update password.
        参数:
        oldPassword - old password
        newPassword - new password
        返回:
        Code 200 if update successfully, Code 401 if old password invalid, otherwise 500

      • searchUsersLikeUsername

        @GetMapping("/search")
public java.util.List<java.lang.String> searchUsersLikeUsername​(@RequestParam
                                                                java.lang.String username)
        Fuzzy matching username.
        参数:
        username - username
        返回:
        Matched username