Maven Plugin

Coordinates

  1. <plugin>
  2.   <groupId>org.apache.batchee</groupId>
  3.   <artifactId>batchee-maven-plugin</artifactId>
  4.   <version>${batchee.version}</version>
  5. </plugin>

Documentation generation parsing batch components

BatchEE provides a doc goal allowing to parse BatchProperty to generate your JBatch component documentation.

You can run it on a plain JBatch module but it is recommanded to add doc-api dependency to be able to use @Documentation to describe what the property is used for:

  1. <dependency>
  2.   <groupId>org.apache.batchee</groupId>
  3.   <artifactId>batchee-doc-api</artifactId>
  4.   <version>${batchee.version}</version>
  5. </plugin>

Then simply run:

mvn batchee:doc

Configuration for a remote BatchEE instance (JAX-RS client)

  1. <plugin>
  2.   <groupId>org.apache.batchee</groupId>
  3.   <artifactId>batchee-maven-plugin</artifactId>
  4.   <version>0.0.1-SNAPSHOT</version>
  5.   <configuration>
  6.     <clientConfiguration>
  7.       <baseUrl>http://localhost:8080/myapp/</baseUrl>
  8.       <jsonProvider>org.apache.johnzon.jaxrs.JohnzonProvider</jsonProvider>
  9.       <security>
  10.         <type>Basic</type>
  11.         <username>foo</username>
  12.         <password>bar</password>
  13.       </security>
  14.       <ssl>
  15.         <hostnameVerifier>org.MyHostVerifier</hostnameVerifier>
  16.         <keystorePassword>xxx</keystorePassword>
  17.         <keystoreType>JKS</keystoreType>
  18.         <keystorePath>/c/cert.crt</keystorePath>
  19.         <sslContextType>TLS</sslContextType>
  20.         <keyManagerType>SunX509</keyManagerType>
  21.         <keyManagerPath>/....</keyManagerPath>
  22.         <trustManagerAlgorithm>...</trustManagerAlgorithm>
  23.         <trustManagerProvider>...</trustManagerProvider>
  24.         <hostnameVerifier>org.MyHostVerifier</hostnameVerifier>
  25.       </ssl>
  26.     </clientConfiguration>
  27.   </configuration>
  28. </plugin>

Goals

  1. batchee:abandon
  2.   Abandon a job.
  3.  
  4.   Available parameters:
  5.  
  6.     clientConfiguration
  7.       when executed remotely the client configuration
  8.  
  9.     executionId
  10.       the executionId to abandon.
  11.       Required: Yes
  12.  
  13.     jobOperatorClass
  14.       force to use a custom JobOperator
  15.  
  16.     jsonProvider
  17.       The json provider to use to unmarshall responses in remote mode
  18.  
  19.     properties
  20.       the BatchEE properties when executed locally
  21.  
  22. batchee:count-instance
  23.   Count job instance.
  24.  
  25.   Available parameters:
  26.  
  27.     clientConfiguration
  28.       when executed remotely the client configuration
  29.  
  30.     jobName
  31.       the job name to use to count job instances
  32.       Required: Yes
  33.  
  34.     jobOperatorClass
  35.       force to use a custom JobOperator
  36.  
  37.     jsonProvider
  38.       The json provider to use to unmarshall responses in remote mode
  39.  
  40.     properties
  41.       the BatchEE properties when executed locally
  42.  
  43. batchee:execution
  44.   Print job an execution.
  45.  
  46.   Available parameters:
  47.  
  48.     clientConfiguration
  49.       when executed remotely the client configuration
  50.  
  51.     executionId
  52.       the executionId to query.
  53.       Required: Yes
  54.  
  55.     jobOperatorClass
  56.       force to use a custom JobOperator
  57.  
  58.     jsonProvider
  59.       The json provider to use to unmarshall responses in remote mode
  60.  
  61.     properties
  62.       the BatchEE properties when executed locally
  63.  
  64. batchee:executions
  65.   Print job instance executions.
  66.  
  67.   Available parameters:
  68.  
  69.     clientConfiguration
  70.       when executed remotely the client configuration
  71.  
  72.     instanceId
  73.       the instanceId to use to query job executions
  74.       Required: Yes
  75.  
  76.     jobName
  77.       the job name to use to query job executions
  78.       Required: Yes
  79.  
  80.     jobOperatorClass
  81.       force to use a custom JobOperator
  82.  
  83.     jsonProvider
  84.       The json provider to use to unmarshall responses in remote mode
  85.  
  86.     properties
  87.       the BatchEE properties when executed locally
  88.  
  89. batchee:help
  90.   Display help information on batchee-maven-plugin.
  91.   Call mvn batchee:help -Ddetail=true -Dgoal=<goal-name> to display parameter
  92.   details.
  93.  
  94.   Available parameters:
  95.  
  96.     detail
  97.       If true, display all settable properties for each goal.
  98.  
  99.     goal
  100.       The name of the goal for which to show help. If unspecified, all goals
  101.       will be displayed.
  102.  
  103.     indentSize
  104.       The number of spaces per indentation level, should be positive.
  105.  
  106.     lineLength
  107.       The maximum length of a display line, should be positive.
  108.  
  109. batchee:instance
  110.   Print JobInstance for a particular execution.
  111.  
  112.   Available parameters:
  113.  
  114.     clientConfiguration
  115.       when executed remotely the client configuration
  116.  
  117.     executionId
  118.       the executionId to use to find the corresponding job instance
  119.       Required: Yes
  120.  
  121.     jobOperatorClass
  122.       force to use a custom JobOperator
  123.  
  124.     jsonProvider
  125.       The json provider to use to unmarshall responses in remote mode
  126.  
  127.     properties
  128.       the BatchEE properties when executed locally
  129.  
  130. batchee:instances
  131.   Print job instances.
  132.  
  133.   Available parameters:
  134.  
  135.     clientConfiguration
  136.       when executed remotely the client configuration
  137.  
  138.     count
  139.       the maximum number of instance to bring back
  140.  
  141.     jobName
  142.       the job name to use to find job instances
  143.       Required: Yes
  144.  
  145.     jobOperatorClass
  146.       force to use a custom JobOperator
  147.  
  148.     jsonProvider
  149.       The json provider to use to unmarshall responses in remote mode
  150.  
  151.     properties
  152.       the BatchEE properties when executed locally
  153.  
  154.     start
  155.       the first job instance to take into account
  156.  
  157. batchee:job-names
  158.   List all executed job names.
  159.  
  160.   Available parameters:
  161.  
  162.     clientConfiguration
  163.       when executed remotely the client configuration
  164.  
  165.     jobOperatorClass
  166.       force to use a custom JobOperator
  167.  
  168.     jsonProvider
  169.       The json provider to use to unmarshall responses in remote mode
  170.  
  171.     properties
  172.       the BatchEE properties when executed locally
  173.  
  174. batchee:parameters
  175.   Print parameters for a particular execution.
  176.  
  177.   Available parameters:
  178.  
  179.     clientConfiguration
  180.       when executed remotely the client configuration
  181.  
  182.     executionId
  183.       the executionId to query to find parameters
  184.       Required: Yes
  185.  
  186.     jobOperatorClass
  187.       force to use a custom JobOperator
  188.  
  189.     jsonProvider
  190.       The json provider to use to unmarshall responses in remote mode
  191.  
  192.     properties
  193.       the BatchEE properties when executed locally
  194.  
  195. batchee:restart
  196.   Restart a job.
  197.  
  198.   Available parameters:
  199.  
  200.     clientConfiguration
  201.       when executed remotely the client configuration
  202.  
  203.     executionId
  204.       the executionId representing the execution to restart
  205.       Required: Yes
  206.  
  207.     jobOperatorClass
  208.       force to use a custom JobOperator
  209.  
  210.     jobParameters
  211.       the job parameters to use.
  212.  
  213.     jsonProvider
  214.       The json provider to use to unmarshall responses in remote mode
  215.  
  216.     properties
  217.       the BatchEE properties when executed locally
  218.  
  219.     wait
  220.       wait or not the end of this task before exiting maven plugin execution.
  221.  
  222. batchee:running
  223.   List running executions.
  224.  
  225.   Available parameters:
  226.  
  227.     clientConfiguration
  228.       when executed remotely the client configuration
  229.  
  230.     jobName
  231.       the job name used to query running executions
  232.       Required: Yes
  233.  
  234.     jobOperatorClass
  235.       force to use a custom JobOperator
  236.  
  237.     jsonProvider
  238.       The json provider to use to unmarshall responses in remote mode
  239.  
  240.     properties
  241.       the BatchEE properties when executed locally
  242.  
  243. batchee:start
  244.   Start a job.
  245.  
  246.   Available parameters:
  247.  
  248.     additionalClasspathEntries
  249.       manual entries added in the execution classpath
  250.  
  251.     clientConfiguration
  252.       when executed remotely the client configuration
  253.  
  254.     jobName
  255.       the job name of the job to start
  256.       Required: Yes
  257.  
  258.     jobOperatorClass
  259.       force to use a custom JobOperator
  260.  
  261.     jobParameters
  262.       the job parameters to use.
  263.  
  264.     jsonProvider
  265.       The json provider to use to unmarshall responses in remote mode
  266.  
  267.     properties
  268.       the BatchEE properties when executed locally
  269.  
  270.     useProjectClasspath
  271.       if the project (binaries + dependencies) should be added during the
  272.       execution to the classpath
  273.  
  274.     wait
  275.       wait or not the end of this task before exiting maven plugin execution.
  276.  
  277. batchee:step-executions
  278.   Print step executions of a job execution.
  279.  
  280.   Available parameters:
  281.  
  282.     clientConfiguration
  283.       when executed remotely the client configuration
  284.  
  285.     executionId
  286.       the executionId used to find step executions.
  287.       Required: Yes
  288.  
  289.     jobOperatorClass
  290.       force to use a custom JobOperator
  291.  
  292.     jsonProvider
  293.       The json provider to use to unmarshall responses in remote mode
  294.  
  295.     properties
  296.       the BatchEE properties when executed locally
  297.  
  298. batchee:stop
  299.   Stop a job.
  300.  
  301.   Available parameters:
  302.  
  303.     clientConfiguration
  304.       when executed remotely the client configuration
  305.  
  306.     executionId
  307.       the executionId of the execution to stop
  308.       Required: Yes
  309.  
  310.     jobOperatorClass
  311.       force to use a custom JobOperator
  312.  
  313.     jsonProvider
  314.       The json provider to use to unmarshall responses in remote mode
  315.  
  316.     properties
  317.       the BatchEE properties when executed locally