net.gdface.facelog.TokenContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of facelog-local Show documentation
There is a newer version: 5.3.0
package net.gdface.facelog;

import static com.google.common.base.Preconditions.*;
import static com.google.common.base.MoreObjects.firstNonNull;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.google.common.base.Strings;

/**
 * 令牌状态上下文
 * @author guyadong
 *
 */
public class TokenContext {
    public static final Logger logger = LoggerFactory.getLogger(TokenContext.class);
	private static final String UNKNOW_ADDRESS = "unknow";

	static final ThreadLocal TOKEN_CONTEXT = new ThreadLocal(){
		@Override
		protected TokenContext initialValue() {
			return new TokenContext();
		}};
	/**  是否记录详细异常信息  */
	private static boolean errorDetail = false;
	private Token token;
	private TokenOp tokenOp;
	private boolean ok;
	private ServiceSecurityException error;
	private String methodName;
	private String clientAddress;
	private TokenContext() {
		reset();
	}
	void reset(){
		token = new Token();
		tokenOp = TokenOp.UNINITIALIZED;
		ok = true;
		error = null;
	}
	/** 返回当前令牌 */
	public Token getToken() {
		return token;
	}
	/**
	 * 设置当前令牌
	 * @param token 不可为{@code null} 
	 * @return  当前对象
	 */
	public TokenContext setToken(Token token) {
		this.token = checkNotNull(token);
		return this;
	}
	/** 返回当前令牌操作类型 */
	public TokenOp getTokenOp() {
		return tokenOp;
	}
	/**
	 * 设置当前令牌操作类型
	 * @param tokenOp 不可为{@code null}
	 * @return 当前对象
	 */
	public TokenContext setTokenOp(TokenOp tokenOp) {
		this.tokenOp = checkNotNull(tokenOp);
		return this;
	}
	/** 返回当前令牌操作{@link #tokenOp}执行状态,{@code true}表示正常 */
	public boolean isOk() {
		return ok;
	}
	/**
	 * 返回当前异常
	 * @return 当前异常
	 */
	public ServiceSecurityException getError() {
		return error;
	}
	/**
	 * 设置当前令牌操作{@link #tokenOp}异常，并将{@link #isOk()}置为{@code false}
	 * @param error
	 * @return 当前对象
	 */
	public TokenContext setError(ServiceSecurityException error) {
		this.error = checkNotNull(error);
		this.ok = false;
		return this;
	}
	/**
	 * 返回当前服务方法名
	 * @return 当前服务方法名
	 */
	public String getMethodName() {
		return methodName;
	}
	/**
	 * 设置当前方法名
	 * @param methodName
	 * @return  当前对象
	 * @throws IllegalStateException {@link #methodName}字段已经初始化
	 * @throws IllegalArgumentException {@code methodName}为空或{@code null}
	 */
	public TokenContext setMethodName(String methodName) {
		checkState(null == this.methodName,"methodName be initialized already");
		checkArgument(!Strings.isNullOrEmpty(methodName),"methodName is null or empty");
		this.methodName = methodName;
		return this;
	}
	/**
	 * 返回当前调用的客户端地址
	 * @return 当前调用的客户端地址
	 */
	public String getClientAddress() {
		return firstNonNull(clientAddress,UNKNOW_ADDRESS);
	}
	/**
	 * 设置当前调用的客户端地址
	 * @param clientAddress
	 * @return  当前对象
	 */
	public TokenContext setClientAddress(String clientAddress) {
		this.clientAddress = clientAddress;
		return this;
	}
	/**
	 * 上下文对象生命期结束时调用

	 * 记录令牌操作日志
	 */
	public void contextDone() {
		if(TokenOp.UNINITIALIZED != tokenOp){
			if(this.ok){
				logger.info("PORT:{} OP:{}: FROM:{} BY:{}: OK",
						methodName,
						tokenOp.name(),
						getClientAddress(),
						getToken().owner());
			}else{
				logger.error("PORT:{} OP:{}: FROM:{} BY:{}: MESSAGE:{}",
						methodName,
						tokenOp.name(),
						getClientAddress(),
						getToken().owner(),
						error.getMessage());
				if(errorDetail){
					logger.error(error.getMessage(),error);
				}
			}
		}
		// 释放TLS变量
		TOKEN_CONTEXT.remove();
	}
	/**
	 * 返回当前线程拥有的{@link TokenContext}对象
	 * @return {@link TokenContext}对象
	 */
	public static TokenContext getCurrentTokenContext(){
		return TOKEN_CONTEXT.get();
	}
	public static boolean isErrorDetail() {
		return errorDetail;
	}
	public static void setErrorDetail(boolean errorDetail) {
		TokenContext.errorDetail = errorDetail;
	}	
}