Record Class FrontendConfig

java.lang.Object

java.lang.Record

io.fluxzero.devserver.FrontendConfig

Record Components:

mode - frontend integration mode

command - command used to start a managed frontend

url - URL of an externally managed frontend

directory - optional working directory for managed frontend commands, relative to the project directory

setupCommand - optional setup command executed once before each managed frontend launch

backendPaths - public paths routed unchanged to the Fluxzero proxy

public record FrontendConfig(FrontendConfig.Mode mode, String command, String url, String directory, String setupCommand, List<String> backendPaths)
extends Record

Optional frontend process integration for the dev server.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FrontendConfig.Mode

Field Summary

Fields

Modifier and Type	Field	Description
static final List<String>	DEFAULT_BACKEND_PATHS	Default path routed unchanged from the public gateway to Fluxzero.

Constructor Summary

Constructors

Constructor	Description
FrontendConfig(FrontendConfig.Mode mode, String command, String url)
FrontendConfig(FrontendConfig.Mode mode, String command, String url, String directory, String setupCommand, List<String> backendPaths)	Creates an instance of a FrontendConfig record class.
FrontendConfig(FrontendConfig.Mode mode, String command, String url, List<String> backendPaths)

Method Summary

Modifier and Type	Method	Description
List<String>	backendPaths()	Returns the value of the backendPaths record component.
String	command()	Returns the value of the command record component.
static FrontendConfig	command(String command)
String	directory()	Returns the value of the directory record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static FrontendConfig	externalUrl(String url)
final int	hashCode()	Returns a hash code value for this object.
FrontendConfig.Mode	mode()	Returns the value of the mode record component.
static FrontendConfig	none()
String	setupCommand()	Returns the value of the setupCommand record component.
final String	toString()	Returns a string representation of this record class.
String	url()	Returns the value of the url record component.
FrontendConfig	withBackendPaths(List<String> backendPaths)	Returns a copy with the public paths that should bypass the frontend and retain their path toward Fluxzero.
FrontendConfig	withLaunchSetup(String directory, String setupCommand)	Returns a copy with the working directory and optional setup command for the managed frontend.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_BACKEND_PATHS

public static final List<String> DEFAULT_BACKEND_PATHS

Default path routed unchanged from the public gateway to Fluxzero.

Constructor Details

FrontendConfig

public FrontendConfig(FrontendConfig.Mode mode,
 String command,
 String url,
 String directory,
 String setupCommand,
 List<String> backendPaths)

Creates an instance of a FrontendConfig record class.

Parameters:

mode - the value for the mode record component

command - the value for the command record component

url - the value for the url record component

directory - the value for the directory record component

setupCommand - the value for the setupCommand record component

backendPaths - the value for the backendPaths record component

FrontendConfig

public FrontendConfig(FrontendConfig.Mode mode,
 String command,
 String url)

FrontendConfig

public FrontendConfig(FrontendConfig.Mode mode,
 String command,
 String url,
 List<String> backendPaths)

Method Details

none

public static FrontendConfig none()

externalUrl

public static FrontendConfig externalUrl(String url)

command

public static FrontendConfig command(String command)

withBackendPaths

public FrontendConfig withBackendPaths(List<String> backendPaths)

Returns a copy with the public paths that should bypass the frontend and retain their path toward Fluxzero.

withLaunchSetup

public FrontendConfig withLaunchSetup(String directory,
 String setupCommand)

Returns a copy with the working directory and optional setup command for the managed frontend.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

mode

public FrontendConfig.Mode mode()

Returns the value of the mode record component.

Returns:

the value of the mode record component

command

public String command()

Returns the value of the command record component.

Returns:

the value of the command record component

url

public String url()

Returns the value of the url record component.

Returns:

the value of the url record component

directory

public String directory()

Returns the value of the directory record component.

Returns:

the value of the directory record component

setupCommand

public String setupCommand()

Returns the value of the setupCommand record component.

Returns:

the value of the setupCommand record component

backendPaths

public List<String> backendPaths()

Returns the value of the backendPaths record component.

Returns:

the value of the backendPaths record component