Class WinServices
- java.lang.Object
-
- com.install4j.api.windows.service.WinServices
-
public class WinServices extends java.lang.Object
Collection of static methods to manipulate Windows services
-
-
Constructor Summary
Constructors Constructor Description WinServices()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static void
change(java.lang.String serviceName, ServiceConfiguration configuration)
Changes a service configuration.static java.lang.String
getBinary(java.lang.String serviceName)
Returns the registered binary of a service.static ServiceStartType
getStartType(java.lang.String serviceName)
Returns the start type of a service.static void
install(java.lang.String serviceName, ServiceConfiguration configuration)
Installs a service.static boolean
isRunning(java.lang.String serviceName)
Checks if a service is currently running.static void
start(java.lang.String serviceName, java.lang.String... parameters)
Starts a service.static void
stop(java.lang.String serviceName)
Stops a service.static void
uninstall(java.lang.String serviceName)
Uninstalls a service.
-
-
-
Method Detail
-
start
public static void start(java.lang.String serviceName, java.lang.String... parameters) throws ServiceException
Starts a service. To successfully call this methods you have to request privileges first.- Parameters:
serviceName
- the name of the serviceparameters
- optional parameters- Throws:
ServiceException
- aServiceNotFoundException
in case serviceName does not refer to the existing service, anServiceAccessException
if you don't have sufficient privileges or a generic exception with a Win32 error code
-
stop
public static void stop(java.lang.String serviceName) throws ServiceException
Stops a service. To successfully call this methods you have to request privileges first.- Parameters:
serviceName
- the name of the service- Throws:
ServiceException
- aServiceNotFoundException
in case serviceName does not refer to the existing service, anServiceAccessException
if you don't have sufficient privileges or a generic exception with a Win32 error code
-
install
public static void install(java.lang.String serviceName, ServiceConfiguration configuration) throws ServiceException
Installs a service. To successfully call this methods you have to request privileges first.- Parameters:
serviceName
- the name of the serviceconfiguration
- the configuration of the service. At least the binaryName property must be set.- Throws:
ServiceException
- anServiceAccessException
if you don't have sufficient privileges or a generic exception with a Win32 error code
-
change
public static void change(java.lang.String serviceName, ServiceConfiguration configuration) throws ServiceException
Changes a service configuration. To successfully call this methods you have to request privileges first.- Parameters:
serviceName
- the name of the serviceconfiguration
- the configuration of the service. All properties that are not set or set to null won't be changed.- Throws:
ServiceException
- aServiceNotFoundException
in case serviceName does not refer to the existing service, anServiceAccessException
if you don't have sufficient privileges or a generic exception with a Win32 error code
-
uninstall
public static void uninstall(java.lang.String serviceName) throws ServiceException
Uninstalls a service. To successfully call this methods you have to request privileges first.- Parameters:
serviceName
- the name of the service- Throws:
ServiceException
- aServiceNotFoundException
in case serviceName does not refer to the existing service, anServiceAccessException
if you don't have sufficient privileges or a generic exception with a Win32 error code
-
isRunning
public static boolean isRunning(java.lang.String serviceName) throws ServiceException
Checks if a service is currently running.- Parameters:
serviceName
- the name of the service- Returns:
- true if running
- Throws:
ServiceException
- aServiceNotFoundException
in case serviceName does not refer to the existing service, anServiceAccessException
if you don't have sufficient privileges or a generic exception with a Win32 error code
-
getStartType
public static ServiceStartType getStartType(java.lang.String serviceName) throws ServiceException
Returns the start type of a service.- Parameters:
serviceName
- the name of the service- Returns:
- a
ServiceStartType
value - Throws:
ServiceException
- aServiceNotFoundException
in case serviceName does not refer to the existing service, anServiceAccessException
if you don't have sufficient privileges or a generic exception with a Win32 error code
-
getBinary
public static java.lang.String getBinary(java.lang.String serviceName) throws ServiceException
Returns the registered binary of a service.- Parameters:
serviceName
- the name of the service- Returns:
- the binary name. Can include quotes and arguments if the service was registered like this..
- Throws:
ServiceException
- aServiceNotFoundException
in case serviceName does not refer to the existing service, anServiceAccessException
if you don't have sufficient privileges or a generic exception with a Win32 error code
-
-