Embabel Agent Documentation/com.embabel.agent.config.migration/DeprecatedPropertyScanningConfig

DeprecatedPropertyScanningConfig

data class DeprecatedPropertyScanningConfig(var includePackages: List<String> = listOf( "com.embabel.agent", "com.embabel.agent.shell" ), var excludePackages: List<String> = defaultExcludePackages(), var additionalExcludes: List<String> = emptyList(), var autoExcludeJarPackages: Boolean = false, var maxScanDepth: Int = 10, var enabled: Boolean = false)

Configuration for conditional property scanning during migration.

Controls which packages are scanned for deprecated property in @ConditionalOnProperty annotations. Uses a flexible approach with configurable include/exclude patterns to handle diverse project structures and dependencies.

Spring Boot + Kotlin Binding Pattern Consistency

All properties use var to ensure consistency with production requirements:

@Configuration + @ConfigurationProperties: Requires var for CGLIB proxy compatibility
Complex types (List): Need var for reliable environment variable binding
Scalar types: Use var to maintain pattern consistency and avoid production issues

This follows the same pattern as DeprecatedPropertyWarningConfig which was validated in production.

Constructors

DeprecatedPropertyScanningConfig

constructor(includePackages: List<String> = listOf( "com.embabel.agent", "com.embabel.agent.shell" ), excludePackages: List<String> = defaultExcludePackages(), additionalExcludes: List<String> = emptyList(), autoExcludeJarPackages: Boolean = false, maxScanDepth: Int = 10, enabled: Boolean = false)

Types

Companion

object Companion

Properties

additionalExcludes

var additionalExcludes: List<String>

Additional user-specific packages to exclude. Allows runtime customization without modifying the default exclusion list.

autoExcludeJarPackages

var autoExcludeJarPackages: Boolean

Whether to use classpath-based detection to automatically exclude JAR-based packages. When enabled, packages from JAR files are automatically excluded from scanning.

enabled

var enabled: Boolean

Whether scanning is enabled. Disabled by default for production safety - migration system is completely dormant. Set to true to activate comprehensive migration detection and warnings.

excludePackages

var excludePackages: List<String>

Package prefixes to exclude from scanning. Uses a comprehensive strategy that excludes common framework and library packages while allowing configuration override for custom environments.

includePackages

var includePackages: List<String>

Base packages to scan for deprecated conditional annotations. Defaults to actual Embabel packages while excluding framework internals.

maxScanDepth

var maxScanDepth: Int

Maximum depth for package scanning to prevent excessive recursion.