Parameters

Cloud Connector¶

<cloudconnector
    xmlns="https://virtual-developer.com/schema/cloudconnector"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="https://virtual-developer.com/schema/cloudconnector
        https://maven.virtual-developer.com/repository/cloudconnector/2.1/cloudconnector.xsd">
  <account>company</account>
  ...
</cloudconnector>

This is the start tag of the XML File. In maven this is not needed. The plugin is configured in the <configuration> tag.

Account¶

<account>company</account>

The account will be used to login to the Virtual Developer platform. If your login URL is for example https://company.virtual-developer.com then you can just use company inside the account tag. This will make the cloudconnector connect to virtual-developer.com with the account company.

Identity Provider¶

<identityProvider>https://id.virtual-developer.com/auth/realms/company</identityProvider>

If you don’t use virtual-developer.com to login (private installation), you need to remove the account tag and specify the identity provider and the connection.

The identity provider is an openID Connect endpoint.

Connection¶

<connection>https://company.virtual-developer.com</connection>

The connection is the URL you login to virtual developer.

Connection Timeout¶

<connectionTimeout>5000</connection>

Connection timeout to the server in milliseconds

Connection Read/Write Timeout¶

<connectionRWTimeout>10000</connectionRWTimeout>

Read/Write timeout to the server in milliseconds

Generator¶

<generator>
  <id>com.gs.vd.gen.java.retrofit.openapi</id>
  <version>1.0</version>
  ...
</generator>

See Generator

Parallel Transformation Jobs¶

<parallelTransformationJobs>4</parallelTransformationJobs>

Number of transformations which run in parallel.

Parallel Transformation Files¶

<parallelTransformationFiles>8</parallelTransformationFiles>

Number of files which get transformed in one go.

Charset¶

<charset>UTF-8</charset>

The charset of the files. This information will be send to the server.

Fail Fast¶

<failFast>false</failFast>

This will immediately stop the generation if there is an error.

Generator¶

<generator>
  <id>com.gs.vd.gen.java.retrofit.openapi</id>
  <version>1.0</version>
  ...
</generator>

Id¶

<id>com.gs.vd.gen.java.retrofit.openapi</id>

The ID of the generator.

Version¶

<version>1.0</version>

The version of the generator.

It is recommended to only use the major and minor version (e.g. 1.0) instead of the full version (e.g. 1.0.5.2022).

Models¶

<models>
  <model>input1.file</model>
  <model>input2.file</model>
</models>

A list of files representing the model for this generator

Modeler¶

<modeler>
  <elements>1524,24563</elements> <!-- Only select an element (comma separated list) -->
  <modules>12354</modules> <!-- Select a module (comma separated list) -->
  <models>12564</models> <!-- Select a model (comma separated list) -->
  <generations>1215</generations>  <!-- Select a generation input (comma separated list) -->
</modeler>

Instead of the Models it is also possible to directly add Models from the Modeler

Projects¶

<projects>
  <project>
    <virtualProject>Project 1</virtualProject>
    <directory>project1/</directory>
  </project>
  <project>
    <virtualProject>Project 2</virtualProject>
    <directory>project2/</directory>
    <options>
      <option>
        <name>name</name>
        <value>value</value>
      </option>
    </options>
  </project>
</projects>

The project mapping is also added to the generator section. The directory tag is optional. If it is skipped the code will be generated into the same directory as the configuration file. If it is present, the code will be generated into the directory. It is also possible to change the options only for a Virtual Project. See Options

Options¶

See Options

Options¶

<options>
  <option>
    <name>name</name>
    <value>value</value>
  </option>
</options>

A list of generator options. They can be set for the generator or for each virtual project individually.