Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- acquireLock(String, String, int, long) - Method in interface org.pipservices3.components.lock.ILock
-
Makes multiple attempts to acquire a lock by its key within give time interval.
- acquireLock(String, String, int, long) - Method in class org.pipservices3.components.lock.Lock
-
Makes multiple attempts to acquire a lock by its key within give time interval.
- acquireLock(String, String, int, long) - Method in class org.pipservices3.components.lock.NullLock
-
Makes multiple attempts to acquire a lock by its key within give time interval.
- add(CredentialParams) - Method in class org.pipservices3.components.auth.CredentialResolver
-
Adds a new credential to component credentials
- add(IFactory) - Method in class org.pipservices3.components.build.CompositeFactory
-
Adds a factory into the list of embedded factories.
- add(ConnectionParams) - Method in class org.pipservices3.components.connect.ConnectionResolver
-
Adds a new connection to component connections
- addChangeListener(INotifiable) - Method in class org.pipservices3.components.config.ConfigReader
-
Adds a listener that will be notified when configuration is changed
- addChangeListener(INotifiable) - Method in interface org.pipservices3.components.config.IConfigReader
-
Adds a listener that will be notified when configuration is changed
- addChangeListener(INotifiable) - Method in class org.pipservices3.components.config.MemoryConfigReader
-
Adds a listener that will be notified when configuration is changed
B
- beginTiming(String) - Method in class org.pipservices3.components.count.CachedCounters
-
Begins measurement of execution time interval.
- beginTiming(String) - Method in class org.pipservices3.components.count.CompositeCounters
-
Begins measurement of execution time interval.
- beginTiming(String) - Method in interface org.pipservices3.components.count.ICounters
-
Begins measurement of execution time interval.
- beginTiming(String) - Method in class org.pipservices3.components.count.NullCounters
-
Begins measurement of execution time interval.
- beginTrace(String, String, String) - Method in class org.pipservices3.components.trace.CachedTracer
-
Begings recording an operation trace
- beginTrace(String, String, String) - Method in class org.pipservices3.components.trace.CompositeTracer
-
Begings recording an operation trace
- beginTrace(String, String, String) - Method in interface org.pipservices3.components.trace.ITracer
- beginTrace(String, String, String) - Method in class org.pipservices3.components.trace.LogTracer
-
Begings recording an operation trace
- beginTrace(String, String, String) - Method in class org.pipservices3.components.trace.NullTracer
-
Begings recording an operation trace
C
- CachedConfigReader - Class in org.pipservices3.components.config
- CachedConfigReader() - Constructor for class org.pipservices3.components.config.CachedConfigReader
- CachedCounters - Class in org.pipservices3.components.count
-
Abstract implementation of performance counters that measures and stores counters in memory.
- CachedCounters() - Constructor for class org.pipservices3.components.count.CachedCounters
-
Creates a new CachedCounters object.
- CachedLogger - Class in org.pipservices3.components.log
-
Abstract logger that caches captured log messages in memory and periodically dumps them.
- CachedLogger() - Constructor for class org.pipservices3.components.log.CachedLogger
- CachedTracer - Class in org.pipservices3.components.trace
-
Abstract tracer that caches recorded traces in memory and periodically dumps them.
- CachedTracer() - Constructor for class org.pipservices3.components.trace.CachedTracer
- CacheEntry - Class in org.pipservices3.components.cache
-
Data object to store cached values with their keys used by
MemoryCache - CacheEntry(String, Object, long) - Constructor for class org.pipservices3.components.cache.CacheEntry
-
Creates a new instance of the cache entry and assigns its values.
- canCreate(Object) - Method in class org.pipservices3.components.build.CompositeFactory
-
Checks if this factory is able to create component by given locator.
- canCreate(Object) - Method in class org.pipservices3.components.build.Factory
-
Checks if this factory is able to create component by given locator.
- canCreate(Object) - Method in interface org.pipservices3.components.build.IFactory
-
Checks if this factory is able to create component by given locator.
- clear() - Method in class org.pipservices3.components.log.CachedLogger
-
Clears (removes) all cached log messages.
- clear() - Method in class org.pipservices3.components.trace.CachedTracer
-
Clears (removes) all cached log messages.
- clear(String) - Method in class org.pipservices3.components.count.CachedCounters
-
Clears (resets) a counter specified by its name.
- clearAll() - Method in class org.pipservices3.components.count.CachedCounters
-
Clears (resets) all counters.
- close(String) - Method in class org.pipservices3.components.test.Shutdown
-
Closes the timer.
- component - Variable in class org.pipservices3.components.trace.OperationTrace
-
The name of component
- Component - Class in org.pipservices3.components
-
Abstract component that supportes configurable dependencies, logging and performance counters.
- Component() - Constructor for class org.pipservices3.components.Component
- compose(String, List<ConnectionParams>, CredentialParams, ConfigParams) - Method in class org.pipservices3.components.connect.CompositeConnectionResolver
-
Composes Composite connection options from connection and credential parameters.
- composeError(Exception) - Method in class org.pipservices3.components.log.Logger
-
Composes an human-readable error description
- composeUri(ConfigParams, String, int) - Static method in class org.pipservices3.components.connect.ConnectionUtils
-
Composes URI from config parameters.
- CompositeConnectionResolver - Class in org.pipservices3.components.connect
-
Helper class that resolves connection and credential parameters, validates them and generates connection options.
- CompositeConnectionResolver() - Constructor for class org.pipservices3.components.connect.CompositeConnectionResolver
- CompositeCounters - Class in org.pipservices3.components.count
-
Aggregates all counters from component references under a single component.
- CompositeCounters() - Constructor for class org.pipservices3.components.count.CompositeCounters
-
Creates a new instance of the counters.
- CompositeCountersDescriptor - Static variable in class org.pipservices3.components.count.DefaultCountersFactory
- CompositeFactory - Class in org.pipservices3.components.build
-
Aggregates multiple factories into a single factory component.
- CompositeFactory() - Constructor for class org.pipservices3.components.build.CompositeFactory
-
Creates a new instance of the factory.
- CompositeFactory(IFactory...) - Constructor for class org.pipservices3.components.build.CompositeFactory
-
Creates a new instance of the factory.
- CompositeLogger - Class in org.pipservices3.components.log
-
Aggregates all loggers from component references under a single component.
- CompositeLogger() - Constructor for class org.pipservices3.components.log.CompositeLogger
-
Creates a new instance of the logger.
- CompositeLogger(IReferences) - Constructor for class org.pipservices3.components.log.CompositeLogger
-
Creates a new instance of the logger.
- CompositeLoggerDescriptor - Static variable in class org.pipservices3.components.log.DefaultLoggerFactory
- CompositeTracer - Class in org.pipservices3.components.trace
-
Aggregates all tracers from component references under a single component.
- CompositeTracer() - Constructor for class org.pipservices3.components.trace.CompositeTracer
- CompositeTracer(IReferences) - Constructor for class org.pipservices3.components.trace.CompositeTracer
-
Creates a new instance of the tracer.
- concat(ConfigParams, ConfigParams, List<String>) - Static method in class org.pipservices3.components.connect.ConnectionUtils
-
Concatinates two options by combining duplicated properties into comma-separated list
- ConfigReader - Class in org.pipservices3.components.config
-
Abstract config reader that supports configuration parameterization.
- ConfigReader() - Constructor for class org.pipservices3.components.config.ConfigReader
- configure(ConfigParams) - Method in class org.pipservices3.components.auth.CredentialResolver
-
Configures component by passing configuration parameters.
- configure(ConfigParams) - Method in class org.pipservices3.components.auth.MemoryCredentialStore
-
Configures component by passing configuration parameters.
- configure(ConfigParams) - Method in class org.pipservices3.components.cache.MemoryCache
-
Configures component by passing configuration parameters.
- configure(ConfigParams) - Method in class org.pipservices3.components.Component
-
Configures component by passing configuration parameters.
- configure(ConfigParams) - Method in class org.pipservices3.components.config.CachedConfigReader
- configure(ConfigParams) - Method in class org.pipservices3.components.config.ConfigReader
-
Configures component by passing configuration parameters.
- configure(ConfigParams) - Method in class org.pipservices3.components.config.FileConfigReader
-
Configures component by passing configuration parameters.
- configure(ConfigParams) - Method in class org.pipservices3.components.config.MemoryConfigReader
-
Configures component by passing configuration parameters.
- configure(ConfigParams) - Method in class org.pipservices3.components.connect.CompositeConnectionResolver
-
Configures component by passing configuration parameters.
- configure(ConfigParams) - Method in class org.pipservices3.components.connect.ConnectionResolver
-
Configures component by passing configuration parameters.
- configure(ConfigParams) - Method in class org.pipservices3.components.connect.MemoryDiscovery
-
Configures component by passing configuration parameters.
- configure(ConfigParams) - Method in class org.pipservices3.components.count.CachedCounters
-
Configures component by passing configuration parameters.
- configure(ConfigParams) - Method in class org.pipservices3.components.info.ContextInfo
-
Configures component by passing configuration parameters.
- configure(ConfigParams) - Method in class org.pipservices3.components.lock.Lock
-
Configures component by passing configuration parameters.
- configure(ConfigParams) - Method in class org.pipservices3.components.log.CachedLogger
-
Configures component by passing configuration parameters.
- configure(ConfigParams) - Method in class org.pipservices3.components.log.Logger
-
Configures component by passing configuration parameters.
- configure(ConfigParams) - Method in class org.pipservices3.components.state.MemoryStateStore
-
Configures component by passing configuration parameters.
- configure(ConfigParams) - Method in class org.pipservices3.components.test.Shutdown
-
Configures component by passing configuration parameters.
- configure(ConfigParams) - Method in class org.pipservices3.components.trace.CachedTracer
-
Configures component by passing configuration parameters.
- configure(ConfigParams) - Method in class org.pipservices3.components.trace.LogTracer
-
Configures component by passing configuration parameters.
- configure(ConfigParams, boolean) - Method in class org.pipservices3.components.auth.CredentialResolver
-
Configures component by passing configuration parameters.
- configure(ConfigParams, boolean) - Method in class org.pipservices3.components.connect.ConnectionResolver
-
Configures component by passing configuration parameters.
- ConnectionParams - Class in org.pipservices3.components.connect
-
Contains connection parameters to connect to external services.
- ConnectionParams() - Constructor for class org.pipservices3.components.connect.ConnectionParams
-
Creates a new connection parameters and fills it with values.
- ConnectionParams(Map<?, ?>) - Constructor for class org.pipservices3.components.connect.ConnectionParams
-
Creates a new connection parameters and fills it with values.
- ConnectionResolver - Class in org.pipservices3.components.connect
-
Helper class to retrieve component connections.
- ConnectionResolver() - Constructor for class org.pipservices3.components.connect.ConnectionResolver
-
Creates a new instance of connection resolver.
- ConnectionResolver(ConfigParams) - Constructor for class org.pipservices3.components.connect.ConnectionResolver
-
Creates a new instance of connection resolver.
- ConnectionResolver(ConfigParams, IReferences) - Constructor for class org.pipservices3.components.connect.ConnectionResolver
-
Creates a new instance of connection resolver.
- ConnectionUtils - Class in org.pipservices3.components.connect
-
A set of utility functions to process connection parameters
- ConnectionUtils() - Constructor for class org.pipservices3.components.connect.ConnectionUtils
- ConsoleLogger - Class in org.pipservices3.components.log
-
Logger that writes log messages to console.
- ConsoleLogger() - Constructor for class org.pipservices3.components.log.ConsoleLogger
-
Creates a new instance of the logger.
- ConsoleLoggerDescriptor - Static variable in class org.pipservices3.components.log.DefaultLoggerFactory
- ContainerInfoDescriptor - Static variable in class org.pipservices3.components.info.DefaultInfoFactory
- ContextInfo - Class in org.pipservices3.components.info
-
Context information component that provides detail information about execution context: container or/and process.
- ContextInfo() - Constructor for class org.pipservices3.components.info.ContextInfo
-
Creates a new instance of this context info.
- ContextInfo(String, String) - Constructor for class org.pipservices3.components.info.ContextInfo
-
Creates a new instance of this context info.
- ContextInfoDescriptor - Static variable in class org.pipservices3.components.info.DefaultInfoFactory
- correlationId - Variable in class org.pipservices3.components.trace.OperationTrace
-
The transaction id to trace execution through call chain.
- Counter - Class in org.pipservices3.components.count
-
Data object to store measurement for a performance counter.
- Counter() - Constructor for class org.pipservices3.components.count.Counter
-
Creates a instance of the data obejct
- Counter(String, int) - Constructor for class org.pipservices3.components.count.Counter
-
Creates a instance of the data obejct
- CounterTiming - Class in org.pipservices3.components.count
-
Callback object returned by
beginTiming(String)to end timing of execution block and update the associated counter. - CounterTiming() - Constructor for class org.pipservices3.components.count.CounterTiming
-
Creates a new instance of the timing callback object.
- CounterTiming(String, ICounterTimingCallback) - Constructor for class org.pipservices3.components.count.CounterTiming
-
Creates a new instance of the timing callback object.
- CounterType - Class in org.pipservices3.components.count
-
Types of counters that measure different types of metrics
- CounterType() - Constructor for class org.pipservices3.components.count.CounterType
- create(Object) - Method in class org.pipservices3.components.build.CompositeFactory
-
Creates a component identified by given locator.
- create(Object) - Method in class org.pipservices3.components.build.Factory
-
Creates a component identified by given locator.
- create(Object) - Method in interface org.pipservices3.components.build.Factory.IComponentFactory
- create(Object) - Method in interface org.pipservices3.components.build.IFactory
-
Creates a component identified by given locator.
- CreateException - Exception Class in org.pipservices3.components.build
-
Error raised when factory is not able to create requested component.
- CreateException() - Constructor for exception class org.pipservices3.components.build.CreateException
-
Creates an error instance.
- CreateException(String, Object) - Constructor for exception class org.pipservices3.components.build.CreateException
-
Creates an error instance and assigns its values.
- CreateException(String, String) - Constructor for exception class org.pipservices3.components.build.CreateException
-
Creates an error instance and assigns its values.
- CredentialParams - Class in org.pipservices3.components.auth
-
Contains credentials to authenticate against external services.
- CredentialParams() - Constructor for class org.pipservices3.components.auth.CredentialParams
-
Creates an empty instance of credential parameters.
- CredentialParams(Map<?, ?>) - Constructor for class org.pipservices3.components.auth.CredentialParams
-
Creates a new CredentialParams and fills it with values.
- CredentialResolver - Class in org.pipservices3.components.auth
-
Helper class to retrieve component credentials.
- CredentialResolver() - Constructor for class org.pipservices3.components.auth.CredentialResolver
-
Creates a new instance of credentials resolver.
- CredentialResolver(ConfigParams) - Constructor for class org.pipservices3.components.auth.CredentialResolver
-
Creates a new instance of credentials resolver.
- CredentialResolver(ConfigParams, IReferences) - Constructor for class org.pipservices3.components.auth.CredentialResolver
-
Creates a new instance of credentials resolver.
D
- debug(String, String, Object...) - Method in interface org.pipservices3.components.log.ILogger
-
Logs a high-level debug information for troubleshooting.
- debug(String, String, Object...) - Method in class org.pipservices3.components.log.Logger
-
Logs a high-level debug information for troubleshooting.
- debug(String, String, Object...) - Method in class org.pipservices3.components.log.NullLogger
-
Logs a high-level debug information for troubleshooting.
- Debug - Enum constant in enum class org.pipservices3.components.log.LogLevel
-
Log everything except traces
- DefaultCacheFactory - Class in org.pipservices3.components.cache
-
Creates
ICachecomponents by their descriptors. - DefaultCacheFactory() - Constructor for class org.pipservices3.components.cache.DefaultCacheFactory
-
Create a new instance of the factory.
- DefaultConfigReaderFactory - Class in org.pipservices3.components.config
-
Creates
IConfigReadercomponents by their descriptors. - DefaultConfigReaderFactory() - Constructor for class org.pipservices3.components.config.DefaultConfigReaderFactory
-
Create a new instance of the factory.
- DefaultCountersFactory - Class in org.pipservices3.components.count
-
Creates
ICounterscomponents by their descriptors. - DefaultCountersFactory() - Constructor for class org.pipservices3.components.count.DefaultCountersFactory
-
Create a new instance of the factory.
- DefaultCredentialStoreFactory - Class in org.pipservices3.components.auth
-
Creates ICredentialStore components by their descriptors.
- DefaultCredentialStoreFactory() - Constructor for class org.pipservices3.components.auth.DefaultCredentialStoreFactory
-
Create a new instance of the factory.
- DefaultDiscoveryFactory - Class in org.pipservices3.components.connect
-
Creates
IDiscoverycomponents by their descriptors. - DefaultDiscoveryFactory() - Constructor for class org.pipservices3.components.connect.DefaultDiscoveryFactory
-
Create a new instance of the factory.
- DefaultInfoFactory - Class in org.pipservices3.components.info
-
Creates information components by their descriptors.
- DefaultInfoFactory() - Constructor for class org.pipservices3.components.info.DefaultInfoFactory
-
Create a new instance of the factory.
- DefaultLoggerFactory - Class in org.pipservices3.components.log
-
Creates
ILoggercomponents by their descriptors. - DefaultLoggerFactory() - Constructor for class org.pipservices3.components.log.DefaultLoggerFactory
-
Create a new instance of the factory.
- DefaultStateStoreFactory - Class in org.pipservices3.components.state
-
Creates
IStateStorecomponents by their descriptors. - DefaultStateStoreFactory() - Constructor for class org.pipservices3.components.state.DefaultStateStoreFactory
-
Create a new instance of the factory.
- DefaultTestFactory - Class in org.pipservices3.components.test
-
Creates test components by their descriptors.
- DefaultTestFactory() - Constructor for class org.pipservices3.components.test.DefaultTestFactory
-
Create a new instance of the factory.
- DefaultTracerFactory - Class in org.pipservices3.components.trace
-
Creates
ITracercomponents by their descriptors. - DefaultTracerFactory() - Constructor for class org.pipservices3.components.trace.DefaultTracerFactory
-
Create a new instance of the factory.
- delete(String, String) - Method in interface org.pipservices3.components.state.IStateStore
-
Deletes a state from the store by its key.
- delete(String, String) - Method in class org.pipservices3.components.state.MemoryStateStore
-
Deletes a state from the store by its key.
- delete(String, String) - Method in class org.pipservices3.components.state.NullStateStore
-
Deletes a state from the store by its key.
- Descriptor - Static variable in class org.pipservices3.components.cache.DefaultCacheFactory
- Descriptor - Static variable in class org.pipservices3.components.state.DefaultStateStoreFactory
- dump() - Method in class org.pipservices3.components.count.CachedCounters
-
Dumps (saves) the current values of counters.
- dump() - Method in class org.pipservices3.components.log.CachedLogger
-
Dumps (writes) the currently cached log messages.
- dump() - Method in class org.pipservices3.components.trace.CachedTracer
-
Dumps (writes) the currently cached log messages.
- duration - Variable in class org.pipservices3.components.trace.OperationTrace
-
The duration of the operation in milliseconds
E
- endFailure(Exception) - Method in class org.pipservices3.components.trace.TraceTiming
-
Ends timing of a failed block, calculates elapsed time and records the associated trace.
- endTiming() - Method in class org.pipservices3.components.count.CounterTiming
-
Ends timing of an execution block, calculates elapsed time and updates the associated counter.
- endTiming(String, float) - Method in class org.pipservices3.components.count.CachedCounters
-
Ends measurement of execution elapsed time and updates specified counter.
- endTiming(String, float) - Method in class org.pipservices3.components.count.CompositeCounters
-
Ends measurement of execution elapsed time and updates specified counter.
- endTiming(String, float) - Method in interface org.pipservices3.components.count.ICounterTimingCallback
-
Ends measurement of execution elapsed time and updates specified counter.
- endTrace() - Method in class org.pipservices3.components.trace.TraceTiming
-
Ends timing of an execution block, calculates elapsed time and records the associated trace.
- error - Variable in class org.pipservices3.components.trace.OperationTrace
-
The description of the captured error
- error(String, Exception) - Method in interface org.pipservices3.components.log.ILogger
-
Logs recoverable application error.
- error(String, Exception) - Method in class org.pipservices3.components.log.Logger
-
Logs recoverable application error.
- error(String, Exception) - Method in class org.pipservices3.components.log.NullLogger
-
Logs recoverable application error.
- error(String, Exception, String, Object...) - Method in interface org.pipservices3.components.log.ILogger
-
Logs recoverable application error.
- error(String, Exception, String, Object...) - Method in class org.pipservices3.components.log.Logger
-
Logs recoverable application error.
- error(String, Exception, String, Object...) - Method in class org.pipservices3.components.log.NullLogger
-
Logs recoverable application error.
- error(String, String, Object...) - Method in interface org.pipservices3.components.log.ILogger
-
Logs recoverable application error.
- error(String, String, Object...) - Method in class org.pipservices3.components.log.Logger
-
Logs recoverable application error.
- error(String, String, Object...) - Method in class org.pipservices3.components.log.NullLogger
-
Logs recoverable application error.
- Error - Enum constant in enum class org.pipservices3.components.log.LogLevel
-
Log all errors.
- exclude(ConfigParams, List<String>) - Static method in class org.pipservices3.components.connect.ConnectionUtils
-
Excludes specified keys from the config parameters.
F
- Factory - Class in org.pipservices3.components.build
-
Basic component factory that creates components using registered types and factory functions.
- Factory() - Constructor for class org.pipservices3.components.build.Factory
- Factory.IComponentFactory - Interface in org.pipservices3.components.build
- failure(String, String, String, Exception, long) - Method in class org.pipservices3.components.trace.CachedTracer
-
Records an operation failure with its name, duration and error
- failure(String, String, String, Exception, long) - Method in class org.pipservices3.components.trace.CompositeTracer
-
Records an operation failure with its name, duration and error
- failure(String, String, String, Exception, long) - Method in interface org.pipservices3.components.trace.ITracer
- failure(String, String, String, Exception, long) - Method in class org.pipservices3.components.trace.LogTracer
-
Records an operation failure with its name, duration and error
- failure(String, String, String, Exception, long) - Method in class org.pipservices3.components.trace.NullTracer
-
Records an operation failure with its name, duration and error
- fatal(String, Exception) - Method in interface org.pipservices3.components.log.ILogger
-
Logs fatal (unrecoverable) message that caused the process to crash.
- fatal(String, Exception) - Method in class org.pipservices3.components.log.Logger
-
Logs fatal (unrecoverable) message that caused the process to crash.
- fatal(String, Exception) - Method in class org.pipservices3.components.log.NullLogger
-
Logs fatal (unrecoverable) message that caused the process to crash.
- fatal(String, Exception, String, Object...) - Method in interface org.pipservices3.components.log.ILogger
-
Logs fatal (unrecoverable) message that caused the process to crash.
- fatal(String, Exception, String, Object...) - Method in class org.pipservices3.components.log.Logger
-
Logs fatal (unrecoverable) message that caused the process to crash.
- fatal(String, Exception, String, Object...) - Method in class org.pipservices3.components.log.NullLogger
-
Logs fatal (unrecoverable) message that caused the process to crash.
- fatal(String, String, Object...) - Method in interface org.pipservices3.components.log.ILogger
-
Logs fatal (unrecoverable) message that caused the process to crash.
- fatal(String, String, Object...) - Method in class org.pipservices3.components.log.Logger
-
Logs fatal (unrecoverable) message that caused the process to crash.
- fatal(String, String, Object...) - Method in class org.pipservices3.components.log.NullLogger
-
Logs fatal (unrecoverable) message that caused the process to crash.
- Fatal - Enum constant in enum class org.pipservices3.components.log.LogLevel
-
Log only fatal errors that cause processes to crash
- FileConfigReader - Class in org.pipservices3.components.config
-
Abstract config reader that reads configuration from a file.
- FileConfigReader() - Constructor for class org.pipservices3.components.config.FileConfigReader
-
Creates a new instance of the config reader.
- FileConfigReader(String) - Constructor for class org.pipservices3.components.config.FileConfigReader
-
Creates a new instance of the config reader.
- finalizeOptions(ConfigParams) - Method in class org.pipservices3.components.connect.CompositeConnectionResolver
-
Finalize merged options This method can be overriden in child classes.
- formatAndWrite(LogLevel, String, Exception, String, Object[]) - Method in class org.pipservices3.components.log.Logger
-
Formats the log message and writes it to the logger destination.
- fromConfig(ConfigParams) - Static method in class org.pipservices3.components.auth.CredentialParams
-
Retrieves a single CredentialParams from configuration parameters from "credential" section.
- fromConfig(ConfigParams) - Static method in class org.pipservices3.components.connect.ConnectionParams
-
Retrieves a single ConnectionParams from configuration parameters from "connection" section.
- fromConfig(ConfigParams) - Static method in class org.pipservices3.components.info.ContextInfo
-
Creates a new ContextInfo and sets its configuration parameters.
- fromConfig(ConfigParams, boolean) - Static method in class org.pipservices3.components.auth.CredentialParams
-
Retrieves a single CredentialParams from configuration parameters from "credential" section.
- fromConfig(ConfigParams, boolean) - Static method in class org.pipservices3.components.connect.ConnectionParams
-
Retrieves a single ConnectionParams from configuration parameters from "connection" section.
- fromString(String) - Static method in class org.pipservices3.components.auth.CredentialParams
-
Creates a new CredentialParams object filled with key-value pairs serialized as a string.
- fromString(String) - Static method in class org.pipservices3.components.connect.ConnectionParams
-
Creates a new ConnectionParams object filled with key-value pairs serialized as a string.
- fromTuples(Object...) - Static method in class org.pipservices3.components.auth.CredentialParams
-
Creates a new CredentialParams object filled with provided key-value pairs called tuples.
- fromTuples(Object...) - Static method in class org.pipservices3.components.connect.ConnectionParams
-
Creates a new ConnectionParams object filled with provided key-value pairs called tuples.
- fromValue(Object) - Static method in class org.pipservices3.components.auth.CredentialParams
-
Creates a new CredentialParams object filled with key-value pairs from specified object.
G
- get(String, int) - Method in class org.pipservices3.components.count.CachedCounters
-
Gets a counter specified by its name.
- getAccessId() - Method in class org.pipservices3.components.auth.CredentialParams
-
Gets the application access id.
- getAccessKey() - Method in class org.pipservices3.components.auth.CredentialParams
-
Gets the application secret key.
- getAll() - Method in class org.pipservices3.components.auth.CredentialResolver
-
Gets all credentials configured in component configuration.
- getAll() - Method in class org.pipservices3.components.connect.ConnectionResolver
-
Gets all connections configured in component configuration.
- getAll() - Method in class org.pipservices3.components.count.CachedCounters
-
Gets all captured counters.
- getAverage() - Method in class org.pipservices3.components.count.Counter
- getContextId() - Method in class org.pipservices3.components.info.ContextInfo
-
Gets the unique context id.
- getCorrelationId() - Method in class org.pipservices3.components.log.LogMessage
- getCount() - Method in class org.pipservices3.components.count.Counter
- getDescription() - Method in class org.pipservices3.components.info.ContextInfo
-
Gets the human-readable description of the context.
- getDiscoveryKey() - Method in class org.pipservices3.components.connect.ConnectionParams
-
Gets the key to retrieve this connection from DiscoveryService.
- getError() - Method in class org.pipservices3.components.log.LogMessage
- getExpiration() - Method in class org.pipservices3.components.cache.CacheEntry
-
Gets the expiration timeout.
- getHost() - Method in class org.pipservices3.components.connect.ConnectionParams
-
Gets the host name or IP address.
- getInterval() - Method in class org.pipservices3.components.count.CachedCounters
-
Gets the counters dump/save interval.
- getKey() - Method in class org.pipservices3.components.cache.CacheEntry
-
Gets the key to locate the cached value.
- getKey() - Method in class org.pipservices3.components.state.StateEntry
-
Gets the key to locate the state value.
- getLast() - Method in class org.pipservices3.components.count.Counter
- getLastUpdateTime() - Method in class org.pipservices3.components.state.StateEntry
-
Gets the last update time.
- getLevel() - Method in interface org.pipservices3.components.log.ILogger
-
Gets the maximum log level.
- getLevel() - Method in class org.pipservices3.components.log.Logger
-
Gets the maximum log level.
- getLevel() - Method in class org.pipservices3.components.log.LogMessage
- getLevel() - Method in class org.pipservices3.components.log.NullLogger
-
Gets the maximum log level.
- getMax() - Method in class org.pipservices3.components.count.Counter
- getMessage() - Method in class org.pipservices3.components.log.LogMessage
- getMin() - Method in class org.pipservices3.components.count.Counter
- getName() - Method in class org.pipservices3.components.count.Counter
- getName() - Method in class org.pipservices3.components.info.ContextInfo
-
Gets the context name.
- getPassword() - Method in class org.pipservices3.components.auth.CredentialParams
-
Get the user password.
- getPath() - Method in class org.pipservices3.components.config.FileConfigReader
-
Get the path to configuration file..
- getPort() - Method in class org.pipservices3.components.connect.ConnectionParams
-
Gets the port number.
- getPortWithDefault(int) - Method in class org.pipservices3.components.connect.ConnectionParams
-
Gets the port number with default value.
- getProperties() - Method in class org.pipservices3.components.info.ContextInfo
-
Gets context additional parameters.
- getProtocol() - Method in class org.pipservices3.components.connect.ConnectionParams
-
Gets the connection protocol.
- getProtocolWithDefault(String) - Method in class org.pipservices3.components.connect.ConnectionParams
-
Gets the connection protocol.
- getSource() - Method in class org.pipservices3.components.log.Logger
-
Gets the source (context) name.
- getSource() - Method in class org.pipservices3.components.log.LogMessage
- getStartTime() - Method in class org.pipservices3.components.info.ContextInfo
-
Gets the context start time.
- getStoreKey() - Method in class org.pipservices3.components.auth.CredentialParams
-
Gets the key to retrieve these credentials from CredentialStore.
- getTime() - Method in class org.pipservices3.components.count.Counter
- getTime() - Method in class org.pipservices3.components.log.LogMessage
- getTimeout() - Method in class org.pipservices3.components.config.CachedConfigReader
- getType() - Method in class org.pipservices3.components.count.Counter
- getUptime() - Method in class org.pipservices3.components.info.ContextInfo
-
Calculates the context uptime as from the start time.
- getUri() - Method in class org.pipservices3.components.connect.ConnectionParams
-
Gets the resource URI or connection string.
- getUsername() - Method in class org.pipservices3.components.auth.CredentialParams
-
Gets the user name.
- getValue() - Method in class org.pipservices3.components.cache.CacheEntry
-
Gets the cached value.
- getValue() - Method in enum class org.pipservices3.components.log.LogLevel
- getValue() - Method in class org.pipservices3.components.state.StateEntry
-
Gets the sstate value.
I
- ICache - Interface in org.pipservices3.components.cache
-
Interface for caches that are used to cache values to improve performance.
- IConfigReader - Interface in org.pipservices3.components.config
-
Interface for configuration readers that retrieve configuration from various sources and make it available for other components.
- ICounters - Interface in org.pipservices3.components.count
-
Interface for performance counters that measure execution metrics.
- ICounterTimingCallback - Interface in org.pipservices3.components.count
-
Interface for a callback to end measurement of execution elapsed time.
- ICredentialStore - Interface in org.pipservices3.components.auth
-
Interface for credential stores which are used to store and lookup credentials to authenticate against external services.
- IDiscovery - Interface in org.pipservices3.components.connect
-
Interface for discovery services which are used to store and resolve connection parameters to connect to external services.
- IFactory - Interface in org.pipservices3.components.build
-
Interface for component factories.
- ILock - Interface in org.pipservices3.components.lock
-
Interface for locks to synchronize work or parallel processes and to prevent collisions.
- ILogger - Interface in org.pipservices3.components.log
-
Interface for logger components that capture execution log messages.
- include(ConfigParams, List<String>) - Static method in class org.pipservices3.components.connect.ConnectionUtils
-
Includes specified keys from the config parameters.
- increment(String, int) - Method in class org.pipservices3.components.count.CachedCounters
-
Increments counter by given value.
- increment(String, int) - Method in class org.pipservices3.components.count.CompositeCounters
-
Increments counter by given value.
- increment(String, int) - Method in interface org.pipservices3.components.count.ICounters
-
Increments counter by given value.
- increment(String, int) - Method in class org.pipservices3.components.count.NullCounters
-
Increments counter by given value.
- Increment - Static variable in class org.pipservices3.components.count.CounterType
-
Counter that increment counters
- incrementOne(String) - Method in class org.pipservices3.components.count.CachedCounters
-
Increments counter by 1.
- incrementOne(String) - Method in class org.pipservices3.components.count.CompositeCounters
-
Increments counter by 1.
- incrementOne(String) - Method in interface org.pipservices3.components.count.ICounters
-
Increments counter by 1.
- incrementOne(String) - Method in class org.pipservices3.components.count.NullCounters
-
Increments counter by 1.
- info(String, String, Object...) - Method in interface org.pipservices3.components.log.ILogger
-
Logs an important information message
- info(String, String, Object...) - Method in class org.pipservices3.components.log.Logger
-
Logs an important information message
- info(String, String, Object...) - Method in class org.pipservices3.components.log.NullLogger
-
Logs an important information message
- Info - Enum constant in enum class org.pipservices3.components.log.LogLevel
-
Log errors and important information messages
- Interval - Static variable in class org.pipservices3.components.count.CounterType
-
Counters that measure execution time intervals
- isExpired() - Method in class org.pipservices3.components.cache.CacheEntry
-
Checks if this value already expired.
- isOpen() - Method in class org.pipservices3.components.test.Shutdown
-
Checks if the component is opened.
- IStateStore - Interface in org.pipservices3.components.state
-
Interface for state storages that are used to store and retrieve transaction states.
- ITracer - Interface in org.pipservices3.components.trace
-
Interface for tracer components that capture operation traces.
J
- JsonConfigReader - Class in org.pipservices3.components.config
-
Config reader that reads configuration from JSON file.
- JsonConfigReader() - Constructor for class org.pipservices3.components.config.JsonConfigReader
-
Creates a new instance of the config reader.
- JsonConfigReader(String) - Constructor for class org.pipservices3.components.config.JsonConfigReader
-
Creates a new instance of the config reader.
- JsonConfigReaderDescriptor - Static variable in class org.pipservices3.components.config.DefaultConfigReaderFactory
K
- key - Variable in class org.pipservices3.components.state.StateValue
-
A unique state key
L
- last(String, float) - Method in class org.pipservices3.components.count.CachedCounters
-
Records the last calculated measurement value.
- last(String, float) - Method in class org.pipservices3.components.count.CompositeCounters
-
Records the last calculated measurement value.
- last(String, float) - Method in interface org.pipservices3.components.count.ICounters
-
Records the last calculated measurement value.
- last(String, float) - Method in class org.pipservices3.components.count.NullCounters
-
Records the last calculated measurement value.
- LastValue - Static variable in class org.pipservices3.components.count.CounterType
-
Counters that keeps the latest measured value
- load(String, String) - Method in interface org.pipservices3.components.state.IStateStore
-
Loads state from the store using its key.
- load(String, String) - Method in class org.pipservices3.components.state.MemoryStateStore
-
Loads state from the store using its key.
- load(String, String) - Method in class org.pipservices3.components.state.NullStateStore
-
Loads state from the store using its key.
- loadBulk(String, List<String>) - Method in interface org.pipservices3.components.state.IStateStore
-
Loads an array of states from the store using their keys.
- loadBulk(String, List<String>) - Method in class org.pipservices3.components.state.MemoryStateStore
-
Loads an array of states from the store using their keys.
- loadBulk(String, List<String>) - Method in class org.pipservices3.components.state.NullStateStore
-
Loads an array of states from the store using their keys.
- Lock - Class in org.pipservices3.components.lock
-
Abstract lock that implements default lock acquisition routine.
- Lock() - Constructor for class org.pipservices3.components.lock.Lock
- log(LogLevel, String, Exception, String, Object...) - Method in interface org.pipservices3.components.log.ILogger
-
Logs a message at specified log level.
- log(LogLevel, String, Exception, String, Object...) - Method in class org.pipservices3.components.log.Logger
-
Logs a message at specified log level.
- log(LogLevel, String, Exception, String, Object...) - Method in class org.pipservices3.components.log.NullLogger
-
Logs a message at specified log level.
- LogCounters - Class in org.pipservices3.components.count
-
Performance counters that periodically dumps counters measurements to logger.
- LogCounters() - Constructor for class org.pipservices3.components.count.LogCounters
-
Creates a new instance of the counters.
- LogCountersDescriptor - Static variable in class org.pipservices3.components.count.DefaultCountersFactory
- Logger - Class in org.pipservices3.components.log
-
Abstract logger that captures and formats log messages.
- Logger() - Constructor for class org.pipservices3.components.log.Logger
-
Creates a new instance of the logger.
- LogLevel - Enum Class in org.pipservices3.components.log
-
Standard log levels.
- LogLevelConverter - Class in org.pipservices3.components.log
-
Helper class to convert log level values.
- LogLevelConverter() - Constructor for class org.pipservices3.components.log.LogLevelConverter
- LogMessage - Class in org.pipservices3.components.log
-
Data object to store captured log messages.
- LogMessage() - Constructor for class org.pipservices3.components.log.LogMessage
- LogMessage(LogLevel, String, String, ErrorDescription, String) - Constructor for class org.pipservices3.components.log.LogMessage
- LogTracer - Class in org.pipservices3.components.trace
-
Tracer that dumps recorded traces to logger.
- LogTracer() - Constructor for class org.pipservices3.components.trace.LogTracer
- lookup(String) - Method in class org.pipservices3.components.auth.CredentialResolver
-
Looks up component credential parameters.
- lookup(String, String) - Method in interface org.pipservices3.components.auth.ICredentialStore
-
Lookups credential parameters by its key.
- lookup(String, String) - Method in class org.pipservices3.components.auth.MemoryCredentialStore
-
Lookups credential parameters by its key.
M
- manyFromConfig(ConfigParams) - Static method in class org.pipservices3.components.auth.CredentialParams
-
Retrieves all CredentialParams from configuration parameters from "credentials" section.
- manyFromConfig(ConfigParams) - Static method in class org.pipservices3.components.connect.ConnectionParams
-
Retrieves all ConnectionParams from configuration parameters from "connections" section.
- manyFromConfig(ConfigParams, boolean) - Static method in class org.pipservices3.components.auth.CredentialParams
-
Retrieves all CredentialParams from configuration parameters from "credentials" section.
- manyFromConfig(ConfigParams, boolean) - Static method in class org.pipservices3.components.connect.ConnectionParams
-
Retrieves all ConnectionParams from configuration parameters from "connections" section.
- MemoryCache - Class in org.pipservices3.components.cache
-
Cache that stores values in the process memory.
- MemoryCache() - Constructor for class org.pipservices3.components.cache.MemoryCache
-
Creates instance of local in-memory cache component
- MemoryCacheDescriptor - Static variable in class org.pipservices3.components.cache.DefaultCacheFactory
- MemoryConfigReader - Class in org.pipservices3.components.config
-
Config reader that stores configuration in memory.
- MemoryConfigReader() - Constructor for class org.pipservices3.components.config.MemoryConfigReader
-
Creates a new instance of config reader.
- MemoryConfigReader(ConfigParams) - Constructor for class org.pipservices3.components.config.MemoryConfigReader
-
Creates a new instance of config reader.
- MemoryConfigReaderDescriptor - Static variable in class org.pipservices3.components.config.DefaultConfigReaderFactory
- MemoryCredentialStore - Class in org.pipservices3.components.auth
-
Credential store that keeps credentials in memory.
- MemoryCredentialStore() - Constructor for class org.pipservices3.components.auth.MemoryCredentialStore
-
Creates a new instance of the credential store.
- MemoryCredentialStore(ConfigParams) - Constructor for class org.pipservices3.components.auth.MemoryCredentialStore
-
Creates a new instance of the credential store.
- MemoryCredentialStoreDescriptor - Static variable in class org.pipservices3.components.auth.DefaultCredentialStoreFactory
- MemoryDiscovery - Class in org.pipservices3.components.connect
-
Discovery service that keeps connections in memory.
- MemoryDiscovery() - Constructor for class org.pipservices3.components.connect.MemoryDiscovery
-
Creates a new instance of discovery service.
- MemoryDiscovery(ConfigParams) - Constructor for class org.pipservices3.components.connect.MemoryDiscovery
-
Creates a new instance of discovery service.
- MemoryDiscoveryDescriptor - Static variable in class org.pipservices3.components.connect.DefaultDiscoveryFactory
- MemoryLock - Class in org.pipservices3.components.lock
-
Lock that is used to synchronize execution within one process using shared memory.
- MemoryLock() - Constructor for class org.pipservices3.components.lock.MemoryLock
- MemoryStateStore - Class in org.pipservices3.components.state
-
State store that keeps states in the process memory.
- MemoryStateStore() - Constructor for class org.pipservices3.components.state.MemoryStateStore
- MemoryStateStoreDescriptor - Static variable in class org.pipservices3.components.state.DefaultStateStoreFactory
- mergeConfigs(List<ConfigParams>) - Static method in class org.pipservices3.components.auth.CredentialParams
-
Merges two or more CredentialParams into one.
- mergeConfigs(ConfigParams...) - Static method in class org.pipservices3.components.auth.CredentialParams
-
Merges two or more CredentialParams into one.
- mergeConnection(ConfigParams, ConnectionParams) - Method in class org.pipservices3.components.connect.CompositeConnectionResolver
-
Merges connection options with connection parameters This method can be overriden in child classes.
- mergeCredential(ConfigParams, CredentialParams) - Method in class org.pipservices3.components.connect.CompositeConnectionResolver
-
Merges connection options with credential parameters This method can be overriden in child classes.
- mergeOptional(ConfigParams, ConfigParams) - Method in class org.pipservices3.components.connect.CompositeConnectionResolver
-
Merges connection options with optional parameters This method can be overriden in child classes.
N
- None - Enum constant in enum class org.pipservices3.components.log.LogLevel
-
Nothing to log
- NullCache - Class in org.pipservices3.components.cache
-
Dummy cache implementation that doesn't do anything.
- NullCache() - Constructor for class org.pipservices3.components.cache.NullCache
-
Creates instance of null cache component.
- NullCacheDescriptor - Static variable in class org.pipservices3.components.cache.DefaultCacheFactory
- NullCounters - Class in org.pipservices3.components.count
-
Dummy implementation of performance counters that doesn't do anything.
- NullCounters() - Constructor for class org.pipservices3.components.count.NullCounters
-
Creates a new instance of the counter.
- NullCountersDescriptor - Static variable in class org.pipservices3.components.count.DefaultCountersFactory
- NullLock - Class in org.pipservices3.components.lock
-
Dummy lock implementation that doesn't do anything.
- NullLock() - Constructor for class org.pipservices3.components.lock.NullLock
- NullLogger - Class in org.pipservices3.components.log
-
Dummy implementation of logger that doesn't do anything.
- NullLogger() - Constructor for class org.pipservices3.components.log.NullLogger
-
Creates a new instance of the logger.
- NullLoggerDescriptor - Static variable in class org.pipservices3.components.log.DefaultLoggerFactory
- NullStateStore - Class in org.pipservices3.components.state
-
Dummy state store implementation that doesn't do anything.
- NullStateStore() - Constructor for class org.pipservices3.components.state.NullStateStore
- NullStateStoreDescriptor - Static variable in class org.pipservices3.components.state.DefaultStateStoreFactory
- NullTracer - Class in org.pipservices3.components.trace
-
Dummy implementation of tracer that doesn't do anything.
- NullTracer() - Constructor for class org.pipservices3.components.trace.NullTracer
O
- open(String) - Method in class org.pipservices3.components.test.Shutdown
-
Opens the component.
- operation - Variable in class org.pipservices3.components.trace.OperationTrace
-
The name of the executed operation
- OperationTrace - Class in org.pipservices3.components.trace
-
Data object to store captured operation traces.
- OperationTrace() - Constructor for class org.pipservices3.components.trace.OperationTrace
- OperationTrace(ZonedDateTime, String, String, String, String, long, ErrorDescription) - Constructor for class org.pipservices3.components.trace.OperationTrace
- org.pipservices3.components - package org.pipservices3.components
- org.pipservices3.components.auth - package org.pipservices3.components.auth
- org.pipservices3.components.build - package org.pipservices3.components.build
- org.pipservices3.components.cache - package org.pipservices3.components.cache
- org.pipservices3.components.config - package org.pipservices3.components.config
- org.pipservices3.components.connect - package org.pipservices3.components.connect
- org.pipservices3.components.count - package org.pipservices3.components.count
- org.pipservices3.components.info - package org.pipservices3.components.info
- org.pipservices3.components.lock - package org.pipservices3.components.lock
- org.pipservices3.components.log - package org.pipservices3.components.log
- org.pipservices3.components.state - package org.pipservices3.components.state
- org.pipservices3.components.test - package org.pipservices3.components.test
- org.pipservices3.components.trace - package org.pipservices3.components.trace
P
- parameterize(String, ConfigParams) - Static method in class org.pipservices3.components.config.ConfigReader
-
Parameterized configuration template given as string with dynamic parameters.
- parseUri(String, String, int) - Static method in class org.pipservices3.components.connect.ConnectionUtils
-
Parses URI into config parameters.
- performReadConfig(String, ConfigParams) - Method in class org.pipservices3.components.config.CachedConfigReader
R
- readConfig(String, String, ConfigParams) - Static method in class org.pipservices3.components.config.JsonConfigReader
-
Reads configuration from a file, parameterize it with given values and returns a new ConfigParams object.
- readConfig(String, String, ConfigParams) - Static method in class org.pipservices3.components.config.YamlConfigReader
-
Reads configuration from a file, parameterize it with given values and returns a new ConfigParams object.
- readConfig(String, ConfigParams) - Method in class org.pipservices3.components.config.CachedConfigReader
- readConfig(String, ConfigParams) - Method in class org.pipservices3.components.config.ConfigReader
-
Reads configuration and parameterize it with given values.
- readConfig(String, ConfigParams) - Method in interface org.pipservices3.components.config.IConfigReader
-
Reads configuration and parameterize it with given values.
- readConfig(String, ConfigParams) - Method in class org.pipservices3.components.config.JsonConfigReader
-
Reads configuration and parameterize it with given values.
- readConfig(String, ConfigParams) - Method in class org.pipservices3.components.config.MemoryConfigReader
-
Reads configuration and parameterize it with given values.
- readConfig(String, ConfigParams) - Method in class org.pipservices3.components.config.YamlConfigReader
-
Reads configuration and parameterize it with given values.
- readConfigSection(String, String) - Method in class org.pipservices3.components.config.MemoryConfigReader
- readConfigSection(String, ConfigParams, String) - Method in class org.pipservices3.components.config.CachedConfigReader
- readConnections(ConfigParams) - Method in class org.pipservices3.components.connect.MemoryDiscovery
-
Reads connections from configuration parameters.
- readCredentials(ConfigParams) - Method in class org.pipservices3.components.auth.MemoryCredentialStore
-
Reads config from configuration parameters.
- readObject(String, String, ConfigParams) - Static method in class org.pipservices3.components.config.JsonConfigReader
-
Reads configuration file, parameterizes its content and converts it into JSON object.
- readObject(String, String, ConfigParams) - Static method in class org.pipservices3.components.config.YamlConfigReader
-
Reads configuration file, parameterizes its content and converts it into JSON object.
- readObject(String, ConfigParams) - Method in class org.pipservices3.components.config.JsonConfigReader
-
Reads configuration file, parameterizes its content and converts it into JSON object.
- readObject(String, ConfigParams) - Method in class org.pipservices3.components.config.YamlConfigReader
-
Reads configuration file, parameterizes its content and converts it into JSON object.
- register(Object, Factory.IComponentFactory) - Method in class org.pipservices3.components.build.Factory
-
Registers a component using a factory method.
- register(String, String, ConnectionParams) - Method in interface org.pipservices3.components.connect.IDiscovery
-
Registers connection parameters into the discovery service.
- register(String, String, ConnectionParams) - Method in class org.pipservices3.components.connect.MemoryDiscovery
-
Registers connection parameters into the discovery service.
- register(String, ConnectionParams) - Method in class org.pipservices3.components.connect.ConnectionResolver
-
Registers the given connection in all referenced discovery services.
- registerAsType(Object, Class<?>) - Method in class org.pipservices3.components.build.Factory
-
Registers a component using its type (a constructor function).
- releaseLock(String, String) - Method in interface org.pipservices3.components.lock.ILock
-
Releases prevously acquired lock by its key.
- releaseLock(String, String) - Method in class org.pipservices3.components.lock.Lock
-
Releases prevously acquired lock by its key.
- releaseLock(String, String) - Method in class org.pipservices3.components.lock.MemoryLock
-
Releases the lock with the given key.
- releaseLock(String, String) - Method in class org.pipservices3.components.lock.NullLock
-
Releases prevously acquired lock by its key.
- remove(String, String) - Method in interface org.pipservices3.components.cache.ICache
-
Removes a value from the cache by its key.
- remove(String, String) - Method in class org.pipservices3.components.cache.MemoryCache
-
Removes a value from the cache by its key.
- remove(String, String) - Method in class org.pipservices3.components.cache.NullCache
-
Removes a value from the cache by its key.
- remove(IFactory) - Method in class org.pipservices3.components.build.CompositeFactory
-
Removes a factory from the list of embedded factories.
- removeChangeListener(INotifiable) - Method in class org.pipservices3.components.config.ConfigReader
-
Remove a previously added change listener.
- removeChangeListener(INotifiable) - Method in interface org.pipservices3.components.config.IConfigReader
-
Remove a previously added change listener.
- removeChangeListener(INotifiable) - Method in class org.pipservices3.components.config.MemoryConfigReader
-
Remove a previously added change listener.
- rename(ConfigParams, String, String) - Static method in class org.pipservices3.components.connect.ConnectionUtils
-
Renames property if the target name is not used.
- resolve(String) - Method in class org.pipservices3.components.connect.CompositeConnectionResolver
- resolve(String) - Method in class org.pipservices3.components.connect.ConnectionResolver
-
Resolves a single component connection.
- resolveAll(String) - Method in class org.pipservices3.components.connect.ConnectionResolver
-
Resolves all component connection.
- resolveAll(String, String) - Method in interface org.pipservices3.components.connect.IDiscovery
-
Resolves all connection parameters by their key.
- resolveAll(String, String) - Method in class org.pipservices3.components.connect.MemoryDiscovery
-
Resolves all connection parameters by their key.
- resolveOne(String, String) - Method in interface org.pipservices3.components.connect.IDiscovery
-
Resolves a single connection parameters by its key.
- resolveOne(String, String) - Method in class org.pipservices3.components.connect.MemoryDiscovery
-
Resolves a single connection parameters by its key.
- retrieve(String, String) - Method in interface org.pipservices3.components.cache.ICache
-
Retrieves cached value from the cache using its key.
- retrieve(String, String) - Method in class org.pipservices3.components.cache.MemoryCache
-
Retrieves cached value from the cache using its key.
- retrieve(String, String) - Method in class org.pipservices3.components.cache.NullCache
-
Retrieves cached value from the cache using its key.
S
- save(String, String, T) - Method in interface org.pipservices3.components.state.IStateStore
-
Saves state into the store.
- save(String, String, T) - Method in class org.pipservices3.components.state.MemoryStateStore
-
Saves state into the store
- save(String, String, T) - Method in class org.pipservices3.components.state.NullStateStore
-
Saves state into the store.
- save(List<Counter>) - Method in class org.pipservices3.components.count.CachedCounters
-
Saves the current counters measurements.
- save(List<Counter>) - Method in class org.pipservices3.components.count.LogCounters
-
Saves the current counters measurements.
- save(List<LogMessage>) - Method in class org.pipservices3.components.log.CachedLogger
-
Saves log messages from the cache.
- save(List<OperationTrace>) - Method in class org.pipservices3.components.trace.CachedTracer
-
Saves log messages from the cache.
- setAccessId(String) - Method in class org.pipservices3.components.auth.CredentialParams
-
Sets the application access id.
- setAccessKey(String) - Method in class org.pipservices3.components.auth.CredentialParams
-
Sets the application secret key.
- setAverage(Float) - Method in class org.pipservices3.components.count.Counter
- setContextId(String) - Method in class org.pipservices3.components.info.ContextInfo
-
Sets the unique context id.
- setCorrelationId(String) - Method in class org.pipservices3.components.log.LogMessage
- setCount(Integer) - Method in class org.pipservices3.components.count.Counter
- setDescription(String) - Method in class org.pipservices3.components.info.ContextInfo
-
Sets the human-readable description of the context.
- setDiscoveryKey(String) - Method in class org.pipservices3.components.connect.ConnectionParams
-
Sets the key to retrieve these parameters from DiscoveryService.
- setError(ErrorDescription) - Method in class org.pipservices3.components.log.LogMessage
- setHost(String) - Method in class org.pipservices3.components.connect.ConnectionParams
-
Sets the host name or IP address.
- setInterval(long) - Method in class org.pipservices3.components.count.CachedCounters
-
Gets the counters dump/save interval.
- setLast(Float) - Method in class org.pipservices3.components.count.Counter
- setLevel(LogLevel) - Method in interface org.pipservices3.components.log.ILogger
-
Set the maximum log level.
- setLevel(LogLevel) - Method in class org.pipservices3.components.log.Logger
-
Set the maximum log level.
- setLevel(LogLevel) - Method in class org.pipservices3.components.log.LogMessage
- setLevel(LogLevel) - Method in class org.pipservices3.components.log.NullLogger
-
Set the maximum log level.
- setMax(Float) - Method in class org.pipservices3.components.count.Counter
- setMessage(String) - Method in class org.pipservices3.components.log.LogMessage
- setMin(Float) - Method in class org.pipservices3.components.count.Counter
- setName(String) - Method in class org.pipservices3.components.count.Counter
- setName(String) - Method in class org.pipservices3.components.info.ContextInfo
-
Sets the context name.
- setPassword(String) - Method in class org.pipservices3.components.auth.CredentialParams
-
Sets the user password.
- setPath(String) - Method in class org.pipservices3.components.config.FileConfigReader
-
Set the path to configuration file.
- setPort(int) - Method in class org.pipservices3.components.connect.ConnectionParams
-
Sets the port number.
- setProperties(StringValueMap) - Method in class org.pipservices3.components.info.ContextInfo
-
Sets context additional parameters.
- setProtocol(String) - Method in class org.pipservices3.components.connect.ConnectionParams
-
Sets the connection protocol.
- setReferences(IReferences) - Method in class org.pipservices3.components.auth.CredentialResolver
-
Sets references to dependent components.
- setReferences(IReferences) - Method in class org.pipservices3.components.Component
-
Sets references to dependent components.
- setReferences(IReferences) - Method in class org.pipservices3.components.connect.CompositeConnectionResolver
-
Sets references to dependent components.
- setReferences(IReferences) - Method in class org.pipservices3.components.connect.ConnectionResolver
-
Sets references to dependent components.
- setReferences(IReferences) - Method in class org.pipservices3.components.count.CompositeCounters
-
Sets references to dependent components.
- setReferences(IReferences) - Method in class org.pipservices3.components.count.LogCounters
-
Sets references to dependent components.
- setReferences(IReferences) - Method in class org.pipservices3.components.log.CompositeLogger
-
Sets references to dependent components.
- setReferences(IReferences) - Method in class org.pipservices3.components.log.Logger
-
Sets references to dependent components.
- setReferences(IReferences) - Method in class org.pipservices3.components.trace.CachedTracer
-
Sets references to dependent components.
- setReferences(IReferences) - Method in class org.pipservices3.components.trace.CompositeTracer
-
Sets references to dependent components.
- setReferences(IReferences) - Method in class org.pipservices3.components.trace.LogTracer
-
Sets references to dependent components.
- setSource(String) - Method in class org.pipservices3.components.log.Logger
-
Sets the source (context) name.
- setSource(String) - Method in class org.pipservices3.components.log.LogMessage
- setStartTime(ZonedDateTime) - Method in class org.pipservices3.components.info.ContextInfo
-
Sets the context start time.
- setStoreKey(String) - Method in class org.pipservices3.components.auth.CredentialParams
-
Sets the key to retrieve these parameters from CredentialStore.
- setTime(ZonedDateTime) - Method in class org.pipservices3.components.count.Counter
- setTime(ZonedDateTime) - Method in class org.pipservices3.components.log.LogMessage
- setTimeout(long) - Method in class org.pipservices3.components.config.CachedConfigReader
- setType(int) - Method in class org.pipservices3.components.count.Counter
- setUri(String) - Method in class org.pipservices3.components.connect.ConnectionParams
-
Sets the resource URI or connection string.
- setUsername(String) - Method in class org.pipservices3.components.auth.CredentialParams
-
Sets the user name.
- setValue(Object) - Method in class org.pipservices3.components.state.StateEntry
-
Sets a new state value.
- setValue(Object, long) - Method in class org.pipservices3.components.cache.CacheEntry
-
Sets a new value and extends its expiration.
- shutdown() - Method in class org.pipservices3.components.test.Shutdown
-
Crashes the process using the configured crash mode.
- Shutdown - Class in org.pipservices3.components.test
-
Random shutdown component that crashes the process using various methods.
- Shutdown() - Constructor for class org.pipservices3.components.test.Shutdown
- source - Variable in class org.pipservices3.components.trace.OperationTrace
-
The source (context name)
- StateEntry - Class in org.pipservices3.components.state
-
Data object to store state values with their keys used by
StateEntry - StateEntry(String, Object) - Constructor for class org.pipservices3.components.state.StateEntry
- StateValue<T> - Class in org.pipservices3.components.state
-
A data object that holds a retrieved state value with its key.
- StateValue() - Constructor for class org.pipservices3.components.state.StateValue
- StateValue(String, T) - Constructor for class org.pipservices3.components.state.StateValue
- Statistics - Static variable in class org.pipservices3.components.count.CounterType
-
Counters that measure min/average/max statistics
- stats(String, float) - Method in class org.pipservices3.components.count.CachedCounters
-
Calculates min/average/max statistics based on the current and previous values.
- stats(String, float) - Method in class org.pipservices3.components.count.CompositeCounters
-
Calculates min/average/max statistics based on the current and previous values.
- stats(String, float) - Method in interface org.pipservices3.components.count.ICounters
-
Calculates min/average/max statistics based on the current and previous values.
- stats(String, float) - Method in class org.pipservices3.components.count.NullCounters
-
Calculates min/average/max statistics based on the current and previous values.
- store(String, String, Object, long) - Method in interface org.pipservices3.components.cache.ICache
-
Stores value in the cache with expiration time.
- store(String, String, Object, long) - Method in class org.pipservices3.components.cache.MemoryCache
-
Stores value in the cache with expiration time.
- store(String, String, Object, long) - Method in class org.pipservices3.components.cache.NullCache
-
Stores value in the cache with expiration time.
- store(String, String, CredentialParams) - Method in interface org.pipservices3.components.auth.ICredentialStore
-
Stores credential parameters into the store.
- store(String, String, CredentialParams) - Method in class org.pipservices3.components.auth.MemoryCredentialStore
-
Stores credential parameters into the store.
T
- time - Variable in class org.pipservices3.components.trace.OperationTrace
-
The time when operation was executed
- timestamp(String, ZonedDateTime) - Method in class org.pipservices3.components.count.CachedCounters
-
Records the given timestamp.
- timestamp(String, ZonedDateTime) - Method in class org.pipservices3.components.count.CompositeCounters
-
Records the given timestamp.
- timestamp(String, ZonedDateTime) - Method in interface org.pipservices3.components.count.ICounters
-
Records the given timestamp.
- timestamp(String, ZonedDateTime) - Method in class org.pipservices3.components.count.NullCounters
-
Records the given timestamp.
- Timestamp - Static variable in class org.pipservices3.components.count.CounterType
-
Counter that record timestamps
- timestampNow(String) - Method in class org.pipservices3.components.count.CachedCounters
-
Records the current time as a timestamp.
- timestampNow(String) - Method in class org.pipservices3.components.count.CompositeCounters
-
Records the current time as a timestamp.
- timestampNow(String) - Method in interface org.pipservices3.components.count.ICounters
-
Records the current time as a timestamp.
- timestampNow(String) - Method in class org.pipservices3.components.count.NullCounters
-
Records the current time as a timestamp.
- toInteger(LogLevel) - Static method in class org.pipservices3.components.log.LogLevelConverter
-
Converts log level to a number.
- toLogLevel(Object) - Static method in class org.pipservices3.components.log.LogLevelConverter
-
Converts numbers and strings to standard log level values.
- toLogLevel(Object, LogLevel) - Static method in class org.pipservices3.components.log.LogLevelConverter
-
Converts numbers and strings to standard log level values.
- toString(LogLevel) - Static method in class org.pipservices3.components.log.LogLevelConverter
-
Converts log level to a string.
- trace(String, String, Object...) - Method in interface org.pipservices3.components.log.ILogger
-
Logs a low-level debug information for troubleshooting.
- trace(String, String, Object...) - Method in class org.pipservices3.components.log.Logger
-
Logs a low-level debug information for troubleshooting.
- trace(String, String, Object...) - Method in class org.pipservices3.components.log.NullLogger
-
Logs a low-level debug information for troubleshooting.
- trace(String, String, String, Long) - Method in class org.pipservices3.components.trace.CachedTracer
-
Records an operation trace with its name and duration
- trace(String, String, String, Long) - Method in class org.pipservices3.components.trace.CompositeTracer
-
Records an operation trace with its name and duration
- trace(String, String, String, Long) - Method in interface org.pipservices3.components.trace.ITracer
- trace(String, String, String, Long) - Method in class org.pipservices3.components.trace.LogTracer
-
Records an operation trace with its name and duration
- trace(String, String, String, Long) - Method in class org.pipservices3.components.trace.NullTracer
-
Records an operation trace with its name and duration
- Trace - Enum constant in enum class org.pipservices3.components.log.LogLevel
-
Log everything.
- TraceTiming - Class in org.pipservices3.components.trace
-
Timing object returned by
ITracer.beginTrace(java.lang.String, java.lang.String, java.lang.String)to end timing of execution block and record the associated trace. - TraceTiming(String, String, String) - Constructor for class org.pipservices3.components.trace.TraceTiming
- TraceTiming(String, String, String, ITracer) - Constructor for class org.pipservices3.components.trace.TraceTiming
-
Creates a new instance of the timing callback object.
- tryAcquireLock(String, String, int) - Method in interface org.pipservices3.components.lock.ILock
-
Makes a single attempt to acquire a lock by its key.
- tryAcquireLock(String, String, int) - Method in class org.pipservices3.components.lock.Lock
-
Makes a single attempt to acquire a lock by its key.
- tryAcquireLock(String, String, int) - Method in class org.pipservices3.components.lock.MemoryLock
-
Makes a single attempt to acquire a lock by its key.
- tryAcquireLock(String, String, int) - Method in class org.pipservices3.components.lock.NullLock
-
Makes a single attempt to acquire a lock by its key.
U
- update() - Method in class org.pipservices3.components.count.CachedCounters
-
Makes counter measurements as updated and dumps them when timeout expires.
- update() - Method in class org.pipservices3.components.log.CachedLogger
-
Makes message cache as updated and dumps it when timeout expires.
- update() - Method in class org.pipservices3.components.trace.CachedTracer
-
Makes trace cache as updated and dumps it when timeout expires.
- useCredentialStore() - Method in class org.pipservices3.components.auth.CredentialParams
-
Checks if these credential parameters shall be retrieved from CredentialStore.
- useDiscovery() - Method in class org.pipservices3.components.connect.ConnectionParams
-
Checks if these connection parameters shall be retrieved from DiscoveryService.
V
- validateConnection(String, ConnectionParams) - Method in class org.pipservices3.components.connect.CompositeConnectionResolver
- validateCredential(String, CredentialParams) - Method in class org.pipservices3.components.connect.CompositeConnectionResolver
-
Validates credential parameters and throws an exception on error.
- value - Variable in class org.pipservices3.components.state.StateValue
-
A stored state value;
- valueOf(String) - Static method in enum class org.pipservices3.components.log.LogLevel
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.pipservices3.components.log.LogLevel
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- warn(String, String, Object...) - Method in interface org.pipservices3.components.log.ILogger
-
Logs a warning that may or may not have a negative impact.
- warn(String, String, Object...) - Method in class org.pipservices3.components.log.Logger
-
Logs a warning that may or may not have a negative impact.
- warn(String, String, Object...) - Method in class org.pipservices3.components.log.NullLogger
-
Logs a warning that may or may not have a negative impact.
- Warn - Enum constant in enum class org.pipservices3.components.log.LogLevel
-
Log errors and warnings
- write(String, String, String, Exception, long) - Method in class org.pipservices3.components.trace.CachedTracer
-
Writes a log message to the logger destination.
- write(LogLevel, String, Exception, String) - Method in class org.pipservices3.components.log.CachedLogger
-
Writes a log message to the logger destination.
- write(LogLevel, String, Exception, String) - Method in class org.pipservices3.components.log.CompositeLogger
-
Writes a log message to the logger destination(s).
- write(LogLevel, String, Exception, String) - Method in class org.pipservices3.components.log.ConsoleLogger
-
Writes a log message to the logger destination.
- write(LogLevel, String, Exception, String) - Method in class org.pipservices3.components.log.Logger
-
Writes a log message to the logger destination.
Y
- YamlConfigReader - Class in org.pipservices3.components.config
-
Config reader that reads configuration from YAML file.
- YamlConfigReader() - Constructor for class org.pipservices3.components.config.YamlConfigReader
-
Creates a new instance of the config reader.
- YamlConfigReader(String) - Constructor for class org.pipservices3.components.config.YamlConfigReader
-
Creates a new instance of the config reader.
- YamlConfigReaderDescriptor - Static variable in class org.pipservices3.components.config.DefaultConfigReaderFactory
_
- _cache - Variable in class org.pipservices3.components.log.CachedLogger
- _cache - Variable in class org.pipservices3.components.trace.CachedTracer
- _clusterSupported - Variable in class org.pipservices3.components.connect.CompositeConnectionResolver
-
The cluster support (multiple connections)
- _config - Variable in class org.pipservices3.components.config.MemoryConfigReader
- _connectionResolver - Variable in class org.pipservices3.components.connect.CompositeConnectionResolver
-
The connections resolver.
- _counters - Variable in class org.pipservices3.components.Component
- _credentialResolver - Variable in class org.pipservices3.components.connect.CompositeConnectionResolver
-
The credentials resolver.
- _defaultPort - Variable in class org.pipservices3.components.connect.CompositeConnectionResolver
-
The default port number
- _defaultProtocol - Variable in class org.pipservices3.components.connect.CompositeConnectionResolver
-
The default protocol
- _dependencyResolver - Variable in class org.pipservices3.components.Component
- _interval - Variable in class org.pipservices3.components.log.CachedLogger
- _interval - Variable in class org.pipservices3.components.trace.CachedTracer
- _lastDumpTime - Variable in class org.pipservices3.components.log.CachedLogger
- _lastDumpTime - Variable in class org.pipservices3.components.trace.CachedTracer
- _lastResetTime - Variable in class org.pipservices3.components.count.CachedCounters
- _lock - Variable in class org.pipservices3.components.log.CachedLogger
- _logger - Variable in class org.pipservices3.components.Component
- _maxCacheSize - Variable in class org.pipservices3.components.log.CachedLogger
- _maxCacheSize - Variable in class org.pipservices3.components.trace.CachedTracer
- _options - Variable in class org.pipservices3.components.connect.CompositeConnectionResolver
-
The connection options
- _path - Variable in class org.pipservices3.components.config.FileConfigReader
- _resetTimeout - Variable in class org.pipservices3.components.count.CachedCounters
- _source - Variable in class org.pipservices3.components.log.Logger
- _source - Variable in class org.pipservices3.components.trace.CachedTracer
- _tracer - Variable in class org.pipservices3.components.Component
- _tracers - Variable in class org.pipservices3.components.trace.CompositeTracer
- _updated - Variable in class org.pipservices3.components.log.CachedLogger
- _updated - Variable in class org.pipservices3.components.trace.CachedTracer
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form