com.foxinmy.weixin4j.interceptor.WeixinMessageInterceptor Maven / Gradle / Ivy

Go to download
package com.foxinmy.weixin4j.interceptor;

import com.foxinmy.weixin4j.handler.WeixinMessageHandler;
import com.foxinmy.weixin4j.request.WeixinMessage;
import com.foxinmy.weixin4j.request.WeixinRequest;
import com.foxinmy.weixin4j.response.WeixinResponse;

import io.netty.channel.ChannelHandlerContext;

/**
 * 微信消息拦截器
 *
 * @className WeixinMessageInterceptor
 * @author jinyu([email protected])
 * @date 2015年5月7日
 * @since JDK 1.6
 * @see MessageInterceptorAdapter
 */
public interface WeixinMessageInterceptor {

	/**
	 * 执行handler前
	 *
	 * @param context
	 *            通道环境
	 * @param request
	 *            微信请求
	 * @param message
	 *            微信消息
	 * @param handler
	 *            消息处理器
	 * @return 返回true执行下一个拦截器
	 * @throws WeixinException
	 */
	boolean preHandle(ChannelHandlerContext context, WeixinRequest request,
			WeixinMessage message, WeixinMessageHandler handler);

	/**
	 * 执行handler后
	 *
	 * @param context
	 *            通道环境
	 * @param request
	 *            微信请求
	 * @param response
	 *            微信响应
	 * @param message
	 *            微信消息
	 * @param handler
	 *            消息处理器
	 * @throws WeixinException
	 */
	void postHandle(ChannelHandlerContext context, WeixinRequest request,
			WeixinResponse response, WeixinMessage message,
			WeixinMessageHandler handler);

	/**
	 * 全部执行后
	 *
	 * @param context
	 *            通道环境
	 * @param request
	 *            微信请求
	 * @param message
	 *            微信消息
	 * @param handler
	 *            消息处理器
	 * @param exception
	 *            执行异常
	 * @throws WeixinException
	 */
	void afterCompletion(ChannelHandlerContext context, WeixinRequest request,
			WeixinResponse response, WeixinMessage message,
			WeixinMessageHandler handler, Exception exception);

	/**
	 * 用于匹配到多个MessageHandler时权重降序排列,数字越大优先级越高
	 *
	 * @return 权重
	 */
	int weight();
}