ars.module.people.service.AuthService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ars-module-people Show documentation

Ars framework module people

There is a newer version: 2.0.0

package ars.module.people.service;

import java.util.Map;
import java.io.IOException;

import ars.invoke.local.Api;
import ars.invoke.local.Param;
import ars.invoke.request.Token;
import ars.invoke.request.Requester;

/**
 * 用户认证业务操作接口
 * 
 * @author yongqiangwu
 * 
 */
@Api("people/auth")
public interface AuthService {
	/**
	 * 获取登录验证码
	 * 
	 * @param requester
	 *            请求对象
	 * @param parameters
	 *            请求参数
	 * @return 验证码图片字节数组
	 * @throws IOException
	 *             IO操作异常
	 */
	@Api("verifycode")
	public byte[] verifycode(Requester requester, Map parameters) throws IOException;

	/**
	 * 用户登陆
	 * 
	 * @param requester
	 *            请求对象
	 * @param code
	 *            用户编号
	 * @param password
	 *            用户密码（明文）
	 * @param parameters
	 *            请求参数
	 * @return 令牌对象
	 */
	@Api("login")
	public Token login(Requester requester, @Param(name = "code", required = true) String code,
			@Param(name = "password", required = true) String password, Map parameters);

	/**
	 * 用户注销
	 * 
	 * @param requester
	 *            请求对象
	 * @param parameters
	 *            请求参数
	 */
	@Api("logout")
	public void logout(Requester requester, Map parameters);

	/**
	 * 判断资源是否允许访问
	 * 
	 * @param requester
	 *            请求对象
	 * @param uri
	 *            资源地址
	 * @param parameters
	 *            请求参数
	 * @return true/false
	 */
	@Api("permissible")
	public boolean permissible(Requester requester, @Param(name = "uri", required = true) String uri,
			Map parameters);

}