Hop Maven PluginDocs

Menu

hop:server-stop

Gracefully stops a running Hop server by sending the authenticated /shutdown request that Hop Server exposes (it registers a JVM shutdown hook on it). The target host/port and whether authentication is enabled are read from serverConfig (hop-server.xml, defaulting to the server goal workdir); stopHost/ stopPort are only a fallback when the config file is not present. After the shutdown request the mojo waits up to shutdownTimeoutMs for the port to free up.

Coordinates

<plugin>
  <groupId>io.yupiik.hop</groupId>
  <artifactId>hop-maven-plugin</artifactId>
  <version>1.0.1-SNAPSHOT</version>
</plugin>

To call this goal from the command line execute: mvn hop:server-stop.

To bind this goal in the build you can use: 

<plugin>
  <groupId>io.yupiik.hop</groupId>
  <artifactId>hop-maven-plugin</artifactId>
  <version>1.0.1-SNAPSHOT</version>
  <executions>
    <execution>
      <id>my-execution</id>
      <goals>
        <goal>server-stop</goal>
      </goals>
      <configuration>
        <!-- execution specific configuration come there -->
      </configuration>
    </execution>
  </executions>
</plugin>

You can execute this goal particularly with mvn hop:server-stop@my-execution command.

Configuration

action2ArtifactMapping (Map)

Override mappings from action plugin id to the artifact (artifactId or full groupId:artifactId:version coordinates) shipping it. Entries take precedence over the built-in table; the default rule is org.apache.hop:hop-action-<id>.

autoResolve (boolean)

Resolve the Hop plugin artifacts (transforms and actions) declared by the rendered diagrams with the Maven resolver, stage them and register them into the Hop registry programmatically. This removes the need to add hop-transform-* / hop-action-* modules as dependencies of this plugin for icon rendering. No JVM-global property is set; the resolution/staging phase runs outside any lock and the registration is serialized on HopEnvironment.class so several mojos can run concurrently in the same build. Default value: false. Property: ${hop.autoResolve}.

autoResolvePluginsFolder (java.io.File)

Staging folder where auto-resolved plugin jars are copied (plugin jar at the root, dependencies in a lib/ sub-folder). Only used when autoResolve is enabled. Property: ${hop.autoResolvePluginsFolder}.

autoResolveVersion (String)

Version used when a mapped artifact is given as a bare hop-transform-<id> artifactId (no explicit version). Defaults to the Hop version this plugin runs against when it can be detected, otherwise Apache Hop dependency version. Property: ${hop.autoResolveVersion}.

configFile (java.io.File)

JSON file declaring the Hop variables to inject before diagrams are resolved and rendered. The file may be a canonical Hop project-config.json (reading config.variables) or any JSON exposing a top-level variables array, each entry being {name, value, description}. Property: ${hop.configFile}.

excludes (List)

Ant-style glob patterns excluding files from processing. Property: ${hop.excludes}.

includes (List)

Ant-style glob patterns selecting files to process (applied to the source-relative path). Property: ${hop.includes}.

metadataFolder (java.io.File)

The metadata base folder holding the HOP metadata (rdbms, run configurations, ...). Defaults to <project.basedir>/metadata, matching the canonical Hop metadataBaseFolder={PROJECT_HOME/metadata}. Property: ${hop.metadataFolder}.

recursive (boolean)

Recurse into sub-folders of sourceFolder . Default value: true. Property: ${hop.recursive}.

serverConfig (java.io.File)

Path to the hop-server.xml config of the running server (defaults to the exploded distribution used by the server goal). Default value: ${project.build.directory}/hop/server/exploded/hop-server.xml. Property: ${hop.server.stop.serverConfig}.

shutdownTimeoutMs (long)

How long to wait for the server port to free up after the shutdown request. Default value: 30000. Property: ${hop.server.stop.timeoutMs}.

sourceFolder (java.io.File)

Root folder where HOP diagram files (.hpl, .hwf) are searched. Defaults to the project base dir, following the Apache Hop convention where pipelines and workflows are stored directly in the project folder. Property: ${hop.sourceFolder}.

stopHost (String)

Fallback host (used only when serverConfig is not readable). Never hardcoded. Property: ${hop.server.stop.host}.

stopPassword (String)

Password for the /shutdown basic auth. Property: ${hop.server.stop.password}.

stopPort (Integer)

Fallback port (used only when serverConfig is not readable). Never hardcoded. Property: ${hop.server.stop.port}.

stopUser (String)

Username for the /shutdown basic auth (Hop default user is cluster). Default value: cluster. Property: ${hop.server.stop.user}.

transform2ArtifactMapping (Map)

Override mappings from transform plugin id to the artifact (artifactId or full groupId:artifactId:version coordinates) shipping it. Entries take precedence over the built-in table; the default rule is org.apache.hop:hop-transform-<id>.

Navigation