com.tencent.devops.common.web.utils.BkApiUtil.kt Maven / Gradle / Ivy

Go to download

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

Tencent blueking ci project

There is a newer version: 3.1.0-rc.4

package com.tencent.devops.common.web.utils

import com.tencent.devops.common.web.constant.BkApiHandleType
import org.springframework.web.context.request.RequestContextHolder
import org.springframework.web.context.request.ServletRequestAttributes
import javax.servlet.http.HttpServletRequest

/**
 * API接口工具类
 *
 * @since: 2023-09-12
 * @version: $Revision$ $Date$ $LastChangedBy$
 *
 */
object BkApiUtil {

    private val apiPermissionThreadLocal = ThreadLocal()

    /**
     * 获取需要进行api接口权限校验的项目在缓存中的key
     * @return 需要进行api接口权限校验的项目在缓存中的key
     */
    fun getApiAccessLimitProjectsKey(): String {
        return "${BkApiHandleType.PROJECT_API_ACCESS_LIMIT}:projects"
    }

    /**
     * 获取需要进行api接口权限校验的流水线在缓存中的key
     * @return 需要进行api接口权限校验的流水线在缓存中的key
     */
    fun getApiAccessLimitPipelinesKey(): String {
        return "${BkApiHandleType.PIPELINE_API_ACCESS_LIMIT}:pipelines"
    }

    /**
     * 把接口权限校验标识保存到ThreadLocal中
     * @param permissionFlag 当次接口调用权限校验标识
     */
    fun setPermissionFlag(permissionFlag: Boolean) {
        apiPermissionThreadLocal.set(permissionFlag)
    }

    /**
     * 从ThreadLocal中获取当前线程中的接口权限校验标识
     * @return 布尔值
     */
    fun getPermissionFlag(): Boolean? {
        return apiPermissionThreadLocal.get()
    }

    /**
     * 从ThreadLocal中移除当前线程中的接口权限校验标识
     * @return 布尔值
     */
    fun removePermissionFlag() {
        apiPermissionThreadLocal.remove()
    }

    /**
     * 获取request对象
     * @return request对象
     */
    fun getHttpServletRequest(): HttpServletRequest? {
        val attributes = RequestContextHolder.getRequestAttributes() as? ServletRequestAttributes
        return attributes?.request
    }
}