pip_services3_components library Null safety

Classes

CachedCounters
Abstract implementation of performance counters that measures and stores counters in memory. Child classes implement saving of the counters into various destinations.
CachedLogger
Abstract logger that caches captured log messages in memory and periodically dumps them. Child classes implement saving cached messages to their specified destinations.
CachedTracer
Abstract tracer that caches recorded traces in memory and periodically dumps them. Child classes implement saving cached traces to their specified destinations.
CacheEntry
Data object to store cached values with their keys used by MemoryCache
Component
Abstract component that supportes configurable dependencies, logging and performance counters.
CompositeConnectionResolver
Helper class that resolves connection and credential parameters, validates them and generates connection options.
CompositeCounters
Aggregates all counters from component references under a single component.
CompositeFactory
Aggregates multiple factories into a single factory component. When a new component is requested, it iterates through factories to locate the one able to create the requested component.
CompositeLogger
Aggregates all loggers from component references under a single component.
CompositeTracer
Aggregates all tracers from component references under a single component.
ConfigReader
Abstract config reader that supports configuration parameterization.
ConnectionParams
Contains connection parameters to connect to external services. They are used together with credential parameters, but usually stored separately from more protected sensitive values.
ConnectionResolver
Helper class to retrieve component connections.
ConnectionUtils
A set of utility functions to process connection parameters
ConsoleLogger
Logger that writes log messages to console.
ContextInfo
Context information component that provides detail information about execution context: container or/and process.
Counter
Data object to store measurement for a performance counter. This object is used by CachedCounters to store counters.
CounterTiming
Callback object returned by {@link ICounters.beginTiming} to end timing of execution block and update the associated counter.
CredentialParams
Contains credentials to authenticate against external services. They are used together with connection parameters, but usually stored in a separate store, protected from unauthorized access.
CredentialResolver
Helper class to retrieve component credentials.
DefaultCacheFactory
Creates ICache components by their descriptors.
DefaultConfigReaderFactory
Creates IConfigReader components by their descriptors.
DefaultCountersFactory
Creates ICounters components by their descriptors.
DefaultCredentialStoreFactory
Creates ICredentialStore components by their descriptors.
DefaultDiscoveryFactory
Creates IDiscovery components by their descriptors.
DefaultInfoFactory
Creates information components by their descriptors.
DefaultLockFactory
Creates ILock components by their descriptors.
DefaultLoggerFactory
Creates ILogger components by their descriptors.
DefaultStateStoreFactory
Creates IStateStore components by their descriptors.
DefaultTestFactory
Creates test components by their descriptors.
DefaultTracerFactory
Creates ITracer components by their descriptors.
DiscoveryItem
Used to store key-identifiable information about connections.
Factory
Basic component factory that creates components using registered types and factory functions.
FileConfigReader
Abstract config reader that reads configuration from a file. Child classes add support for config files in their specific format like JSON, YAML or property files.
ICache
Interface for caches that are used to cache values to improve performance.
IConfigReader
Interface for configuration readers that retrieve configuration from various sources and make it available for other components.
ICounters
Interface for performance counters that measure execution metrics.
ICounterTimingCallback
Interface for a callback to end measurement of execution elapsed time.
ICredentialStore
Interface for credential stores which are used to store and lookup credentials to authenticate against external services.
IDiscovery
Interface for discovery services which are used to store and resolve connection parameters to connect to external services.
IFactory
Interface for component factories.
ILock
Interface for locks to synchronize work or parallel processes and to prevent collisions.
ILogger
Todo: solve issue with overloaded methods. Look at Python implementation Interface for logger components that capture execution log messages.
IStateStore
Interface for state storages that are used to store and retrieve transaction states.
ITracer
Interface for tracer components that capture operation traces.
JsonConfigReader
Config reader that reads configuration from JSON file.
Lock
Abstract lock that implements default lock acquisition routine.
LogCounters
Performance counters that periodically dumps counters measurements to logger.
Logger
Abstract logger that captures and formats log messages. Child classes take the captured messages and write them to their specific destinations.
LogLevelConverter
Helper class to convert log level values.
LogMessage
Data object to store captured log messages. This object is used by CachedLogger.
LogTracer
MemoryCache
Cache that stores values in the process memory.
MemoryConfigReader
Config reader that stores configuration in memory.
MemoryCredentialStore
Credential store that keeps credentials in memory.
MemoryDiscovery
Discovery service that keeps connections in memory.
MemoryLock
Lock that is used to synchronize execution within one process using shared memory.
MemoryStateStore
State store that keeps states in the process memory.
NullCache
Dummy cache implementation that doesn't do anything.
NullCounters
Dummy implementation of performance counters that doesn't do anything.
NullLock
Dummy lock implementation that doesn't do anything.
NullLogger
Dummy implementation of logger that doesn't do anything.
NullStateStore
Dummy state store implementation that doesn't do anything.
NullTracer
OperationTrace
Registration
Shutdown
Random shutdown component that crashes the process using various methods.
StateEntry
Data object to store state values with their keys used by MemoryStateStore
StateValue<T>
A data object that holds a retrieved state value with its key.
TraceTiming
Timing object returned by ITracer.beginTrace to end timing of execution block and record the associated trace.
YamlConfigReader
Config reader that reads configuration from YAML file.

Enums

CounterType
Types of counters that measure different types of metrics
LogLevel
Standard log levels.

Exceptions / Errors

CreateException
Error raised when factory is not able to create requested component.