Java program as windows service

Mar 29, 2018 · 2 min read

I had done a spring project for my organization and then I needed to run it as a window service. I found this method as the easiest one among other techniques that I referred in the internet.

To run java program as windows service the very first step that you need to do is package the module into JAR file. Once it is packaged as a JAR file we have to convert the JAR file into an exe file. Launch4j is one of the easiest way to do this task.

Install Launch4j in your machine. Then follw these steps:

1. In Basic tab choose the path where you want your exe file to be in “Output file” and the name of your exe file.
2. Browse your JAR file in “Jar”
3. Browse the icon image regarding how your exe file icon should look like

4 . Set the “Min JRE version” and click the fourth icon on menu bar(looks like settings icon).

5. Save your file name in the location that you wish. You will get log message as wrapping successfully created and your path.

From exe file to services you can use sc create command as below in your command line administrator:
sc create “My new service” bin path= “D:\FinalProduct\finalProduct.exe” start= auto

It will look like

Now you can run services.msc and see whether your service is created. Make sure you provide a name that does not exist before and leave a space after equal sign in sc create command.

Hope this article helps you in creating a windows service from Java program.

Создание Windows службы на Java

February 22, 2019 Jazz Team Технические статьи

Введение

В рамках одного из проектов требовалось разработать Windows службу, которая могла бы выполнять ряд действий с помощью Windows API, Websocket и стандартных средств Java. Далее в статье будут описаны шаги, которые были сделаны для создания такой службы.
Потребность в Windows службе возникла из-за необходимости иметь программу со следующими возможностями:

• она должна быть постоянно запущена,
• выполнялась от системного пользователя,
• автоматически запускалась при старте системы,
• чтобы её сложно было остановить обычному пользователю.

Создание минимизированной версии JRE

Так как GraalVM всё ещё не поддерживает создание исполняемых файлов под Windows, было решено воспользоваться другими возможностями, которые предоставляет экосистема Java, а именно создание минимизированной версии JRE.

Для того, чтобы создать минимизированную версию JRE, для начала необходимо узнать зависимости на определенные пакеты, которые будут включены в JRE.

В первую очередь необходимо собрать jar-файл “fat jar” со всеми зависимостями.

Затем выполнить команду jdeps -s , чтобы получить список всех зависимостей. Например:

Далее создаём нашу версию JRE с данными зависимостями:

jlink –module-path –add-modules

java.base,java.datatransfer,java.desktop,java.logging,java.net.http,java.sql,java.xml,jdk.unsupported –strip-debug –compress 2 –no-header-files –no-man-pages –output

Обратите внимание, что перечисление пакетов для опции –add-modules необходимо разделять запятой и не ставить между ними пробелов. Остальные опции отвечают за сжатие и убирание файлов и другой информации, которая не пригодится для выполнения программы.

После выполнения этих действий JRE будет занимать порядка 30 mb, вместо сотен.

Создание Windows службы из любого приложения

Java не имеет стандартных средств по созданию служб, поэтому были изучены сторонние инструменты и был выбран WinSW в силу его бесплатности и простоты использования.

WinSW

WinSW – это утилита, которая позволяет запустить и обернуть любой процесс как Windows службу. Для того, чтобы начать с ней работать, необходимо скачать исполняемый и конфигурационный файлы по этой ссылке https://github.com/kohsuke/winsw/releases.

Необходимо поместить эти два файла в директорию. Переименовать исполняемый файл на своё усмотрение и дать такое же название файлу конфигурации, затем поместить в эту директорию jar-файл приложения и созданную JRE.

В конфигурационном файле необходимо прописать минимальную конфигурацию:

jre\bin\java.exe – относительный путь внутри нашей папки к исполняемому файлу нашей JRE.

После этих действий можно установить службу, для этого необходимо выполнить команду от имени администратора:

Список команд можно посмотреть здесь .

Взаимодействие Java и Windows API

Для использования функций Windows (таких как создание нового процесса или добавление ключей реестра) в нашем приложении был использован JNA.
JNA (Java Native Access) предоставляет Java-программам легкий доступ к библиотекам, написанным на другом языке, без написания чего-либо, кроме кода Java. JNA позволяет напрямую вызывать нативные функции, используя обычный вызов метода Java. Большинство методов не требуют специальной обработки или конфигурации; не требуется шаблон или сгенерированный код.
Подключить и работать с JNA очень просто, для этого необходимо скачать jar-файл или подключить зависимость в сборщик проекта – в нашем случает Maven:

В нашем проекте мы использовали JNA для достижения следующих целей: заблокировать и сделать вновь доступным диспетчер задач 1) по комбинации Ctrl+Shift+Esc и 2) в меню, доступном по комбинации Ctrl+Alt+Del.

Для достижения этого были использованы класс Advapi32Util (удобная обёртка над библиотекой advapi32.dll) и интерфейс WinReg с полезными константами , которые предоставляют функциональность для внесения изменений в реестр Windows (Рисунок 1. Класс TaskManager с методами enable() и disable() для изменения ключей реестра диспетчера задач).

Рисунок 1. Класс TaskManager с методами enable() и disable() для изменения ключей реестра диспетчера задач.

• Создать новый процесс от имени определённого пользователя Windows. Для этого мы использовали метод CreateProcessAsUser()интерфейса Advapi32. В метод необходимо передать следующие параметры:
  • hToken – дескриптор токена пользователя, для которого мы запускаем процесс.
  • lpApplicationName – имя модуля, который должен быть выполнен.
  • lpCommandLine – командная строка для выполнения.
  • lpProcessAttributes – указатель на структуру SECURITY_ATTRIBUTES, которая определяет дескриптор безопасности для нового объекта процесса и определяет, могут ли дочерние процессы наследовать возвращенный дескриптор процесса.
  • lpThreadAttributes – указатель на структуру SECURITY_ATTRIBUTES, который определяет дескриптор безопасности для нового объекта потока и определяет, могут ли дочерние процессы наследовать возвращенный дескриптор потока.Создать новый процесс от имени определённого пользователя Windows. Для этого мы использовали метод CreateProcessAsUser() интерфейса Advapi32. В метод необходимо передать следующие параметры:
  • bInheritHandles – если этот параметр TRUE, каждый наследуемый дескриптор вызывающего процесса наследуется новым процессом. Если параметр FALSE, процессы не наследуются.
  • dwCreationFlags – флаги, которые контролируют класс приоритета и создают процесс.
  • lpEnvironment – указатель на блок среды для нового процесса. Если этот параметр равен NULL, новый процесс использует среду вызывающего процесса. Блок среды состоит из блока с нулевым завершением строк с нулевым завершением. Каждая строка имеет следующий вид: name = value \ 0.
  • lpCurrentDirectory – полный путь к текущему каталогу для процесса. Строка также может указывать путь UNC (universal naming convention).
  • lpStartupInfo – указатель на структуру STARTUPINFO или STARTUPINFOEX.lpProcessInformation – указатель на структуру PROCESS_INFORMATION, которая получает идентификационную информацию о новом процессе.

Рисунок 2. Метод для создания нового процесса для определённого пользователя Windows.

• Получить токен активного пользователя, т.к. он необходим для создания процесса от определённого пользователя.

Работа с процессами

Для работы и слежения за процессами в Windows был использован, добавленный в Java 9, класс ProcessHandle. ProcessHandle позволяет получать и производить различные манипуляции с процессами. В частности, при решении задачи, требовалось собирать PID процессов, фильтровать процессы на основе имени и принудительно завершать необходимые процессы.

Рисунок 3. Класс ProcessHandler с методами takeSnapshot() для создания снимка текущих процессов и closeNewProcesses() для завершения процессов, отличных от снимка.

Взаимодействие с другими компонентами системы

WebSocket

Для Java существует стандартизированный API для работы с WebSocket.

Но одного API недостаточно, поэтому для запуска кода была выбрана одна из его реализаций – Tyrus.

Далее можно создать минималистичный сервер и указать обработчики (EndPoints).

Заготовка обработчика выглядит следующим образом:

HTTP-клиент

С выпуском 11-ой версии Java в ней появился удобный HTTP-клиент, поэтому потребность в сторонних клиентах исчезла.

Для создания экземпляра клиента необходимо воспользоваться билдером. В простейшем случае:

Далее необходимо создать запрос(request), например:

Затем этот запрос можно использовать для отправки на сервер:

Заключение

Благодаря модульной организации версий Java 9 и выше, утилите WinSW, обновлённому Process API для взаимодействия с процессами операционной системы и библиотеки JNA (Java Native Access), которая предоставляет программам Java простой доступ к нативным библиотекам, мы смогли создать Windows службу с использованием языка Java, на котором была реализована и серверная часть. Что в итоге позволило не вводить в процесс разработки новый язык.

Java Programs as Windows Services

Here’s a step-by-step example of how to run a Java program as a Windows service.

Join the DZone community and get the full member experience.

I recently needed to run a Java program as a Windows service and opted for Commons-daemon procrun. This wrapper is used by both Tomcat and JBoss Wildfly to wrap their servers — but it took a bit of figuring out how to get my application running.

This post sets out an example of using procrun to wrap a Java process.

Download

I downloaded procrun from here. The download contains three different version of the procrun.exe:

• 32 bit: This is the default architecture.
• amd64: 64-bit AMD architecture.
• ia64: 64-bit Intel Itanium architecture.

You need to use the right version for your JVM and chipset

The code is based on the EchoServer and EchoClient examples from Oracle.

EchoServer

EchoClient

The client is changed to take a shutdown parameter:

Prunssrv

I’ve also created a simple class to stop and start the server:

Putting it all together:

1. Add the above classes and procrun.exe to a directory – C:\procrun
2. Compile – javac *.java
3. Create Archive – jar cvf simpleechoserver.jar *.class *.jar

Service.bat

You don’t need to create a service.bat file, but it’s cleaner and simpler. Store this in your code directory.

Key Points

• All the Procrun fields are marked with PR_ — you can also feed these fields directly to procrun.exe using the ++ or — notation in the procrun notes, but I think this way is cleaner and easier to maintain.
• The key ones are the start/stop fields.
• PR_JVMOPTIONS: Allows us to pass system properties to the Windows Service
• Installing and removing:
  %PR_INSTALL% //IS//%SERVICE_NAME%
  %PR_INSTALL% //DS//%SERVICE_NAME%
• There are other “//” options defined in the notes

Running service.bat

You may need to run this as administrator:

You can then test:

If you go to your Windows Services, you will now see SimpleEchoServer with stop/start/restart options

Prunmgr.exe

The final trick is to use prunmgr. This the procrun manager and allows you to see the procrun operating parameters. To get started, go to your copy of prunmgr.exe and rename or copy it to the SERVICE_NAME in your batch file:

You then run the SimpleEchoServer.exe as administrator.

Published at DZone with permission of Martin Farrell , DZone MVB . See the original article here.

Opinions expressed by DZone contributors are their own.

Install java program as a windows service: Alternative to JavaService? [closed]

Want to improve this question? Update the question so it’s on-topic for Stack Overflow.

Closed 7 years ago .

I’d like to install a Java application as a Windows service. I did so successfully a couple of years ago using this Java Service wrapper. Unfortunately, it seems like this tool is not in development anymore and thus no Windows 7 and 64 bit versions are available. I need to install my Java application on Windows 7 and XP machines.

Does anyone know a good alternative?

Edit: I need this for commercial use; the suggested Java Service Wrapper from Tanuki is too expensive.

5 Answers 5

Some time ago I used the tanuki project and we were very happy with it. I believe is one of the most popular ones.

There is also YAJSW that is based on tanuki (as I understand ) with a LGPL licence

I’m now using WinRun4J — a really nice, lean tool that is easy to configure and handle and usable in commercial applications. Many thanks to assylias, whose comment pointed my in the right direction.

I have used Tanuki’s Java Service Wrapper with great success; it’s easy to use.

There are community packages (free) and professional packages (license).

I have recently used Java Service Wrapper from Tanukisoftware and it works perfectly on windows 7. Also the tool is pretty handy as it provides pretty extensive integration mechanism from simple jar execution to shutdown hook functionality as well.

For normal use, you can use their Community License which falls under GPL v2.0, however keep in mind if your intended use is on server, you might have to double check licensing options.

Also windows resource kit includes a tool called servany.exe which i successfully used on Windows Xp to start a jar file as a service by lanuching java.exe with arguments to my jar file, however since windows 7 this somehow does not work.

You might want to do a little research since i have read some forums about people still affirming that it works.