PasswordResource (ctp-common 7.0SP2-SNAPSHOT API)

java.lang.Object
- com.seeyon.ctp.rest.resources.BaseResource
- - com.seeyon.ctp.rest.resources.PasswordResource

@Path(value="password")
 @Consumes(value={"application/json","application/xml"})
 @Produces(value="application/json")
public class PasswordResource
extends BaseResource

用于移动端找回密码。目前默认方式是按照邮箱找回方式，后续根据需求再扩展（如短信找回）

作者:: wf

构造器概要

构造器
构造器和说明

PasswordResource()

构造器
构造器和说明
`PasswordResource()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`javax.ws.rs.core.Response`	`canUseEmail()` 方式：get 是否可以使用邮箱找回密码。
`javax.ws.rs.core.Response`	`checkVerificationCode(String loginName, String verificationCode, String type, String token)` 校验验证码方式：get url: http://localhost/seeyon/rest/password/retrieve/checkVerificationCode/bj01/332372?
`javax.ws.rs.core.Response`	`getEmailByLoginName(String loginName)` 方式：get 根据登录名获取人员的邮箱 URl: http://[ip:port]/seeyon/rest/password/retrieve/getEmailByLoginName/bj01
`javax.ws.rs.core.Response`	`resetPassword(Map<String,Object> params, String token)` 方式：post url:http://localhost/seeyon/rest/password/retrieve/resetPassword?
`javax.ws.rs.core.Response`	`send(String loginName, String type, String token)` 方式：get 校验并发送邮件 url:http://localhost/seeyon/rest/password/retrieve/send/bj01?

从类继承的方法 com.seeyon.ctp.rest.resources.BaseResource
copyProperties, decode, error, fail, fail, getFlipInfo, getObjectMapper, getToken, judgeSortId, noContent, ok, required, required, setCurrentUser, setPagination, status, status, success, success, success, toJSON, toJSON

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - PasswordResource
```
public PasswordResource()
```
- 方法详细资料
  - canUseEmail
```
@GET
 @Path(value="retrieve/canUseEmail")
public javax.ws.rs.core.Response canUseEmail()
                                                                                throws Exception
```
    方式：get 是否可以使用邮箱找回密码。用于移动端点击‘ 忘记密码 ’ 时的首次校验。 url: http://[ip:port]/seeyon/rest/password/retrieve/canUseEmail
    
    返回:
    
    返回成功： { "code" : 0, "data" : true, "message" : "系统邮箱可用!" } 返回失败 { "code" : 1, "data" : false, "message" : "系统邮箱不可用,请联系管理员配置!" }
    
    抛出:
    
    Exception
  - getEmailByLoginName
```
@GET
 @Path(value="retrieve/getEmailByLoginName/{loginName}")
public javax.ws.rs.core.Response getEmailByLoginName(@PathParam(value="loginName")
                                                                                                                   String loginName)
                                                                                                            throws Exception
```
    方式：get 根据登录名获取人员的邮箱 URl: http://[ip:port]/seeyon/rest/password/retrieve/getEmailByLoginName/bj01
    
    参数:
    
    loginName - 登录名
    
    返回:
    
    返回成功： { "code" : 0, "data" : "{\"email\":\"275132518@qq.com\",\"token\":\"4de88623-6664-494a-9140-acda19b107ba\"}", "message" : "邮箱获取成功!" } 返回失败： { "code" : 1001, "data" : "", "message" : "无效的登录名!" } { "code" : 1002, "data" : "", "message" : "未设置有效邮箱!" } { "code" : 1003, "data" : "275132518@qq.com", "message" : "未绑定有效邮箱!" }
    
    抛出:
    
    com.seeyon.ctp.common.exceptions.BusinessException
    
    Exception
  - send
```
@GET
 @Path(value="retrieve/send/{loginName}")
public javax.ws.rs.core.Response send(@PathParam(value="loginName")
                                                                                     String loginName,
                                                                                     @DefaultValue(value="email") @QueryParam(value="type")
                                                                                     String type,
                                                                                     @QueryParam(value="token")
                                                                                     String token)
                                                                              throws Exception
```
    方式：get 校验并发送邮件 url:http://localhost/seeyon/rest/password/retrieve/send/bj01?token=4de88623-6664-494a-9140-acda19b107ba
    
    参数:
    
    loginName - 登录名
    
    type - 发送方式：邮箱，短信。默认为邮箱
    
    token - 生成的临时token
    
    返回:
    
    返回成功： { "code" : 0, "data" : "275132518@qq.com", "message" : "邮箱校验成功并已发送邮件!" } 返回失败： { "code" : 1001, "data" : "275132518@qq.com", "message" : "无效的登录名!" } { "code" : 1002, "data" : "", "message" : "未设置有效邮箱!" } { "code" : 1003, "data" : "275132518@qq.com", "message" : "未绑定有效邮箱!" } { "code" : 1101, "data" : "275132518@qq.com", "message" : "邮件发送频率过高!" } { "code" : 1102, "data" : "275132518@qq.com", "message" : "邮件发送失败!" }
    
    抛出:
    
    com.seeyon.ctp.common.exceptions.BusinessException
    
    Exception
  - checkVerificationCode
```
@GET
 @Path(value="retrieve/checkVerificationCode/{loginName}/{verificationCode}")
public javax.ws.rs.core.Response checkVerificationCode(@PathParam(value="loginName")
                                                                                                                                          String loginName,
                                                                                                                                          @PathParam(value="verificationCode")
                                                                                                                                          String verificationCode,
                                                                                                                                          @DefaultValue(value="email") @QueryParam(value="type")
                                                                                                                                          String type,
                                                                                                                                          @QueryParam(value="token")
                                                                                                                                          String token)
                                                                                                                                   throws Exception
```
    校验验证码方式：get url: http://localhost/seeyon/rest/password/retrieve/checkVerificationCode/bj01/332372?token=4de88623-6664-494a-9140-acda19b107ba
    
    参数:
    
    loginName - 登录名
    
    verificationCode - 验证码
    
    type - 验证方式：邮箱，短信。默认为邮箱
    
    token - 生成的临时token
    
    返回:
    
    返回成功： { "code" : 0, "data" : "275132518@qq.com", "message" : "验证码验证成功!" } 返回失败： { "code" : 1001, "data" : "275132518@qq.com", "message" : "无效的登录名!" } { "code" : 1002, "data" : "", "message" : "未设置有效邮箱!" } { "code" : 1003, "data" : "275132518@qq.com", "message" : "未绑定有效邮箱!" } { "code" : 1201, "data" : "275132518@qq.com", "message" : "未接收到验证码!" } { "code" : 1202, "data" : "275132518@qq.com", "message" : "验证码已失效!" } { "code" : 1203, "data" : "275132518@qq.com", "message" : "验证码超过最大验证次数!" } { "code" : 1204, "data" : "", "message" : "验证码不正确!" } { "code" : 2001, "data" : "275132518@qq.com", "message" : "会话已失效!" }
    
    抛出:
    
    com.seeyon.ctp.common.exceptions.BusinessException
    
    Exception
  - resetPassword
```
@POST
 @Path(value="retrieve/resetPassword")
public javax.ws.rs.core.Response resetPassword(Map<String,Object> params,
                                                                                            @QueryParam(value="token")
                                                                                            String token)
                                                                                     throws Exception
```
    方式：post url:http://localhost/seeyon/rest/password/retrieve/resetPassword?token=4de88623-6664-494a-9140-acda19b107ba
    
    参数:
    
    params - 参数：loginName 登录名 password 新密码
    
    token - 生成的临时token
    
    返回:
    
    返回成功： { "code" : 0, "data" : "bj01", "message" : "密码重置成功!" } 返回失败： { "code" : 1301, "data" : "bj01", "message" : "无效的登录名!" } 返回失败： { "code" : 1302, "data" : "bj01", "message" : "非法操作!" } { "code" : 1303, "data" : "bj01", "message" : "验证码丢失，无法进行密码重置!" } { "code" : 1304, "data" : "bj01", "message" : "验证码已经失效，无法进行密码重置!" } { "code" : 1305, "data" : "bj01", "message" : "密码重置失败!原因: XXXX" } { "code" : 2001, "data" : "bj01", "message" : "会话已失效!" }
    
    抛出:
    
    com.seeyon.ctp.common.exceptions.BusinessException
    
    Exception

类 PasswordResource

构造器概要

方法概要

从类继承的方法 com.seeyon.ctp.rest.resources.BaseResource

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

构造器详细资料

PasswordResource

方法详细资料

canUseEmail

getEmailByLoginName

send

checkVerificationCode

resetPassword