Package io.quarkus.deployment.builditem

Class DevServicesSharedNetworkBuildItem

java.lang.Object

io.quarkus.builder.item.BuildItem

io.quarkus.builder.item.MultiBuildItem

io.quarkus.deployment.builditem.DevServicesSharedNetworkBuildItem

public final class DevServicesSharedNetworkBuildItem
extends MultiBuildItem

A marker build item that indicates, if any instances are provided during the build, the containers started by DevServices may use a shared network. This is mainly useful in integration tests where the application container needs to be able to communicate with the service containers.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DevServicesSharedNetworkBuildItem.Factory	Generates a List<Consumer<BuildChainBuilder>> build chain builder which creates a build step producing the DevServicesSharedNetworkBuildItem build item.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SOURCE_PROPERTY
static final String	UNKNOWN_SOURCE

Constructor Summary

Constructors

Constructor	Description
DevServicesSharedNetworkBuildItem()	Create a build item without identifying the creator source.
DevServicesSharedNetworkBuildItem(String source)	Create a build item identifying the creator source.

Method Summary

Modifier and Type	Method	Description
String	getSource()	The creator source of this build item.
static boolean	isSharedNetworkRequired(DevServicesConfig devServicesConfig, List<DevServicesSharedNetworkBuildItem> devServicesSharedNetworkBuildItem)	Helper method for DevServices processors that tells if joining the shared network is required.
static boolean	isSharedNetworkRequired(GlobalDevServicesConfig globalDevServicesConfig, List<DevServicesSharedNetworkBuildItem> devServicesSharedNetworkBuildItem)	Deprecated, for removal: This API element is subject to removal in a future version. Please, use isSharedNetworkRequired(DevServicesConfig, List) instead.

Methods inherited from class java.lang.Object

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

Field Details

SOURCE_PROPERTY

public static final String SOURCE_PROPERTY

See Also:

• Constant Field Values

UNKNOWN_SOURCE

public static final String UNKNOWN_SOURCE

See Also:

• Constant Field Values

Constructor Details

DevServicesSharedNetworkBuildItem

public DevServicesSharedNetworkBuildItem()

Create a build item without identifying the creator source.

DevServicesSharedNetworkBuildItem

public DevServicesSharedNetworkBuildItem(String source)

Create a build item identifying the creator source.

Parameters:

source - The identifier of the creator

Method Details

getSource

public String getSource()

The creator source of this build item. May be useful to decide whether a DevService should join a shared network.

isSharedNetworkRequired

public static boolean isSharedNetworkRequired(DevServicesConfig devServicesConfig,
 List<DevServicesSharedNetworkBuildItem> devServicesSharedNetworkBuildItem)

Helper method for DevServices processors that tells if joining the shared network is required. Joining this network may be required if explicitily asked by user properties or if running a containerized application during integration tests.

isSharedNetworkRequired

@Deprecated(forRemoval=true,
            since="3.18")
public static boolean isSharedNetworkRequired(GlobalDevServicesConfig globalDevServicesConfig,
 List<DevServicesSharedNetworkBuildItem> devServicesSharedNetworkBuildItem)

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

Please, use isSharedNetworkRequired(DevServicesConfig, List) instead.