io.github.novareseller.boot.annotation.ClientSign Maven / Gradle / Ivy

Go to download

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

There is a newer version: 1.5.3.beta

package io.github.novareseller.boot.annotation;

import com.github.lianjiatech.retrofit.spring.boot.annotation.InterceptMark;
import com.github.lianjiatech.retrofit.spring.boot.interceptor.BasePathMatchInterceptor;
import io.github.novareseller.boot.interceptor.ClientSignInterceptor;

import java.lang.annotation.*;

/**
 * @author: Bowen huang
 * @date: 2021/05/17
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@InterceptMark
public @interface ClientSign {

    /**
     * 密钥key
     * 支持占位符形式配置。
     *
     * @return
     */
    String clientId();

    /**
     * 密钥
     * 支持占位符形式配置。
     *
     * @return
     */
    String clientSecret();

    /**
     * 拦截器匹配路径
     *
     * @return
     */
    String[] include() default {"/**"};

    /**
     * 拦截器排除匹配，排除指定路径拦截
     *
     * @return
     */
    String[] exclude() default {};

    /**
     * 处理该注解的拦截器类
     * 优先从spring容器获取对应的Bean，如果获取不到，则使用反射创建一个！
     *
     * @return
     */
    Class handler() default ClientSignInterceptor.class;
}