Package io.jmix.datatools

Class DatatoolsProperties.DataModelDiagram

java.lang.Object

io.jmix.datatools.DatatoolsProperties.DataModelDiagram

Enclosing class:

DatatoolsProperties

public static class DatatoolsProperties.DataModelDiagram
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final EngineType	engineType	Engine type.
protected final String	host	The server address.
protected final String	path	The path under which the diagramming server serves its endpoints, appended to host.
protected final boolean	publicServerEnabled	Whether the public PlantUML server (https://www.plantuml.com) may be used to render data model diagrams when no private host is configured.
protected final Duration	readTimeout	The maximum time to wait for a response from the diagramming server.

Constructor Summary

Constructors

Constructor	Description
DataModelDiagram(@Nullable String host, String path, EngineType engineType, boolean publicServerEnabled, Duration readTimeout)

Method Summary

Modifier and Type	Method	Description
EngineType	getEngineType()
@Nullable String	getHost()
String	getPath()
Duration	getReadTimeout()
boolean	isPublicServerEnabled()

Methods inherited from class java.lang.Object

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

Field Details

host

protected final String host

The server address. This can be either an IP address with custom port or not. It could also be a domain name.

path

protected final String path

The path under which the diagramming server serves its endpoints, appended to host. Set the property to an empty value when the server is deployed at the root context or when host already contains the path: the path of the host is not replaced but prepended, so keeping both results in a doubled prefix.

engineType

protected final EngineType engineType

Engine type. PlantUML by default

publicServerEnabled

protected final boolean publicServerEnabled

Whether the public PlantUML server (https://www.plantuml.com) may be used to render data model diagrams when no private host is configured. When a private host is set, this property has no effect. This is also gated by the global jmix.core.unsafe-runtime-features-enabled switch: if that switch is disabled, the public server is not used regardless of this property.

readTimeout

protected final Duration readTimeout

The maximum time to wait for a response from the diagramming server. Rendering a large data model may take the server longer than the default.

Constructor Details

DataModelDiagram

public DataModelDiagram(@Nullable String host,
 @DefaultValue("plantuml")
 String path,
 @DefaultValue("PLANTUML")
 EngineType engineType,
 @DefaultValue("true")
 boolean publicServerEnabled,
 @DefaultValue("10s")
 Duration readTimeout)

Method Details

getEngineType

public EngineType getEngineType()

getHost

public @Nullable String getHost()

getPath

public String getPath()

See Also:

• path

getReadTimeout

public Duration getReadTimeout()

See Also:

• readTimeout

isPublicServerEnabled

public boolean isPublicServerEnabled()

See Also:

• publicServerEnabled