You are viewing the documentation for Blueriq 13. Documentation for other versions is available in our documentation directory.

This document explains how to configure the maven plugin to generate metamodel classes from your Studio model.

Getting started

Create a Maven project with the following POM:

pom.xml
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>org.mycustomer</groupId>
	<artifactId>myproject-metamodel</artifactId>
	<version>1.0-SNAPSHOT</version>
	<name>myproject-metamodel</name>
	<properties>
		<com.blueriq.version>10.0-SNAPSHOT</com.blueriq.version>
	</properties>
	<dependencies>
		<dependency>
			<groupId>com.blueriq</groupId>
			<artifactId>blueriq-sdk</artifactId>
			<version>${com.blueriq.version}</version>
		</dependency>
	</dependencies>
	<build>
		<plugins>
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-compiler-plugin</artifactId>
				<version>3.6.1</version>
				<configuration>
					<source>1.7</source>
					<target>1.7</target>
				</configuration>
			</plugin>
			<plugin>
				<groupId>com.blueriq</groupId>
				<artifactId>blueriq-metamodelgenerator-maven-plugin</artifactId>
				<version>${com.blueriq.version}</version>
				<executions>
					<execution>
						<phase>generate-sources</phase>
						<goals>
							<goal>generate-metamodel</goal>
						</goals>
					</execution>
				</executions>
				<configuration>
					<connections>
						<studio>
							<repository>MyRepository</repository>
							<branch>Trunk</branch>
							<project>MyProject</project>
							<destdir>src/main/java</destdir>
							<packageName>org.mycustomer.myproject.metamodel</packageName>
							<url>http://SERVER:PORT/Studio/Server/Services/ManagementService</url>
							<authentication>BASIC</authentication>
							<domain />
							<userName></userName>
							<passWord></passWord>
							<exportProject>true</exportProject>
							<generatePOJOs>true</generatePOJOs>
							<generateRequiredMethods>true</generateRequiredMethods>
							<generateInstanceLocator>true</generateInstanceLocator>
						</studio>
						<offline>
							<applicationFile>${project.basedir}/MyProject.project.zip</applicationFile>
							<destdir>src/main/java</destdir>
							<packageName>org.mycustomer.myproject.metamodel</packageName>
							<generatePOJOs>true</generatePOJOs>
							<generateRequiredMethods>true</generateRequiredMethods>
							<generateInstanceLocator>true</generateInstanceLocator>
						</offline>
					</connections>
				</configuration>
			</plugin>
		</plugins>
	</build>
</project>


Configuration of the POM

You have to define the location of your Studio model(s) from which you will generate metamodel classes. The models can be retrieved directly from Studio or from an export. To define this, within the <connections> section you can add one or more <studio> (connection to Studio) or <offline> (export) connections.

Studio connection


ParameterDescriptionDefault value
repositoryName of the Blueriq repository
branchName of the Blueriq branch
projectName of the Blueriq project
destdirDestination directory where all the java classes are storedsrc/main/java
packageNameName of the base java package
urlURL of the Blueriq Studio management service
authenticationAuthentication method. Possible values are BASIC, NTLM and NTLM_CUSTOMBASIC
domainBlueriq domain (can be left blank)
userNameBlueriq username
passWordBlueriq password
exportProjectSet to true if you want to generate the Blueriq project exportfalse
exportProjectDir

Foldername to save the export

target
generatePOJOsSet to true if you want to generate the POJO class of a Blueriq Entityfalse
generateRequiredMethodsSet to true if you want to generate the getRequired<attribute> methodsfalse
generateInstanceLocatorSet to true if you want to use the InstanceLocator classfalse


bold = required

Offline connection

This connection will pick up the given file name and presumes there is an export in it. It will then use the export to create the metamodel.


ParameterDescriptionDefault value
applicationFilePath of the export file${project.basedir}/MyProject.project.zip
destdirDestination directory where all the java classes are storedsrc/main/java
packageNameName of the base java package
generatePOJOsSet to true if you want to generate the POJO class of a Blueriq Entityfalse
generateRequiredMethodsSet to true if you want to generate the getRequired&tl;attribute> methodsfalse
generateInstanceLocatorSet to true if you want to use the InstanceLocator classfalse


bold = required

  • No labels

4 Comments

  1. is it possible to NOT generate the metamodel classes but only the export ?

    1. Unknown User (v.bingley)

      You can generate exports using the blueriq-projectexport-maven-plugin, I was unable to find any documentation about this plugin however. The only page I could find that mentions it is this one:
      Installatie handleiding Jenkins model pipeline

      You can open the linked pom.xml for an example configuration.

      Edit:
      It looks like this is an internal link, you might not be able to access it.
      The metamodel generator plugin cannot be configured to only generate exports. It might be worth it to create a ticket about the blueriq-projectexport-maven-plugin if you're interested in using it as I don't know why it isn't documented.

      1. thx, we are looking into this with another blueriq expert.

  2. and does the plugin add the destdir value to the maven sources ?