com.netflix.spinnaker.kork.plugins.SpringPluginStatusProvider.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kork-plugins Show documentation
Spinnaker Kork
There is a newer version: 7.247.0
/*
 * Copyright 2019 Netflix, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.netflix.spinnaker.kork.plugins

import com.netflix.spinnaker.kork.dynamicconfig.DynamicConfigService
import kotlin.collections.set
import org.pf4j.PluginStatusProvider
import org.slf4j.LoggerFactory
import org.springframework.boot.context.event.ApplicationEnvironmentPreparedEvent
import org.springframework.context.ApplicationListener
import org.springframework.core.env.MapPropertySource

/**
 * Backs plugin status by the Spring environment, instead of using text files.
 */
class SpringPluginStatusProvider(
  private val dynamicConfigService: DynamicConfigService,
  private val rootConfig: String
) : PluginStatusProvider, ApplicationListener {

  private val log by lazy { LoggerFactory.getLogger(javaClass) }

  private val propertySourceBackingStore: MutableMap = mutableMapOf()
  private val propertySource = MapPropertySource("plugins", propertySourceBackingStore)

  override fun disablePlugin(pluginId: String) {
    log.info("Disabling plugin: $pluginId")
    propertySourceBackingStore[enabledPropertyName(pluginId)] = false
  }

  override fun isPluginDisabled(pluginId: String): Boolean =
    !isEnabled(pluginId)

  /**
   * Returns whether or not a plugin is enabled or not.
   */
  fun isPluginEnabled(pluginId: String): Boolean =
    isEnabled(pluginId)

  override fun enablePlugin(pluginId: String) {
    log.info("Enabling plugin: $pluginId")
    propertySourceBackingStore[enabledPropertyName(pluginId)] = true
  }

  override fun onApplicationEvent(event: ApplicationEnvironmentPreparedEvent) {
    log.debug("Adding ${this.javaClass.simpleName} as new PropertySource")
    event.environment.propertySources.addFirst(propertySource)
  }

  private fun isEnabled(pluginId: String): Boolean =
    dynamicConfigService.isEnabled(enabledPropertyName(pluginId), false)

  private fun enabledPropertyName(pluginId: String): String =
    "$rootConfig.$pluginId"

  /**
   * Provides the plugin version a plugin should be running.
   */
  fun pluginVersion(pluginId: String): String? =
    dynamicConfigService.getConfig(String::class.java, versionPropertyName(pluginId), "unspecified")

  private fun versionPropertyName(pluginId: String): String =
    "$rootConfig.$pluginId.version"
}