ccproxy.core.plugins.factories¶
ccproxy.core.plugins.factories
¶
Plugin factory implementations and registry.
This module contains all concrete factory implementations merged from base_factory.py and factory.py to eliminate circular dependencies.
BaseProviderPluginFactory
¶
Bases: ProviderPluginFactory
Base factory for provider plugins that eliminates common boilerplate.
This class uses class attributes for plugin configuration and implements common methods that all provider factories share. Subclasses only need to define class attributes and override methods that need custom behavior.
Required class attributes to be defined by subclasses: - plugin_name: str - plugin_description: str - runtime_class: type[ProviderPluginRuntime] - adapter_class: type[BaseAdapter] - config_class: type[BaseSettings]
Optional class attributes with defaults: - plugin_version: str = "1.0.0" - detection_service_class: type | None = None - credentials_manager_class: type | None = None - router: APIRouter | None = None - route_prefix: str = "/api" - dependencies: list[str] = [] - optional_requires: list[str] = [] - tasks: list[TaskSpec] = []
Source code in ccproxy/core/plugins/factories.py
validate_format_adapters_with_settings
¶
Validate format adapter specifications (feature flags removed).
create_runtime
¶
create_adapter
async
¶
Create adapter instance with explicit dependencies.
This method extracts services from context and creates the adapter with explicit dependency injection. Subclasses can override this method if they need custom adapter creation logic.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
context
|
PluginContext
|
Plugin context |
required |
Returns:
| Type | Description |
|---|---|
BaseAdapter
|
Adapter instance |
Source code in ccproxy/core/plugins/factories.py
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 | |
create_detection_service
¶
Create detection service instance if class is configured.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
context
|
PluginContext
|
Plugin context |
required |
Returns:
| Type | Description |
|---|---|
Any
|
Detection service instance or None if no class configured |
Source code in ccproxy/core/plugins/factories.py
create_credentials_manager
async
¶
Resolve credentials manager via the shared auth registry.
Source code in ccproxy/core/plugins/factories.py
get_auth_manager_name
¶
Get auth manager name, allowing config override.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
context
|
PluginContext
|
Plugin context containing config |
required |
Returns:
| Type | Description |
|---|---|
str | None
|
Auth manager name or None if not configured |
Source code in ccproxy/core/plugins/factories.py
create_context
¶
Create context with provider-specific components.
This method provides a hook for subclasses to customize context creation. The default implementation just returns the base context.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
core_services
|
Core services container |
required |
Returns:
| Type | Description |
|---|---|
PluginContext
|
Plugin context |
Source code in ccproxy/core/plugins/factories.py
PluginRegistry
¶
Registry for managing plugin factories and runtime instances.
Source code in ccproxy/core/plugins/factories.py
register_service
¶
Register a service provided by a plugin.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
service_name
|
str
|
Name of the service |
required |
service_instance
|
Any
|
Service instance |
required |
provider_plugin
|
str
|
Name of the plugin providing the service |
required |
Source code in ccproxy/core/plugins/factories.py
get_service
¶
Get a service by name with optional type checking.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
service_name
|
str
|
Name of the service |
required |
service_type
|
type[T] | None
|
Optional expected service type |
None
|
Returns:
| Type | Description |
|---|---|
T | None
|
Service instance or None if not found |
Source code in ccproxy/core/plugins/factories.py
has_service
¶
get_required_services
¶
Get required and optional services for a plugin.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugin_name
|
str
|
Name of the plugin |
required |
Returns:
| Type | Description |
|---|---|
tuple[list[str], list[str]]
|
Tuple of (required_services, optional_services) |
Source code in ccproxy/core/plugins/factories.py
register_factory
¶
Register a plugin factory.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
factory
|
PluginFactory
|
Plugin factory to register |
required |
Source code in ccproxy/core/plugins/factories.py
get_factory
¶
Get a plugin factory by name.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
Plugin name |
required |
Returns:
| Type | Description |
|---|---|
PluginFactory | None
|
Plugin factory or None |
get_all_manifests
¶
Get all registered plugin manifests.
Returns:
| Type | Description |
|---|---|
dict[str, PluginManifest]
|
Dictionary mapping plugin names to manifests |
Source code in ccproxy/core/plugins/factories.py
resolve_dependencies
¶
Resolve plugin dependencies and return initialization order.
Skips plugins with missing hard dependencies or required services instead of failing the entire plugin system. Logs skipped plugins and continues with the rest.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
settings
|
Settings
|
Settings instance |
required |
Returns:
| Type | Description |
|---|---|
list[str]
|
List of plugin names in initialization order |
Source code in ccproxy/core/plugins/factories.py
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 | |
create_runtime
async
¶
Create and initialize a plugin runtime.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
Plugin name |
required |
service_container
|
ServiceContainer
|
Service container with all available services |
required |
Returns:
| Type | Description |
|---|---|
Any
|
Initialized plugin runtime |
Raises:
| Type | Description |
|---|---|
ValueError
|
If plugin not found |
Source code in ccproxy/core/plugins/factories.py
initialize_all
async
¶
Initialize all registered plugins with format adapter support.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
service_container
|
ServiceContainer
|
Service container with all available services |
required |
Source code in ccproxy/core/plugins/factories.py
shutdown_all
async
¶
Shutdown all plugin runtimes in reverse initialization order.