tentackle-wizard:operation
Full name:
org.tentackle:tentackle-wizard-maven-plugin:25.20.1.0:operation
Description:
Wizard to create operation files.
Brings up an FX UI to create the operation-related Java files.
If operationName is set, the wizard works in batch mode and generates the files for that single operation without opening the UI. Since operations are not part of the model, all values the UI would ask for must be given as parameters, for example:
mvn tentackle-wizard:operation -DoperationName=SendInvoice -Dcomment="sends an invoice"
Best invoked from within the directory of the Maven parent of the project.
Attributes:
- Requires a Maven project to be executed.
- Executes as an aggregator goal.
- The goal is thread-safe and supports parallel builds.
Optional Parameters
| Name | Type | Since | Description |
|---|---|---|---|
<abstractOperation> |
boolean |
- |
Whether an abstract operation should be generated. User Property: abstract |
<charset> |
String |
- |
The encoding to read and write files.
Applied JVM-wide, see determineEncoding()
.Default: ${project.build.sourceEncoding} |
<darkMode> |
Boolean |
- |
Enables dark mode.
If missing, the mode follows the desktop settings and changes along with them. |
<domainImplementation> |
String |
- |
The name of the domain implementation.
Defaults to the name derived from the operation name. An empty value or "-" generates the domain interface only. Ignored if the domain interface is dropped. User Property: domainImplementation |
<domainInterface> |
String |
- |
The name of the domain interface.
Defaults to the name derived from the operation name. An empty value or "-" generates no domain interface and no domain implementation. User Property: domainInterface |
<entityAliases> |
String |
- |
The entity aliases, in the same syntax as in the model source. User Property: tentackle.entityAliases |
<filesets> |
List<FileSet> |
- |
The list of file sets containing the model.
If set, the modelDir
is ignored. Each fileset is loaded as a whole directory, i.e. includes and excludes are not applied. |
<jdkToolchain> |
Map<String,String> |
- |
Toolchain for invocation of external tools.
Explicitly specifies the "jdk" toolchain for this plugin only. Overrides the toolchain selected by the maven-toolchain-plugin, if any.
Example: <jdkToolchain>
<version>25</version>
</jdkToolchain>
To deselect the toolchain configured by the maven-toolchain-plugin:
<jdkToolchain></jdkToolchain> |
<layers> |
List<Layer> |
- |
Named, isolated ModuleLayers for dependencies that must run isolated from each other - typically because two of them need different, otherwise conflicting versions of the same module, or because the application itself is built with module layers.
If empty (the default), the goal runs exactly as without this feature at all: against the plain plugin classpath (populated the usual way, by declaring the application's dependencies as See also: leafLayer |
<leafLayer> |
String |
- |
The name of the layer holding the application's own PDO/domain/persistence classes, i.e. the layer whose classloader is installed as the thread's context classloader while the goal runs. Required if layers
is not empty and must match the name of one of them. |
<loadModelFromDependencies> |
boolean |
- |
Load the model from the resources of the plugin dependencies on the classpath. Default: true |
<longDescription> |
String |
- |
The long description of the operation. User Property: longComment |
<minLogLevel> |
String |
- |
The minimum logging java.util.logging.Level
to redirect java.util logging to the maven logger.
Any name or value accepted by java.util.logging.Level.parse(java.lang.String)
.Default: WARNING |
<modelDefaults> |
String |
- |
The model defaults, in the same syntax as in the model source. User Property: tentackle.modelDefaults |
<modelDir> |
File |
- |
Directory holding the model files to be processed.
Ignored if filesets
are given, except as the default directory of a fileset without a directory.Default: ${project.build.directory}/wurbel/modelUser Property: tentackle.modelDir |
<modelName> |
String |
- |
The model name. Default: defaultUser Property: tentackle.modelName |
<operationName> |
String |
- |
The name of the operation.
If set, the wizard works in batch mode and generates the files for that operation instead of opening the UI. User Property: operationName |
<overwrite> |
boolean |
- |
Whether existing files may be overwritten in batch mode.
By default, the goal fails if one of the files to generate already exists, because regenerating it would destroy the business logic written into it. User Property: overwrite |
<persistenceImplementation> |
String |
- |
The name of the persistence implementation.
Defaults to the name derived from the operation name. An empty value or "-" generates the persistence interface only. Ignored if the persistence interface is dropped. User Property: persistenceImplementation |
<persistenceInterface> |
String |
- |
The name of the persistence interface.
Defaults to the name derived from the operation name. An empty value or "-" generates no persistence interface, no persistence implementation and disables remoting. User Property: persistenceInterface |
<profileName> |
String |
- |
The name of the OperationProfile
to use in batch mode.
Matched case-insensitively. Can be omitted if there is only one profile configured. User Property: profile |
<profiles> |
List<Profile> |
- |
The profiles.
Required by the pdo goal (at least one PdoProfile
) and the operation goal (at least one OperationProfile
). Profile names must be unique. |
<remoteEnabled> |
Boolean |
- |
Whether remoting is supported.
Defaults to true if the project has no model defaults, otherwise to the remote option of the project's model defaults.
Only tailors the generated persistence implementation; the remote delegate is created by the wurblets. User Property: remote |
<shortDescription> |
String |
- |
The short description of the operation.
Mandatory in batch mode. User Property: comment |
<skip> |
Boolean |
- |
Skips processing.
If not set, defaults to true if packaging is "pom" and the execution is recursive (see isSkippedByDefault()
). |
<statusDir> |
File |
- |
Directory holding the status info.
Used to store the next free class ID per profile in case multiple PDOs are generated without an intermediate build that updates the model. Should be a subdirectory of the target directory, so that mvn clean removes it.Default: ${project.build.directory}/wizard |
<superOperation> |
String |
- |
The name of the super operation.
Determines all super types of the generated classes. If not set, the super types are taken from the profile or the framework defaults. User Property: superOperation |
<templateDir> |
File |
- |
The directory holding the templates.
If it does not exist, it is created and the default templates are installed. Default: ${project.basedir}/templates |
<themeName> |
String |
- |
Selects the theme.
The AtlantaFX themes are: Primer, Cupertino, and Nord.
The default is Cupertino on macOS and Primer on all other platforms. |
<verbosity> |
String |
- |
The verbosity.
One of "default", "info" or "debug". Other values are treated as "default". If not set, debug is turned on by Maven's global debug flag (see command line switch -X).Default: ${tentackle.verbosity} |
Parameter Details
<abstractOperation>
- Type:
boolean - Required:
No - User Property:
abstract
<charset>
Applied JVM-wide, see
determineEncoding()
.- Type:
java.lang.String - Required:
No - Default:
${project.build.sourceEncoding}
<darkMode>
If missing, the mode follows the desktop settings and changes along with them.
- Type:
java.lang.Boolean - Required:
No
<domainImplementation>
Defaults to the name derived from the operation name. An empty value or "-" generates the domain interface only. Ignored if the domain interface is dropped.
- Type:
java.lang.String - Required:
No - User Property:
domainImplementation
<domainInterface>
Defaults to the name derived from the operation name. An empty value or "-" generates no domain interface and no domain implementation.
- Type:
java.lang.String - Required:
No - User Property:
domainInterface
<entityAliases>
- Type:
java.lang.String - Required:
No - User Property:
tentackle.entityAliases
<filesets>
If set, the
modelDir
is ignored. Each fileset is loaded as a whole directory, i.e. includes and excludes are not applied.- Type:
java.util.List<org.apache.maven.shared.model.fileset.FileSet> - Required:
No
<jdkToolchain>
Explicitly specifies the
"jdk" toolchain for this plugin only. Overrides the toolchain selected by the maven-toolchain-plugin, if any.
Example:
<jdkToolchain>
<version>25</version>
</jdkToolchain>
To deselect the toolchain configured by the maven-toolchain-plugin:
<jdkToolchain></jdkToolchain>
- Type:
java.util.Map<java.lang.String, java.lang.String> - Required:
No
<layers>
ModuleLayers for dependencies that must run isolated from each other - typically because two of them need different, otherwise conflicting versions of the same module, or because the application itself is built with module layers.
If empty (the default), the goal runs exactly as without this feature at all: against the plain plugin classpath (populated the usual way, by declaring the application's dependencies as <dependency> elements of this plugin). If not empty, this plugin builds the configured ModuleLayer graph at goal-execution time and installs the leafLayer's classloader as the thread's context classloader for the duration of the goal - which is what every existing, layer-unaware ServiceFactory.getServiceFinder()/Model.loadFromResources() call (and, for browse/script, the application's own domain/PDO/persistence classes) transparently resolves from. See the layers.md documentation.
See also: leafLayer
- Type:
java.util.List<org.tentackle.maven.plugin.wizard.Layer> - Required:
No
<leafLayer>
layers
is not empty and must match the name of one of them.- Type:
java.lang.String - Required:
No
<loadModelFromDependencies>
- Type:
boolean - Required:
No - Default:
true
<longDescription>
- Type:
java.lang.String - Required:
No - User Property:
longComment
<minLogLevel>
java.util.logging.Level
to redirect java.util logging to the maven logger.
Any name or value accepted by
java.util.logging.Level.parse(java.lang.String)
.- Type:
java.lang.String - Required:
No - Default:
WARNING
<modelDefaults>
- Type:
java.lang.String - Required:
No - User Property:
tentackle.modelDefaults
<modelDir>
Ignored if
filesets
are given, except as the default directory of a fileset without a directory.- Type:
java.io.File - Required:
No - User Property:
tentackle.modelDir - Default:
${project.build.directory}/wurbel/model
<modelName>
- Type:
java.lang.String - Required:
No - User Property:
tentackle.modelName - Default:
default
<operationName>
If set, the wizard works in batch mode and generates the files for that operation instead of opening the UI.
- Type:
java.lang.String - Required:
No - User Property:
operationName
<overwrite>
By default, the goal fails if one of the files to generate already exists, because regenerating it would destroy the business logic written into it.
- Type:
boolean - Required:
No - User Property:
overwrite
<persistenceImplementation>
Defaults to the name derived from the operation name. An empty value or "-" generates the persistence interface only. Ignored if the persistence interface is dropped.
- Type:
java.lang.String - Required:
No - User Property:
persistenceImplementation
<persistenceInterface>
Defaults to the name derived from the operation name. An empty value or "-" generates no persistence interface, no persistence implementation and disables remoting.
- Type:
java.lang.String - Required:
No - User Property:
persistenceInterface
<profileName>
OperationProfile
to use in batch mode.
Matched case-insensitively. Can be omitted if there is only one profile configured.
- Type:
java.lang.String - Required:
No - User Property:
profile
<profiles>
Required by the
pdo goal (at least one PdoProfile
) and the operation goal (at least one OperationProfile
). Profile names must be unique.- Type:
java.util.List<org.tentackle.maven.plugin.wizard.Profile> - Required:
No
<remoteEnabled>
Defaults to true if the project has no model defaults, otherwise to the
remote option of the project's model defaults.
Only tailors the generated persistence implementation; the remote delegate is created by the wurblets.
- Type:
java.lang.Boolean - Required:
No - User Property:
remote
<shortDescription>
Mandatory in batch mode.
- Type:
java.lang.String - Required:
No - User Property:
comment
<skip>
If not set, defaults to true if packaging is "pom" and the execution is recursive (see
isSkippedByDefault()
).- Type:
java.lang.Boolean - Required:
No
<statusDir>
Used to store the next free class ID per profile in case multiple PDOs are generated without an intermediate build that updates the model.
Should be a subdirectory of the target directory, so that
mvn clean removes it.- Type:
java.io.File - Required:
No - Default:
${project.build.directory}/wizard
<superOperation>
Determines all super types of the generated classes. If not set, the super types are taken from the profile or the framework defaults.
- Type:
java.lang.String - Required:
No - User Property:
superOperation
<templateDir>
If it does not exist, it is created and the default templates are installed.
- Type:
java.io.File - Required:
No - Default:
${project.basedir}/templates
<themeName>
The AtlantaFX themes are:
Primer, Cupertino, and Nord.
The default is
Cupertino on macOS and Primer on all other platforms.- Type:
java.lang.String - Required:
No
<verbosity>
One of "default", "info" or "debug". Other values are treated as "default".
If not set, debug is turned on by Maven's global debug flag (see command line switch
-X).- Type:
java.lang.String - Required:
No - Default:
${tentackle.verbosity}
Tentackle