Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- after - Variable in class de.iip_ecosphere.platform.services.environment.spring.Starter.ServiceForMapping
- augmentByAppId(String[]) - Static method in class de.iip_ecosphere.platform.services.environment.spring.Starter
-
Augments the command line arguments by spring cloud stream binder destination args containing the application id if
Starter.getAppId()is given. - augmentByAppId(String[], String, Supplier<InputStream>) - Static method in class de.iip_ecosphere.platform.services.environment.spring.Starter
-
Augments the command line arguments by spring cloud stream binder destination args containing the application id if given.
C
- calculateMetrics() - Method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProvider
-
This operation calculates the values for the extra system metrics not exposed by Micrometer-API.
Even though this sacrifices the real time values of these metrics, we gain speed when requesting the metrics as we no longer have to calculate the values upon request. - callback - Variable in class de.iip_ecosphere.platform.services.environment.spring.SpringAsyncServiceBase.InstalledCallback
- callbacks - Variable in class de.iip_ecosphere.platform.services.environment.spring.SpringAsyncServiceBase
- changeDiskBaseUnit(String) - Method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProviderRestService
-
Changes the base unit for the disk capacity metrics of the system.
The body will contain a single string that has a validCapacityBaseUnit. - changeMemoryBaseUnit(String) - Method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProviderRestService
-
Changes the base unit for the physical memory metrics of the system.
The body will contain a single string that has a validCapacityBaseUnit. - channel - Variable in class de.iip_ecosphere.platform.services.environment.spring.SpringAsyncServiceBase.InstalledCallback
- connector - Variable in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProvider
- connectorFailed - Variable in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProvider
- createMetricsClient() - Static method in class de.iip_ecosphere.platform.services.environment.spring.Starter
-
Creates a metrics client based on the known Spring environment.
- createMetricsClient(Environment) - Static method in class de.iip_ecosphere.platform.services.environment.spring.Starter
-
Creates a metrics client.
- createReceptionCallback(String, Consumer<T>, Class<T>) - Method in class de.iip_ecosphere.platform.services.environment.spring.SpringAsyncServiceBase
-
Creates a reception callback.
- createReceptionCallback(String, Consumer<T>, Class<T>, String) - Method in class de.iip_ecosphere.platform.services.environment.spring.SpringAsyncServiceBase
-
Creates a reception callback.
- createServices(YamlArtifact) - Method in class de.iip_ecosphere.platform.services.environment.spring.Starter
-
Creates the relevant services from the given
artifact. - ctx - Static variable in class de.iip_ecosphere.platform.services.environment.spring.Starter
D
- de.iip_ecosphere.platform.services.environment.spring - package de.iip_ecosphere.platform.services.environment.spring
-
Spring cloud stream specific service environment.
- de.iip_ecosphere.platform.services.environment.spring.metricsProvider - package de.iip_ecosphere.platform.services.environment.spring.metricsProvider
-
Specific additions to the metrics provider through Spring Cloud Stream.
- deleteCounter(String) - Method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProviderRestService
-
Deletes a custom counter.
The custom counter is deleted and removed from the registry, similar to the execution ofMetricsProvider.removeCounter(String). - deleteGauge(String) - Method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProviderRestService
-
Deletes a custom gauge.
The custom gauge is deleted and removed from the registry, similar to the execution ofMetricsProvider.removeGauge(String). - deleteTimer(String) - Method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProviderRestService
-
Deletes a custom timer.
The custom timer is deleted and removed from the registry, similar to the execution ofMetricsProvider.removeTimer(String). - DEPLOYMENT_DESC - Static variable in class de.iip_ecosphere.platform.services.environment.spring.Starter
- destroy() - Method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProvider
-
Clean up at shutdown.
- destroy() - Method in class de.iip_ecosphere.platform.services.environment.spring.SpringAsyncServiceBase
-
Called at end of lifecycle to get rid of callbacks.
- detach() - Method in class de.iip_ecosphere.platform.services.environment.spring.SpringAsyncServiceBase
-
Detach all callbacks.
- determineStartupSequence() - Static method in class de.iip_ecosphere.platform.services.environment.spring.Starter
-
In
autostart mode, determine an enforced service startup sequence. - diskBaseUnitString - Variable in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProvider
E
- ensureSetup() - Method in class de.iip_ecosphere.platform.services.environment.spring.SpringAsyncServiceBase
-
Ensures the setup data.
- ensureSetup() - Method in class de.iip_ecosphere.platform.services.environment.spring.TestSpringBroker.MyServiceBase
- environment - Static variable in class de.iip_ecosphere.platform.services.environment.spring.Starter
- expectedServiceCount - Static variable in class de.iip_ecosphere.platform.services.environment.spring.Starter
- EXTERNAL_BINDER_NAME - Static variable in class de.iip_ecosphere.platform.services.environment.spring.Starter
G
- getAppInstIdSuffix(Service, String) - Static method in class de.iip_ecosphere.platform.services.environment.spring.SpringAsyncServiceBase
-
Composes a channel suffix id for a service possibly including the application instance id.
- getContext() - Static method in class de.iip_ecosphere.platform.services.environment.spring.Starter
-
Returns the application context.
- getCounter(String) - Method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProviderRestService
-
Retrieves a custom counter.
- getCustomCounterList() - Method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProviderRestService
-
Retrieves a list of all the custom counters present in the Metrics Provider.
- getCustomGaugeList() - Method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProviderRestService
-
Retrieves a list of all the custom gauges present in the Metrics Provider.
- getEnvironment() - Method in class de.iip_ecosphere.platform.services.environment.spring.Starter
-
Returns the spring environment.
- getExternalTransportSetup(InputStream, String[]) - Static method in class de.iip_ecosphere.platform.services.environment.spring.YamlSetup
-
Reads
inas YAML file and searches for the Spring definition of the "external" binder. - getExternalTransportSetup(String[]) - Static method in class de.iip_ecosphere.platform.services.environment.spring.YamlSetup
-
Reads the default "application.yml" file and searches for the Spring definition of the "external" binder.
- getGauge(String) - Method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProviderRestService
-
Retrieves a custom gauge.
- getHelp(String) - Method in class de.iip_ecosphere.platform.services.environment.spring.TestSpringBroker
- getInternalTransportSetup(InputStream, String[]) - Static method in class de.iip_ecosphere.platform.services.environment.spring.YamlSetup
-
Reads
inas YAML file and searches for the Spring definition of the "internal" binder. - getInternalTransportSetup(String[]) - Static method in class de.iip_ecosphere.platform.services.environment.spring.YamlSetup
-
Reads the default "application.yml" file and searches for the Spring definition of the "internal" binder.
- getMeter(String) - Method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProviderRestService
-
Retrieves a meter with no tags.
Most of the meters do not have tags, so this method will be used to retrieve most metrics. - getMeter(String, List<Tag>) - Method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProviderRestService
-
Retrieves a JSON Object representation of the meter from the MetricsProvider.
- getMeter(String, MultiValueMap<String, String>) - Method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProviderRestService
-
Retrieves a meter with tags.
As some of the system meters have tags, this method will allow said metrics to be retrieved using the appropriate tags. - getName() - Method in class de.iip_ecosphere.platform.services.environment.spring.SpringResourceResolver
- getSetup(InputStream, String, String[]) - Static method in class de.iip_ecosphere.platform.services.environment.spring.YamlSetup
-
Reads
inas YAML file and searches for the Spring definition of binders. - getSimpleMeterList() - Method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProviderRestService
-
Provides a list of all simple meters registered.
All the simple meters are meters extracted by micrometer and cannot be modified. - getTaggedMeterList() - Method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProviderRestService
-
Provides a list of all tagged meters registered.
All the tagged meters are meters extracted by micrometer and cannot be modified. - getTimer(String) - Method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProviderRestService
-
Retrieves a custom timer.
- getTimerCounterList() - Method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProviderRestService
-
Retrieves a list of all the custom timers present in the Metrics Provider.
I
- id - Variable in class de.iip_ecosphere.platform.services.environment.spring.Starter.ServiceForMapping
- illegalArgumentExceptionHandler(IllegalArgumentException) - Method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.RestAdvice
-
Captures and handles an IllegalArgumentException.
Methods within theMetricsProvidermay throw an IllegalArgumentException if the provided arguments are not valid or suitable for the execution of a certain task. - initialize() - Method in class de.iip_ecosphere.platform.services.environment.spring.Starter
-
Initializes the services (if available), starts the AAS command server.
- InstalledCallback() - Constructor for class de.iip_ecosphere.platform.services.environment.spring.SpringAsyncServiceBase.InstalledCallback
L
- loadPluginSetup(String[]) - Static method in class de.iip_ecosphere.platform.services.environment.spring.YamlSetup
-
Loads the plugin setup if specified, in particular to also disable plugin loading for apps generated/build without plugins.
M
- main(Class<? extends Starter>, String[]) - Static method in class de.iip_ecosphere.platform.services.environment.spring.Starter
-
Main function.
- mapping - Variable in class de.iip_ecosphere.platform.services.environment.spring.Starter.ServiceForMapping
- mapService(Service) - Static method in class de.iip_ecosphere.platform.services.environment.spring.Starter
-
Maps a service through the default mapper and the default metrics client.
- mapService(Service, Runnable) - Static method in class de.iip_ecosphere.platform.services.environment.spring.Starter
-
Maps a service through the default mapper and the default metrics client.
- memoryBaseUnitString - Variable in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProvider
- metricsProvider - Variable in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProviderRestService
- MetricsProvider - Class in de.iip_ecosphere.platform.services.environment.spring.metricsProvider
-
This class represents an interface to manage the Micrometer-API meters.
An instance of this class is auto-wired into the Stream Application and will act as a metrics provider for the service application.
The operations available in this class are: Consulting the amount of custom meters of each type Modifying, consulting or deleting a custom gauge Modifying, consulting or deleting a custom counter Modifying, consulting or deleting a custom timer Consult the current capacity base unit for the Memory and Disk metrics It is recommended to use the dot notation to name the meters, i.e. - MetricsProvider() - Constructor for class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProvider
-
Create a new Metrics Provider Instance.
The Metrics Provider will have a map of metrics that can be operated by the client via the appropriate methods, allowing the user to add new custom metrics when needed and manipulate them in a uniform manner. - MetricsProvider(MeterRegistry) - Constructor for class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProvider
-
Create a new Metrics Provider Instance.
- MetricsProvider(MeterRegistry) - Constructor for class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProvider
-
Create a new Metrics Provider Instance.
The Metrics Provider will have a map of metrics that can be operated by the client via the appropriate methods, allowing the user to add new custom metrics when needed and manipulate them in a uniform manner. - MetricsProviderRestService - Class in de.iip_ecosphere.platform.services.environment.spring.metricsProvider
-
This class provides a RESTful Service to access the
MetricsProviderinstance running in the Spring Service. - MetricsProviderRestService(MetricsProvider) - Constructor for class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProviderRestService
-
Creates a new RestMetricsUpdater instance.
This method should be called by the Spring Boot Application that will inject theMetricsProviderinstance running in the service. - MyServiceBase() - Constructor for class de.iip_ecosphere.platform.services.environment.spring.TestSpringBroker.MyServiceBase
N
- numberFormatExceptionHandler(NumberFormatException) - Method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.RestAdvice
-
Captures and handles an NumberFormatException.
If the request sent to theMetricsProviderRestServicecontains a string that cannot be parsed into a valid number that is expected by the method, this exception will be thrown.
O
- of(MeterRegistry) - Static method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProvider
-
Create a new Metrics Provider Instance.
- OPT_SPRING_BINDER_POSTFIX - Static variable in class de.iip_ecosphere.platform.services.environment.spring.Starter
- OPT_SPRING_BINDINGS_PREFIX - Static variable in class de.iip_ecosphere.platform.services.environment.spring.Starter
- OPT_SPRING_FUNCTION_DEF - Static variable in class de.iip_ecosphere.platform.services.environment.spring.Starter
P
- parseCounterdGaugeAndConfig(String) - Method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProviderRestService
-
Parses a Json Object into a Map to extract the values.
Quick fix to the Json Part not working. - parseExternConnections(String[], Consumer<String>) - Static method in class de.iip_ecosphere.platform.services.environment.spring.Starter
-
Parses the external binder connections and turns them into external routing keys.
- parseTimer(String) - Method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProviderRestService
-
Parses a Json Object into a Map to extract the values.
Quick fix to the Json Part not working. - port - Static variable in class de.iip_ecosphere.platform.services.environment.spring.Starter
- putCounterValue(String) - Method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProviderRestService
-
Increases a custom counter value.
The request body is expected to have plain text with two values separated by a comma, being the first value the URN (or name) of the counter we want to modify and the second the value by which we want to increase the counter.
Similar to the implementation ofMetricsProvider.increaseCounterBy(String, double), if there is no counter with the indicated URN, said counter is created. - putGaugeValue(String) - Method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProviderRestService
-
Updates a custom gauge value.
The request body is expected to have plain text with two values separated by a comma, being the first value the URN (or name) of the gauge we want to modify and the second the value we want the gauge to have.
Similar to the implementation ofMetricsProvider.addGaugeValue(String, double), if there is no gauge with the indicated URN, said gauge is created. - putTimerValue(String) - Method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProviderRestService
-
Increases a custom timer value.
The request body is expected to have plain text with multiple values separated by commas, being the first value the URN (or name) of the timer we want to modify and the remaining values the amounts of time in nanoseconds that we want to record with the timer.
Similar to the implementation ofMetricsProvider.recordWithTimer(String, long, TimeUnit), if there is no timer with the indicated URN, said timer is created.
R
- registerNonNativeSystemMetrics() - Method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProvider
-
Registers the extra system metrics onto the registry.
The extra system metrics include the physical memory values and the disk values, which are metrics not automatically recorded by Micrometer-API. - resolve(ClassLoader, String) - Method in class de.iip_ecosphere.platform.services.environment.spring.SpringResourceResolver
- RestAdvice - Class in de.iip_ecosphere.platform.services.environment.spring.metricsProvider
-
This class aims to provide a handler for expected exceptions that could occur when using the
MetricsProviderRestService.
This class contains a mechanism implemented by Spring Rest Controller that allows the creation of custom exception handlers to expected exceptions that may occur during requests and, as a result provide a more custom response to the request.
There are two types of exceptions handled by this class: IllegalArgumentExceptions NumberFormatExceptions - RestAdvice() - Constructor for class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.RestAdvice
- run(String...) - Method in class de.iip_ecosphere.platform.services.environment.spring.Starter
- run(String[]) - Method in class de.iip_ecosphere.platform.services.environment.spring.TestSpringBroker
S
- SCHEDULE_RATE - Static variable in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProvider
- send(IOConsumer<TransportConnector>, String) - Method in class de.iip_ecosphere.platform.services.environment.spring.SpringAsyncServiceBase
-
Sends a message of a certain
kindand cares fore queuing. - send(IOConsumer<TransportConnector>, String, String...) - Static method in class de.iip_ecosphere.platform.services.environment.spring.SpringAsyncServiceBase
-
Sends a message of a certain
kindand cares fore queuing. - sendTraceRecord(TraceRecord) - Method in class de.iip_ecosphere.platform.services.environment.spring.SpringAsyncServiceBase
-
Sends a trace record.
- serialVersionUID - Static variable in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.TransportSetup
- serverProperties - Variable in class de.iip_ecosphere.platform.services.environment.spring.Starter
- ServiceForMapping(String) - Constructor for class de.iip_ecosphere.platform.services.environment.spring.Starter.ServiceForMapping
-
Creates the service that shall be mapped.
- setInjectedValues(TransportSetup) - Method in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProvider
-
Sets the basic values that are usually injected.
- SpringAsyncServiceBase - Class in de.iip_ecosphere.platform.services.environment.spring
-
Basic Spring Service functions for asynchronous forward/backward data flows via the transport layer.
- SpringAsyncServiceBase() - Constructor for class de.iip_ecosphere.platform.services.environment.spring.SpringAsyncServiceBase
- SpringAsyncServiceBase.InstalledCallback - Class in de.iip_ecosphere.platform.services.environment.spring
-
Records information about an installed callback.
- SpringResourceResolver - Class in de.iip_ecosphere.platform.services.environment.spring
-
Implements a Spring resource loader for "BOOT-INF/classes" (Spring FAT Jar).
- SpringResourceResolver() - Constructor for class de.iip_ecosphere.platform.services.environment.spring.SpringResourceResolver
- startDataForMappedServices() - Static method in class de.iip_ecosphere.platform.services.environment.spring.Starter
-
Starts data for mapped services, delayed
ServiceState.RUNNING. - Starter - Class in de.iip_ecosphere.platform.services.environment.spring
-
A specialized starter for Spring Cloud Stream in including the metrics provider.
- Starter(Environment) - Constructor for class de.iip_ecosphere.platform.services.environment.spring.Starter
-
Creates an instance.
- Starter.ServiceForMapping - Class in de.iip_ecosphere.platform.services.environment.spring
-
Represents a service that shall be mapped.
- startupSequence - Static variable in class de.iip_ecosphere.platform.services.environment.spring.Starter
- substArgs(Map<String, Object>, String[]) - Static method in class de.iip_ecosphere.platform.services.environment.spring.YamlSetup
-
Substitutes values in
setupby values inargs.
T
- TestSpringBroker - Class in de.iip_ecosphere.platform.services.environment.spring
-
Startup plugin for in-situ testing the transport broker, her testing via
SpringAsyncServiceBase. - TestSpringBroker() - Constructor for class de.iip_ecosphere.platform.services.environment.spring.TestSpringBroker
- TestSpringBroker.MyServiceBase - Class in de.iip_ecosphere.platform.services.environment.spring
-
Local service base for testing, disable setup as done below.
- toString() - Method in class de.iip_ecosphere.platform.services.environment.spring.Starter.ServiceForMapping
- transport - Variable in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProvider
- TransportSetup - Class in de.iip_ecosphere.platform.services.environment.spring.metricsProvider
-
Binds the
TransportSetupagainst Spring. - TransportSetup() - Constructor for class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.TransportSetup
U
- update - Variable in class de.iip_ecosphere.platform.services.environment.spring.metricsProvider.MetricsProvider
Y
- YamlSetup - Class in de.iip_ecosphere.platform.services.environment.spring
-
Reads information from the Spring YAML application setup.
- YamlSetup() - Constructor for class de.iip_ecosphere.platform.services.environment.spring.YamlSetup
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form