com.tencent.devops.common.event.pojo.IEvent.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of common-event Show documentation
Tencent blueking ci project
There is a newer version: 3.1.0-rc.4
/*
 * Tencent is pleased to support the open source community by making BK-CI 蓝鲸持续集成平台 available.
 *
 * Copyright (C) 2019 THL A29 Limited, a Tencent company.  All rights reserved.
 *
 * BK-CI 蓝鲸持续集成平台 is licensed under the MIT license.
 *
 * A copy of the MIT License is included in this file.
 *
 *
 * Terms of the MIT License:
 * ---------------------------------------------------
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of
 * the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
 * LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
 * NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package com.tencent.devops.common.event.pojo

import com.tencent.devops.common.stream.constants.StreamHeader.X_DELAY
import com.tencent.devops.common.stream.utils.DefaultBindingUtils
import org.slf4j.LoggerFactory
import org.springframework.cloud.stream.function.StreamBridge
import org.springframework.messaging.Message
import org.springframework.messaging.support.MessageBuilder

/**
 * 流水线事件
 */
open class IEvent(
    open var delayMills: Int = 0,
    open var retryTime: Int = 1
) {

    /**
     * Stream事件发送
     * @param bridge 传入一个自动加载的StreamBridge单例
     */
    fun sendTo(bridge: StreamBridge, destination: String? = null) {
        try {
            bridge.send(
                destination ?: DefaultBindingUtils.getOutBindingName(this::class.java),
                buildMessage(if (delayMills > 0) delayMills else 0)
            )
        } catch (ignored: Exception) {
            logger.error("[STREAM MQ] Fail to dispatch the event($this)", ignored)
        }
    }

    private fun buildMessage(defaultMills: Int = 0): Message {
        val builder = MessageBuilder
            .withPayload(this)
        // 事件中的变量指定
        if (delayMills > 0) {
            builder.setHeader(X_DELAY, delayMills)
        } else if (defaultMills > 0) {
            // 事件类型固化默认值
            builder.setHeader(X_DELAY, defaultMills)
        }
        return builder.build()
    }

    companion object {
        private val logger = LoggerFactory.getLogger(IEvent::class.java)
    }
}