PL/SQL Connector Builder Maven-Plugin Documentation

Installation

• The PL/SQL Connector Builder is installed in the Central Maven Repository.
• For private networks the PL/SQL Connector Builder can be downloaded from the download section.

Configure pom.xml (Minimum Configuration)

XML-File : pom.xml

<build>
  <plugins>
    ...
    <plugins>
      <plugin>
        <groupId>com.jr-database-tools.dbworkbench</groupId>
        <artifactId>connectorbuilder-maven-plugin</artifactId>
        <configuration>
          <connector_builder_filename>batch_stream_processor_factoryapi_11.batch_bldr</connector_builder_filename>
        </configuration>
        <executions>
          <execution>
            <phase>generate-sources</phase>
            <goals>
              <goal>run</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
    ...
  </plugins>
</build>

Required Parameters

• connector_builder_filename : Only the filename is required. All other parameters are taken from the configuration setup.

Configure pom.xml (Full Configuration)

XML-File : pom.xml

<build>
  <plugins>
    ...
    <plugin>
      <groupId>de.jrdatabasetools.dbworkbench</groupId>
      <artifactId>connectorbuilder-maven-plugin</artifactId>
      <version>25.1.0</version>
      <configuration>
        <connectorBuilderName>rmi</connectorBuilderName>
        <url>${db.url}</url>
        <user>${db.username}</user>
        <password>${db.password}</password>
        <info>warning</info>
        <build_target>client</build_target>
        <connection_login_timeout>10</connection_login_timeout>
        <connection_pool_max_size>8</connection_pool_max_size>
        <connection_pool_validate_on_borrow>true</connection_pool_validate_on_borrow>
        <connection_pool_validate_wait_timeout>20000</connection_pool_validate_wait_timeout>
        <connection_pool_borrow_timeout>60000</connection_pool_borrow_timeout>
      </configuration>
      <executions>
        <execution>
          <phase>generate-sources</phase>
          <goals>
            <goal>run</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
    ...
  </plugins>
</build>

Optional Parameters to Overwrite Configuration

• url, user, password : Connection parameter overwrites setting of the connector builder (optional).

Build Target Parameter - Maven Specific

• build_target : single, client, server, all.
  • This parameter is the only Maven Specific Parameter.
  • RawJdbc, JavaRPC, Batch-Stream : For Single-Build-Runs 'build_target' need not to be set and defaults to 'single'
  • Spring-Remoting, Java-EE, RMI, ... : For Client-Server-Build-Runs 'build_target' needed be set to identify Server or Client code generation. 'build_target' need to be set to 'client' or 'server'.

Optional Default Parameters

• info : Information level of output during connector builder run. Valid values : all, compact, warning (optional, default:all).
• connection_login_timeout : wait number of seconds to connect to database (default:10 seconds).
• connection_pool_max_size : maximum number of connections in pool (default: 8).
• connection_pool_borrow_timeout : maximum time in milliseconds to acquire connection from connection pool (default:60000 ms).
• connection_pool_validate_on_borrow : verify connection after acquire from pool before usage (default:false).
• connection_pool_validate_wait_timeout : timeout in seconds to verify connection after acquire (default:5 seconds).

Run PL/SQL Connector Builder from command line

• mvn connectorbuilder:run