For developers

To setup jSche development environment use GIT to get the sources from the jSche project on GitHub. Use maven 3 to operate with each module.

Generally you need to install (execute "mvn install" in the corresponding module's folder) following projects into your local repository:

• • jSche (core scheduler functionality)

  • jScheJavaAppEvent (Java Application event runner used for jScheSrv)

  • jScheProcExecEvent (Command Line event runner used for jScheSrv)

  • jScheTestEvent (test event used for jScheSimpleTest)

To build jScheSimpleTest and jScheSrv it's enough to execute "mvn package". This is the simple project to test the core functionality with minimum settings.

To build the binaries that are attached in the Files section you need to build the jScheSrv module.

Note that it is easy to use Eclipse with your projects. Use "mvn eclipse:eclipse" to setup corresponding ".project" and ".classpath" files to use the corresponding module as Eclipse project. There are several launchers defined to use with Eclipse e.g. "Build jScheSrv.launch" to execute jScheSrv build directly from Eclipse (if you have installed maven plugin), "jScheSrv service.launch" to execute sCheSrv in console directly from Eclipse (ensure you run makeEclipseWorkFolders.bat prior to that), "jScheSrv remote.launch" to attach to the launched service remotely (use "Xdebug" and other options running the application to have the possibility to attach remotely - there are templates for them in both jScheSrv.bat for console execution and update_config.bat for service execution).

If you wish to write your own plugins (events), install the jSche core module to your local repository, declare to use it as dependency in your "pom" file (if you use maven for your plugin or however else setup this dependency) and extend the JScheEvent implementing the necessary functionality. Note that JAXB is used to provide the settings to the event object from the configuration XML file. See jScheTestEvent, jScheJavaAppEvent, jScheProcExecEvent as examples. Pay attention on how configDir system property can be used (in the jScheTestEvent) if you need to access some particular files - you can keep them in this folder.

Plugins have no compile dependencies with jScheSrv so to add it to the service all you need is just to add necessary either classes or jars to the "lib" folder and extend the eventsClassesHolder.xml with your event class name extended from JScheEvent. Having done so you can use your event's name specifying the scheduled event in the *.jSche.xml configuration file.

Questions?

If you have any questions or problems or want to discuss anything else feel free to join or start a discussion on jSche project's forum.