Package org.operaton.bpm.spring.boot.starter.webapp.neo

Record Class NeoClientConfig

java.lang.Object

java.lang.Record

org.operaton.bpm.spring.boot.starter.webapp.neo.NeoClientConfig

public record NeoClientConfig(List<NeoClientConfig.Backend> backends, String authMode, NeoClientConfig.OAuth oauth, String pluginsUrl, NeoClientConfig.User user)
extends Record

Configuration handed to the webapps-neo single-page application at boot.

The SPA used to have these values compiled into its bundle by Vite, which meant the distribution could only be reconfigured by rebuilding the frontend. It now fetches this document from {applicationPath}/config.json, so the same bundle serves every configuration.

Since:

2.2

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	NeoClientConfig.Backend	A REST API the SPA can talk to.
static final record	NeoClientConfig.OAuth	Where the SPA sends the browser to start and end an OAuth2 session.
static final record	NeoClientConfig.User	The already-authenticated user, absent when there is no session.

Constructor Summary

Constructors

Constructor	Description
NeoClientConfig(List<NeoClientConfig.Backend> backends, String authMode, NeoClientConfig.OAuth oauth, String pluginsUrl, NeoClientConfig.User user)	Creates an instance of a NeoClientConfig record class.

Method Summary

Modifier and Type	Method	Description
String	authMode()	Returns the value of the authMode record component.
List<NeoClientConfig.Backend>	backends()	Returns the value of the backends record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
NeoClientConfig.OAuth	oauth()	Returns the value of the oauth record component.
String	pluginsUrl()	Returns the value of the pluginsUrl record component.
final String	toString()	Returns a string representation of this record class.
NeoClientConfig.User	user()	Returns the value of the user record component.

Methods inherited from class java.lang.Object

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

Constructor Details

NeoClientConfig

public NeoClientConfig(List<NeoClientConfig.Backend> backends,
 String authMode,
 NeoClientConfig.OAuth oauth,
 String pluginsUrl,
 NeoClientConfig.User user)

Creates an instance of a NeoClientConfig record class.

Parameters:

backends - the value for the backends record component

authMode - the value for the authMode record component

oauth - the value for the oauth record component

pluginsUrl - the value for the pluginsUrl record component

user - the value for the user record component

Method Details

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.

backends

public List<NeoClientConfig.Backend> backends()

Returns the value of the backends record component.

Returns:

the value of the backends record component

authMode

public String authMode()

Returns the value of the authMode record component.

Returns:

the value of the authMode record component

oauth

public NeoClientConfig.OAuth oauth()

Returns the value of the oauth record component.

Returns:

the value of the oauth record component

pluginsUrl

public String pluginsUrl()

Returns the value of the pluginsUrl record component.

Returns:

the value of the pluginsUrl record component

user

public NeoClientConfig.User user()

Returns the value of the user record component.

Returns:

the value of the user record component