com.inet.gradle.setup.abstracts

Class Service

java.lang.Object

com.inet.gradle.setup.abstracts.Application

com.inet.gradle.setup.abstracts.Service

public class Service
extends Application

Definition of a service to be installed on the target system.

Field Summary

Fields inherited from class com.inet.gradle.setup.abstracts.Application

setup

Constructor Summary

Constructors

Constructor and Description
Service(SetupBuilder setup) Create a new Service

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() Returns the serviceID which should be a short version of the application name
java.lang.String	getJavaHome() Returns the JAVA_HOME used by the service.
java.lang.String	getJvm() Returns the configured jvm.
java.lang.String	getLibraryPath() Returns the directory added to the search path used to locate the DLLs for the JVM.
java.lang.String	getLogLevel() Returns the daemon log level.
java.lang.String	getLogPath() Returns the path to write the daemon logs to.
java.lang.String	getLogPrefix() Returns the daemon log file name prefix.
java.lang.String	getPidFile() Returns the file name for storing the running process id.
java.lang.String	getStdError() Returns the redirected stderr filename.
java.lang.String	getStdOutput() Returns the redirected stdout filename.
java.lang.String	getWrapper() Name of the daemon wrapper, or the program that should be run as daemon
boolean	isKeepAlive() Return true the job should always be running
boolean	isStartOnBoot() Returns a boolean flag indicating whether the service is started when the system is booted.
void	setId(java.lang.String serviceID) Set the serviceID which should be a short version of the application name It must not contain spaces.
void	setJavaHome(java.lang.String javaHome) Sets a different JAVA_HOME than defined by JAVA_HOME environment variable.
void	setJvm(java.lang.String jvm) Set either auto (i.e.
void	setKeepAlive(boolean keepAlive) Set if the job should always be running, even if it crashes
void	setLibraryPath(java.lang.String libraryPath) Sets the directory added to the search path used to locate the DLLs for the JVM.
void	setLogLevel(java.lang.String logLevel) Sets the daemon log level.
void	setLogPath(java.lang.String logPath) Sets the path to write the daemon logs to.
void	setLogPrefix(java.lang.String logPrefix) Sets the daemon log file name prefix.
void	setPidFile(java.lang.String pidFile) Sets the file name for storing the running process id.
void	setStartOnBoot(boolean startOnBoot) Sets a boolean flag indicating whether the service is started when the system is booted.
void	setStdError(java.lang.String stdError) Sets the redirected stderr filename.
void	setStdOutput(java.lang.String stdOutput) Sets the redirected stdout filename.
void	setWrapper(java.lang.String wrapper) Name of the daemon wrapper, or the program that should be run as daemon

Methods inherited from class com.inet.gradle.setup.abstracts.Application

getDescription, getDisplayName, getExecutable, getIconForType, getIcons, getJavaVMArguments, getMainClass, getMainJar, getStartArguments, getWorkDir, setDescription, setDisplayName, setExecutable, setIcons, setJavaVMArguments, setMainClass, setMainJar, setStartArguments, setWorkDir

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Service

public Service(SetupBuilder setup)

Create a new Service

Parameters:

setup - current SetupBuilder

Method Detail

isStartOnBoot

public boolean isStartOnBoot()

Returns a boolean flag indicating whether the service is started when the system is booted.

Returns:

boolean flag indicating whether the service is started when the system is booted

setStartOnBoot

public void setStartOnBoot(boolean startOnBoot)

Sets a boolean flag indicating whether the service is started when the system is booted.

Parameters:

startOnBoot - boolean flag indicating whether the service is started when the system is booted

getId

public java.lang.String getId()

Returns the serviceID which should be a short version of the application name

Returns:

the serviceID

setId

public void setId(java.lang.String serviceID)

Set the serviceID which should be a short version of the application name It must not contain spaces.

Parameters:

serviceID - the id

getWrapper

public java.lang.String getWrapper()

Name of the daemon wrapper, or the program that should be run as daemon

Returns:

daemon wrapper

setWrapper

public void setWrapper(java.lang.String wrapper)

Name of the daemon wrapper, or the program that should be run as daemon

Parameters:

wrapper - daemon name

isKeepAlive

public boolean isKeepAlive()

Return true the job should always be running

Returns:

true the job should always be running

setKeepAlive

public void setKeepAlive(boolean keepAlive)

Set if the job should always be running, even if it crashes

Parameters:

keepAlive - if the job should always be running, even if it crashes

getLogPath

public java.lang.String getLogPath()

Returns the path to write the daemon logs to.

Returns:

the path to write the daemon logs to.

setLogPath

public void setLogPath(java.lang.String logPath)

Sets the path to write the daemon logs to.

Parameters:

logPath - the path to write daemon logs to

getLogPrefix

public java.lang.String getLogPrefix()

Returns the daemon log file name prefix.

Returns:

the daemon log file name prefix.

setLogPrefix

public void setLogPrefix(java.lang.String logPrefix)

Sets the daemon log file name prefix.

Parameters:

logPrefix - the daemon log file name prefix.

getLogLevel

public java.lang.String getLogLevel()

Returns the daemon log level.

Returns:

the daemon log level.

setLogLevel

public void setLogLevel(java.lang.String logLevel)

Sets the daemon log level.

Parameters:

logLevel - the daemon log level.

getPidFile

public java.lang.String getPidFile()

Returns the file name for storing the running process id. Actual file is created in the LogPath directory.

Returns:

the file name for storing the running process id. Actual file is created in the LogPath directory.

setPidFile

public void setPidFile(java.lang.String pidFile)

Sets the file name for storing the running process id. Actual file is created in the LogPath directory.

Parameters:

pidFile - the file name for storing the running process id. Actual file is created in the LogPath directory.

getStdError

public java.lang.String getStdError()

Returns the redirected stderr filename. If named auto file is created in the LogPath directory with the name service-stderr.YEAR-MONTH-DAY.log.

Returns:

the redirected stderr filename.

setStdError

public void setStdError(java.lang.String stdError)

Sets the redirected stderr filename. If named auto file is created in the LogPath directory with the name service-stderr.YEAR-MONTH-DAY.log.

Parameters:

stdError - the redirected stderr filename.

getStdOutput

public java.lang.String getStdOutput()

Returns the redirected stdout filename. If named auto file is created inside LogPath with the name service-stdout.YEAR-MONTH-DAY.log.

Returns:

the redirected stdout filename.

setStdOutput

public void setStdOutput(java.lang.String stdOutput)

Sets the redirected stdout filename. If named auto file is created inside LogPath with the name service-stdout.YEAR-MONTH-DAY.log.

Parameters:

stdOutput - the redirected stdout filename.

getLibraryPath

public java.lang.String getLibraryPath()

Returns the directory added to the search path used to locate the DLLs for the JVM. This directory is added both in front of the PATH environment variable and as a parameter to the SetDLLDirectory function.

Returns:

the directory added to the search path used to locate the DLLs for the JVM

setLibraryPath

public void setLibraryPath(java.lang.String libraryPath)

Sets the directory added to the search path used to locate the DLLs for the JVM. This directory is added both in front of the PATH environment variable and as a parameter to the SetDLLDirectory function.

Parameters:

libraryPath - the directory added to the search path used to locate the DLLs for the JVM

getJavaHome

public java.lang.String getJavaHome()

Returns the JAVA_HOME used by the service.

Returns:

the JAVA_HOME used by the service.

setJavaHome

public void setJavaHome(java.lang.String javaHome)

Sets a different JAVA_HOME than defined by JAVA_HOME environment variable.

Parameters:

javaHome - the JAVA_HOME used by the service.

getJvm

public java.lang.String getJvm()

Returns the configured jvm.

Returns:

the configured jvm.

See Also:

setJvm(String)

setJvm

public void setJvm(java.lang.String jvm)

Set either auto (i.e. find the JVM from the Windows registry) or the full path to the jvm.dll. Environment variable expansion can be used.

Parameters:

jvm - the jvm to configure.