How to run JobScheduler with Jetty

WORK IN PROGRESSh1. > this document is not yet linked in the Index of the wiki

Currently JobScheduler shipped with a proprietary built-in web server. Using the JobScheduler plugin feature it is possible to configure JobScheduler for working with Jetty. This document describes what you have to do, to run JobScheduler with an underlaying Jetty web server.

Installation

Now we have a "full" installer and an update installer with jetty. It is only a test version with the snapshot JobScheduler 1.3.12.2020-SNAPSHOT.
The update installer expects an existing installation.

The installer tries to generate some symlinks to simulate virtual directories for JOC (JobScheduler Operations Center). The symlink generation is not supported for Windows older than Vista.

The installer configures the ./config/factory.ini, the ./config/scheduler.xml, the ./config/live/jetty.xml and the ./config/live/web.xml as described below. The installer contains a keystore file for testing https. This keystore is not trusted and has a wrong hostname inside, but can still be used for testing.

Please make your own keystore file jetty.jks.

After the installation you can open JOC with jetty via

You can change these ports in the ./config/live/web.xml.

Configure factory.ini (Put the necessary libraries in the classpath)

To run JobScheduler with Jetty instead the built-in web-server you have to use the Jetty plugin. It is a part of the library jetty-xxx.jar. Beside the jetty-xxx.jar it is necessary to put the dependend libraries for the jetty plugin into the classpath of the JobScheduler. The best place is to put them into the lib folder. If you use another folder, you have to add it to your classpath (see factory.ini).

Configure scheduler.xml

To use the jetty plugin you have to configure it in the scheduler.xml:

 <spooler>
  <config ...>
    <plugins>
      ...
      <plugin java_class="com.sos.scheduler.engine.plugins.jetty.JettyPlugin">
        <plugin.config />
      </plugin>
      ...
    </plugins>
    ...
  </config>
 </spooler>

Please note that it is necessary to specify an empty plugin.config element.

Configure jetty.xml

To run JobScheduler with jetty it is also necessary to create two configuration files for the Jetty web server (jetty.xml and web.xml). It has to place in the root of your live folder (not in the config folder). The minimal declaration defines a connector for the port to communicate with JobScheduler via http:

 <Configure class="org.eclipse.jetty.server.Server">
   <Call name="addConnector">
     <Arg>
       <New class="org.eclipse.jetty.server.nio.SelectChannelConnector">
         <Set name="port">44440</Set>
       </New>
     </Arg>
   </Call>
 </Configure>

It is important to know that this port (here 44440) is a substitute for the port attribute in the config element of scheduler.xml.

With a second connector it is possible to define a communication channel via https (ssl):

 <Call name="addConnector">
  <Arg>
    <New class="org.eclipse.jetty.server.ssl.SslSelectChannelConnector">
      <Arg>
        <New class="org.eclipse.jetty.util.ssl.SslContextFactory">
          <Set name="keyStore"><SystemProperty name="jetty.home" default="." />/ssl/jetty.jks</Set>
          <Set name="keyStorePassword">jobscheduler</Set>
          <Set name="keyManagerPassword">jobscheduler</Set>
          <Set name="trustStore"><SystemProperty name="jetty.home" default="." />/ssl/jetty.jks</Set>
          <Set name="trustStorePassword">jobscheduler</Set>
        </New>
      </Arg>
      <Set name="port">8443</Set>
      <Set name="maxIdleTime">30000</Set>
    </New>
  </Arg>
 </Call>

The SSL connection expects the jetty keystore file jetty.jks in the subfolder ssl (under the JobScheduler data folder). With the configuration above you can connect JobScheduler via https at port 8443.

keystore

To generate a keystore file use keytool:

 keytool -genkey -alias jetty -keyalg RSA -keysize 1024 -dname "CN=[hostname], OU=JobScheduler, O=SOS GmbH, L=Berlin C=DE" -keystore jetty.jks -storepass jobscheduler -keypass jobscheduler -validity 1826

whereas hostname should be the JobScheduler host.
Use also your own values for OU, h1. _ and _L.

Configure web.xml

To run JobScheduler with jetty it is also necessary to create two configuration files for the Jetty web server (jetty.xml and web.xml). It has to place in the root of your live folder (not in the config folder).

You must configure the JOC servlet with the JobScheduler installation path. Note that you must use the file protocol.

For Example:

file:///c:/Program Files (x86)/sos-berlin.com/jobscheduler/[scheduler_id] on Windows

file:///c:/Program Files (x86)/sos-berlin.com/jobscheduler/[scheduler_id] on Linux

 <?xml version="1.0" encoding="UTF-8"?>
 <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
          xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd" 
          xmlns="http://java.sun.com/xml/ns/j2ee" 
          version="2.4">
    <display-name>JobScheduler test configuration (web.xml)</display-name>
    <servlet>
        <servlet-name>Default</servlet-name>
        <servlet-class>org.eclipse.jetty.servlet.DefaultServlet</servlet-class>
        <init-param>
            <param-name>dirAllowed</param-name>
            <param-value>false</param-value>
        </init-param>
    </servlet>
    <servlet-mapping>
        <servlet-name>Default</servlet-name>
        
        <url-pattern>/</url-pattern>
    </servlet-mapping>
    <servlet>
        <servlet-name>JOC</servlet-name>
        <servlet-class>org.eclipse.jetty.servlet.DefaultServlet</servlet-class>
        <init-param>
            <param-name>resourceBase</param-name>
            <param-value>file:///c:/Program Files (x86)/sos-berlin.com/jobscheduler/scheduler</param-value>
        </init-param>
    </servlet>
    <servlet-mapping>
        <servlet-name>JOC</servlet-name>
        <url-pattern>/operations_gui/*</url-pattern>
    </servlet-mapping>
 </web-app>

Space shortcuts

Page tree