Package io.quarkus.deployment.builditem

Class DevServicesResultBuildItem

java.lang.Object

io.quarkus.builder.item.BuildItem

io.quarkus.builder.item.MultiBuildItem

io.quarkus.deployment.builditem.DevServicesResultBuildItem

public final class DevServicesResultBuildItem
extends io.quarkus.builder.item.MultiBuildItem

BuildItem for discovered (running) or to be started dev services.

Processors are expected to return this build item not only when the dev service first starts, but also if a running dev service already exists.

Two builders are provided to create this build item:

- discovered() for discovered dev services, provides config to be injected to the application with container id (if it exists).

- owned() for owned dev services, that will be started before application start, provides the startable supplier and config injected to the application and post-start action.

DevServicesResultBuildItem.RunningDevService is deprecated in favor of builder flavors.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final record	DevServicesResultBuildItem.DevServiceConfigDependency<T extends Startable>
static class	DevServicesResultBuildItem.DiscoveredServiceBuilder
static class	DevServicesResultBuildItem.OwnedServiceBuilder<T extends Startable>
static class	DevServicesResultBuildItem.RunningDevService	Deprecated. Use discovered() instead.

Constructor Summary

Constructors

Constructor	Description
DevServicesResultBuildItem(String name, String description, String serviceName, Object serviceConfig, Map<String,String> config, Supplier<Startable> startableSupplier, Consumer<Startable> postStartAction, Map<String,Function<Startable,String>> applicationConfigProvider, Set<String> highPriorityConfig)	Deprecated. use owned() or discovered() instead
DevServicesResultBuildItem(String name, String description, String containerId, Map<String,String> config)	Deprecated. use owned() or discovered() instead
DevServicesResultBuildItem(String name, String containerId, Map<String,String> config)	Deprecated. use owned() or discovered() instead

Method Summary

Modifier and Type	Method	Description
static DevServicesResultBuildItem.DiscoveredServiceBuilder	discovered()
Map<String,Function<Startable,String>>	getApplicationConfigProvider()
Map<String,String>	getConfig()
Map<String,String>	getConfig(Startable startable)
String	getContainerId()
Set<DevServicesResultBuildItem.DevServiceConfigDependency<? extends Startable>>	getDependencies()
String	getDescription()
String	getName()
Set<DevServicesResultBuildItem.DevServiceConfigDependency<? extends Startable>>	getOptionalDependencies()
Map<String,String>	getOverrideConfig(Startable startable)	Deprecated, for removal: This API element is subject to removal in a future version. Subject to changes due to #51209
Consumer<Startable>	getPostStartAction()
Object	getServiceConfig()
String	getServiceName()
Supplier<Startable>	getStartableSupplier()
boolean	hasDependencies()
boolean	isStartable()
static <T extends Startable> DevServicesResultBuildItem.OwnedServiceBuilder<T>	owned()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DevServicesResultBuildItem

@Deprecated
public DevServicesResultBuildItem(String name,
 String containerId,
 Map<String,String> config)

Deprecated.

use owned() or discovered() instead

DevServicesResultBuildItem

@Deprecated
public DevServicesResultBuildItem(String name,
 String description,
 String containerId,
 Map<String,String> config)

Deprecated.

use owned() or discovered() instead

DevServicesResultBuildItem

@Deprecated
public DevServicesResultBuildItem(String name,
 String description,
 String serviceName,
 Object serviceConfig,
 Map<String,String> config,
 Supplier<Startable> startableSupplier,
 Consumer<Startable> postStartAction,
 Map<String,Function<Startable,String>> applicationConfigProvider,
 Set<String> highPriorityConfig)

Deprecated.

use owned() or discovered() instead

Method Details

discovered

public static DevServicesResultBuildItem.DiscoveredServiceBuilder discovered()

owned

public static <T extends Startable>
DevServicesResultBuildItem.OwnedServiceBuilder<T> owned()

getName

public String getName()

getDescription

public String getDescription()

getContainerId

public String getContainerId()

isStartable

public boolean isStartable()

getConfig

public Map<String,String> getConfig()

getServiceName

public String getServiceName()

getServiceConfig

public Object getServiceConfig()

Returns:

the identifying configuration

getStartableSupplier

public Supplier<Startable> getStartableSupplier()

getPostStartAction

public Consumer<Startable> getPostStartAction()

getApplicationConfigProvider

public Map<String,Function<Startable,String>> getApplicationConfigProvider()

getConfig

public Map<String,String> getConfig(Startable startable)

getOverrideConfig

@Deprecated(forRemoval=true)
public Map<String,String> getOverrideConfig(Startable startable)

Deprecated, for removal: This API element is subject to removal in a future version.

Subject to changes due to #51209

hasDependencies

public boolean hasDependencies()

getDependencies

public Set<DevServicesResultBuildItem.DevServiceConfigDependency<? extends Startable>> getDependencies()

getOptionalDependencies

public Set<DevServicesResultBuildItem.DevServiceConfigDependency<? extends Startable>> getOptionalDependencies()