Welcome!

Industrial IoT Authors: APM Blog, Elizabeth White, Pat Romanski, William Schmarzo, Liz McMillan

Blog Feed Post

Creating maven archetype using create-from-project

Maven archetypes are a great way to create templates for standardized projects. The advantage of creating a maven archetype is that it can easily integrate with any IDE that supports maven compilation such as Eclipse. In SMART we provide maven archetypes to get started on developing SMART flows easily. In this blog I want to share our learning when creating these archetypes.

Sample Archetype

We will write an archetype called simple-archetype that generates the following structure:

    pom.xml
    src
     |--main
        |-- java
        |   |-- package (org.smart.demo)
        |       |-- TestMessage.java
        |-- resources
            |-- TestMessageFlow.soa
            |-- package (org.smart.demo)
                |-- TestMessage.soa

when the below command is run:

 mvn archetype:generate \
-DarchetypeGroupId=org.smart.archetypes \
-DarchetypeArtifactId=simple-archetype \  
-DarchetypeVersion=1.0-SNAPSHOT \  
-DgroupId=org.smart.demo \  
-DartifactId=testmessage \  
-Dclassname=TestMessage

Creating the skeleton archetype project

Maven archetypes can be created easily using the create-from-project maven command. To create an archetype from a project run the command from the directory where the template project is present.

mvn archetype:create-from-project

We will use the sample template project from here to create the archetype. This creates an archetype from the current project into the directory target/generated-sources/archetype. When we look at the generated project for the archetype we find that Message.java is hardcoded. Hence using this archetype will always only generate back the same fields and java classes as present in the template project.

archetype properties

How to vary the generated class? By default maven has a set of standard variables defined that can be varied when the project is created. The most common ones that are used:

  • groupId
  • artifactId
  • version
  • package

These are defaulted to the values in the project from which the artefact is created. More variables can be added to this as required for the archetype. For eg., in our project we want to vary the name of Message.java, to do this we will introduce a new variable called “data” that can be specified when the maven project is created.

The maven create-from-project takes in a archetype properties file that define these variables. To use this we define a generate.properties file with content as below (Ensure this file is present outside the directory of your template project):

package=org.smart.flows.message
groupId=org.smart.flows
artifactId=message
version=1.0-SNAPSHOT
data=Message

The values should be the values that are present in the template project. In our example, we have the data class in the package org.smart.flows.message and it is called Message.java. Hence we have defined the “data” variable as Message. This is important because the create-from-project will automatically replace the values with the variables. Now you can run the command as

mvn -Darchetype.properties=../generate.properties archetype:create-from-project

The Message.java that is generated will be as below:

#set( $symbol_pound = '#' )
#set( $symbol_dollar = '$' )
#set( $symbol_escape = '\' )
package ${groupId}.${artifactId};

public class ${data} implements java.io.Serializable
{
    private String ${artifactId};

    public ${data}()
    {
    }

    public String get${data}() { return ${artifactId}; }
}

Now the content of the java file will vary based on the “data” and “artifactId” variables set. The generated project has a few things that has to be fixed.

  • The name of the java file is still hardcoded to Message.java.
  • The files in resources directory is still hardcoded with Message

Changing the name of the generated file

The files that will be used to generate the project is present under the directory “src/main/resources/archetype-resources/”. The java file is under “src/main/java”. Move the Message.java file to  __data__.java. This will ensure that the generated file is the same name as the variable passed to the maven command. The package variable is not correct, since the artifactId and groupId reflect the package name. Hence we change the package from ${groupId}.${artifactId} to ${package}. This sets up the java class correctly.

The test classes also need to follow the same pattern, except the file has to have a “Test” post fixed to the name. Hence we rename the test file as __data__Test.java. Any variations in the java classes can be done manually. Any ${…} inside the file is substituted with the variable value and __…__ in the file name is substituted with the variable value.

Changing the resources directory

While the java classes are by default created with substitution variables, the resources are not. These files need to be modified manually. In our case we have two files to be generated. Flow.soa that describes our jar.The .soa describes our data class and has to be present in the same package as the java class. Modification for substitution is simple. The soa file is changed as below:

##set( $symbol_pound = '#' )
##set( $symbol_dollar = '$' )
##set( $symbol_escape = '\' )
name:   ${data}Flow
defaultEnable: all
primeData:
    - ${package}.${data}
events:
    - ${package}.${event}
transitions:
    - ${package}.${transition}
features:
    - name: all
      artefacts:
        - ${package}.${data}
        - ${package}.${event}
        - ${package}.${transition}

We need to add the first three lines in all files. This has to be equal to a comment, hence we use “##”. We replace all places where substitution has to occur with the proper variables. This generates the file with the correct substitutions. But changing the name of the file to “__data__Flow.soa” does not change the file name based on the variable.

To do this we need to change the archetype metadata. This is present under the directory “src/main/resources/META-INF/maven/” in the file archetype-metadata.xml. The fileset command in this file defines how the files are created:

  

    <fileSet filtered="true" packaged="true" encoding="UTF-8">
      src/main/java

        **/*.java

    <fileSet encoding="UTF-8">
      src/main/resources

        **/*.soa

    
    <fileSet filtered="true" packaged="true" encoding="UTF-8">
      src/test/java

        **/*.java

From the above we see that the resources directory is a direct copy. To change this we need two variables defined, filtered and packaged. So we redefine this as below:

    <fileSet encoding="UTF-8" packaged="true" filtered="true">
      src/main/resources

        **/__*__.soa

    filtered="true">
      src/main/resources

        **/*Flow.soa
        **/*.js

We need the Flow.soa directly under the parent directory while the .soa file needs to be present in the packaged directory. Hence we split this into two filesets. Now we rename the files appropriately i.e., MessageFlow.soa is named as __data__Flow.soa and Message.soa is directly under the resources directory and named as __data__.soa file. This ensures that we get the correct project generated when the maven command is run.The generated maven archetype can be checked out here.


Read the original blog entry...

More Stories By Raji Sankar

Raji Sankar is a techie at heart trying his hand at entrepreneur-ship. He is Co-Founder and Director of BrioTribes Technologies India Pvt Ltd. based out of Bangalore. He likes to try out anything that is new, interesting and cutting edge. His latest passion is cloud and creating an application platform for the cloud. Check out SMART the documentation for the open-source cloud application platform here and the demo for the platform here

@ThingsExpo Stories
In his session at 21st Cloud Expo, Carl J. Levine, Senior Technical Evangelist for NS1, will objectively discuss how DNS is used to solve Digital Transformation challenges in large SaaS applications, CDNs, AdTech platforms, and other demanding use cases. Carl J. Levine is the Senior Technical Evangelist for NS1. A veteran of the Internet Infrastructure space, he has over a decade of experience with startups, networking protocols and Internet infrastructure, combined with the unique ability to it...
"There's plenty of bandwidth out there but it's never in the right place. So what Cedexis does is uses data to work out the best pathways to get data from the origin to the person who wants to get it," explained Simon Jones, Evangelist and Head of Marketing at Cedexis, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
"Cloud Academy is an enterprise training platform for the cloud, specifically public clouds. We offer guided learning experiences on AWS, Azure, Google Cloud and all the surrounding methodologies and technologies that you need to know and your teams need to know in order to leverage the full benefits of the cloud," explained Alex Brower, VP of Marketing at Cloud Academy, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clar...
Large industrial manufacturing organizations are adopting the agile principles of cloud software companies. The industrial manufacturing development process has not scaled over time. Now that design CAD teams are geographically distributed, centralizing their work is key. With large multi-gigabyte projects, outdated tools have stifled industrial team agility, time-to-market milestones, and impacted P&L stakeholders.
Gemini is Yahoo’s native and search advertising platform. To ensure the quality of a complex distributed system that spans multiple products and components and across various desktop websites and mobile app and web experiences – both Yahoo owned and operated and third-party syndication (supply), with complex interaction with more than a billion users and numerous advertisers globally (demand) – it becomes imperative to automate a set of end-to-end tests 24x7 to detect bugs and regression. In th...
"Akvelon is a software development company and we also provide consultancy services to folks who are looking to scale or accelerate their engineering roadmaps," explained Jeremiah Mothersell, Marketing Manager at Akvelon, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
"MobiDev is a software development company and we do complex, custom software development for everybody from entrepreneurs to large enterprises," explained Alan Winters, U.S. Head of Business Development at MobiDev, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
SYS-CON Events announced today that CrowdReviews.com has been named “Media Sponsor” of SYS-CON's 22nd International Cloud Expo, which will take place on June 5–7, 2018, at the Javits Center in New York City, NY. CrowdReviews.com is a transparent online platform for determining which products and services are the best based on the opinion of the crowd. The crowd consists of Internet users that have experienced products and services first-hand and have an interest in letting other potential buye...
"IBM is really all in on blockchain. We take a look at sort of the history of blockchain ledger technologies. It started out with bitcoin, Ethereum, and IBM evaluated these particular blockchain technologies and found they were anonymous and permissionless and that many companies were looking for permissioned blockchain," stated René Bostic, Technical VP of the IBM Cloud Unit in North America, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Conventi...
SYS-CON Events announced today that Telecom Reseller has been named “Media Sponsor” of SYS-CON's 22nd International Cloud Expo, which will take place on June 5-7, 2018, at the Javits Center in New York, NY. Telecom Reseller reports on Unified Communications, UCaaS, BPaaS for enterprise and SMBs. They report extensively on both customer premises based solutions such as IP-PBX as well as cloud based and hosted platforms.
"Space Monkey by Vivent Smart Home is a product that is a distributed cloud-based edge storage network. Vivent Smart Home, our parent company, is a smart home provider that places a lot of hard drives across homes in North America," explained JT Olds, Director of Engineering, and Brandon Crowfeather, Product Manager, at Vivint Smart Home, in this SYS-CON.tv interview at @ThingsExpo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
Coca-Cola’s Google powered digital signage system lays the groundwork for a more valuable connection between Coke and its customers. Digital signs pair software with high-resolution displays so that a message can be changed instantly based on what the operator wants to communicate or sell. In their Day 3 Keynote at 21st Cloud Expo, Greg Chambers, Global Group Director, Digital Innovation, Coca-Cola, and Vidya Nagarajan, a Senior Product Manager at Google, discussed how from store operations and ...
It is of utmost importance for the future success of WebRTC to ensure that interoperability is operational between web browsers and any WebRTC-compliant client. To be guaranteed as operational and effective, interoperability must be tested extensively by establishing WebRTC data and media connections between different web browsers running on different devices and operating systems. In his session at WebRTC Summit at @ThingsExpo, Dr. Alex Gouaillard, CEO and Founder of CoSMo Software, presented ...
WebRTC is great technology to build your own communication tools. It will be even more exciting experience it with advanced devices, such as a 360 Camera, 360 microphone, and a depth sensor camera. In his session at @ThingsExpo, Masashi Ganeko, a manager at INFOCOM Corporation, introduced two experimental projects from his team and what they learned from them. "Shotoku Tamago" uses the robot audition software HARK to track speakers in 360 video of a remote party. "Virtual Teleport" uses a multip...
A strange thing is happening along the way to the Internet of Things, namely far too many devices to work with and manage. It has become clear that we'll need much higher efficiency user experiences that can allow us to more easily and scalably work with the thousands of devices that will soon be in each of our lives. Enter the conversational interface revolution, combining bots we can literally talk with, gesture to, and even direct with our thoughts, with embedded artificial intelligence, whic...
SYS-CON Events announced today that Evatronix will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Evatronix SA offers comprehensive solutions in the design and implementation of electronic systems, in CAD / CAM deployment, and also is a designer and manufacturer of advanced 3D scanners for professional applications.
Leading companies, from the Global Fortune 500 to the smallest companies, are adopting hybrid cloud as the path to business advantage. Hybrid cloud depends on cloud services and on-premises infrastructure working in unison. Successful implementations require new levels of data mobility, enabled by an automated and seamless flow across on-premises and cloud resources. In his general session at 21st Cloud Expo, Greg Tevis, an IBM Storage Software Technical Strategist and Customer Solution Architec...
To get the most out of their data, successful companies are not focusing on queries and data lakes, they are actively integrating analytics into their operations with a data-first application development approach. Real-time adjustments to improve revenues, reduce costs, or mitigate risk rely on applications that minimize latency on a variety of data sources. In his session at @BigDataExpo, Jack Norris, Senior Vice President, Data and Applications at MapR Technologies, reviewed best practices to ...
An increasing number of companies are creating products that combine data with analytical capabilities. Running interactive queries on Big Data requires complex architectures to store and query data effectively, typically involving data streams, an choosing efficient file format/database and multiple independent systems that are tied together through custom-engineered pipelines. In his session at @BigDataExpo at @ThingsExpo, Tomer Levi, a senior software engineer at Intel’s Advanced Analytics gr...
When talking IoT we often focus on the devices, the sensors, the hardware itself. The new smart appliances, the new smart or self-driving cars (which are amalgamations of many ‘things’). When we are looking at the world of IoT, we should take a step back, look at the big picture. What value are these devices providing? IoT is not about the devices, it’s about the data consumed and generated. The devices are tools, mechanisms, conduits. In his session at Internet of Things at Cloud Expo | DXWor...