cn.bestwu.api.sign.ApiSignProperties Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api-sign Show documentation

api-sign

There is a newer version: 1.2.4

package cn.bestwu.api.sign;

import org.springframework.boot.context.properties.ConfigurationProperties;

/**
 * 签名配置属性
 *
 * @author Peter Wu
 */
@ConfigurationProperties("api.sign")
public class ApiSignProperties {

  /**
   * 验证签名时效时允许客户端与服务器的时差，单位秒
   * 如果小于等于0 不验证签名时效.
   */
  private int allowableClientTimeDifference = 0;
  /**
   * 是否验证 userAgent.
   */
  private boolean verifyUserAgent = false;
  /**
   * 是否可跳过验证.
   */
  private boolean canSkip = true;
  /**
   * 需要验证签名的 Controller类名前缀.
   */
  private String[] handlerTypePrefix = {};
  /**
   * 签名参数名.
   */
  private String parameterName = "sign";
  /**
   * 默认客户端密码.
   */
  private String clientSecret;

  //--------------------------------------------
  public boolean isSimple() {
    return (!verifyUserAgent) && allowableClientTimeDifference <= 0;
  }

  //--------------------------------------------


  public String[] getHandlerTypePrefix() {
    return handlerTypePrefix;
  }

  public void setHandlerTypePrefix(String[] handlerTypePrefix) {
    this.handlerTypePrefix = handlerTypePrefix;
  }

  public int getAllowableClientTimeDifference() {
    return allowableClientTimeDifference;
  }

  public void setAllowableClientTimeDifference(int allowableClientTimeDifference) {
    this.allowableClientTimeDifference = allowableClientTimeDifference;
  }

  public boolean isVerifyUserAgent() {
    return verifyUserAgent;
  }

  public void setVerifyUserAgent(boolean verifyUserAgent) {
    this.verifyUserAgent = verifyUserAgent;
  }

  public boolean isCanSkip() {
    return canSkip;
  }

  public void setCanSkip(boolean canSkip) {
    this.canSkip = canSkip;
  }

  public String getParameterName() {
    return parameterName;
  }

  public void setParameterName(String parameterName) {
    this.parameterName = parameterName;
  }

  public String getClientSecret() {
    return clientSecret;
  }

  public void setClientSecret(String clientSecret) {
    this.clientSecret = clientSecret;
  }
}