JavaServiceWrapper

JavaServiceWrapper: Windows platform integration of Tanuki Software's Java Wrapper Service facility

Super Type

Service

Role	Concrete. (Objects can be created.)
Instance Names	Unique
Notification	false
Template Directory
Data View	Children, proximity: 1
Logger Name

Allowed Child Dependencies

• JavaServiceWrapperAppParameters ¹
• JavaServiceWrapperConsoleTitle ¹
• JavaServiceWrapperJavaAdditional ¹
• JavaServiceWrapperJavaClassPath ¹
• JavaServiceWrapperJavaHome ¹
• JavaServiceWrapperJavaInitMemory ¹
• JavaServiceWrapperJavaMainClass ¹
• JavaServiceWrapperJavaMaxMemory ¹
• JavaServiceWrapperNtServiceDescription ¹
• JavaServiceWrapperNtServiceDisplayName ¹
• JavaServiceWrapperNtServiceInteractive ¹
• JavaServiceWrapperNtServiceName ¹
• JavaServiceWrapperNtServiceStartType ¹
• JavaServiceWrapperZip ¹

¹: These types have a Singleton constraint. Only one instance may be added as a resource.

Allowed Parent Dependencies

• Node
• Site

Exported Attributes

Name	Property
installRoot	deployment-install-root

Defaults for Imported Attributes

Name	Default
javaServiceWrapperAppParameters
javaServiceWrapperConsoleTitle	Test Wrapper Sample Application
javaServiceWrapperJavaAdditional
javaServiceWrapperJavaClassPath
javaServiceWrapperJavaHome	${env.JAVA_HOME}
javaServiceWrapperJavaInitMemory	3
javaServiceWrapperJavaMainClass	org.tanukisoftware.wrapper.test.Main
javaServiceWrapperJavaMaxMemory	64
javaServiceWrapperNtServiceDescription	Test Wrapper Sample Application Description
javaServiceWrapperNtServiceDisplayName	Test Wrapper Sample Application
javaServiceWrapperNtServiceInteractive	false
javaServiceWrapperNtServiceName	testwrapper
javaServiceWrapperNtServiceStartType	AUTO_START

Deploy

Run the service deployment cycle, stopping, unconfiguring, installing package dependencies, configuring and the starting the service. .

Usage

Deploy

Workflow

1. Stop
2. Remove
3. Packages-Install
4. Configure
5. Add
6. Start

Add

Add the Java Service Wrapper Windows service if it is not already installed.

Usage

Add

Workflow

1. assertServiceIsInstalled

Error Handler

Command

addService

Remove

Remove the Java Service Wrapper Windows service if it is installed.

Usage

Remove

Workflow

1. assertServiceIsNotInstalled

Error Handler

Command

removeService

Docs-Generate

Generate the server properties file

Usage

Docs-Generate [-installroot <>] [-packagebase <>]

Options

Option	Description
installroot	Java wrapper service wrapper home directory
packagebase	Java wrapper service wrapper package installation directory

addService

Add the Java Service Wrapper Windows service to the system

Usage

addService [-installroot <>] [-packagebase <>]

Options

Option	Description
installroot	Java wrapper service wrapper home directory
packagebase	Java wrapper service wrapper package installation directory

removeService

Remove the Java Service Wrapper Windows service from the system

Usage

removeService [-installroot <>] [-packagebase <>]

Options

Option	Description
installroot	Java wrapper service wrapper home directory
packagebase	Java wrapper service wrapper package installation directory

assertServiceIsUp

Check whether the Java Service Wrapper Windows service is up

Usage

assertServiceIsUp [-installroot <>] [-packagebase <>] [-servicename <>]

Options

Option	Description
installroot	Java wrapper service wrapper home directory
packagebase	Java wrapper service wrapper package installation directory
servicename	Java wrapper service wrapper Windows service name

assertServiceIsDown

Check whether the Java Service Wrapper Windows service is down

Usage

assertServiceIsDown [-installroot <>] [-packagebase <>] [-servicename <>]

Options

Option	Description
installroot	Java wrapper service wrapper home directory
packagebase	Java wrapper service wrapper package installation directory
servicename	Java wrapper service wrapper Windows service name

assertServiceIsInstalled

Check whether the Java Service Wrapper Windows service is installed

Usage

assertServiceIsInstalled [-installroot <>] [-packagebase <>] [-servicename <>]

Options

Option	Description
installroot	Java wrapper service wrapper home directory
packagebase	Java wrapper service wrapper package installation directory
servicename	Java wrapper service wrapper Windows service name

assertServiceIsNotInstalled

Check whether the Java Service Wrapper Windows service is not installed

Usage

assertServiceIsNotInstalled [-installroot <>] [-packagebase <>] [-servicename <>]

Options

Option	Description
installroot	Java wrapper service wrapper home directory
packagebase	Java wrapper service wrapper package installation directory
servicename	Java wrapper service wrapper Windows service name

startService

Start the Java Service Wrapper Windows service

Usage

startService [-installroot <>] [-packagebase <>] [-servicename <>]

Options

Option	Description
installroot	Java wrapper service wrapper home directory
packagebase	Java wrapper service wrapper package installation directory
servicename	Java wrapper service wrapper Windows service name

stopService

Stop the Java Service Wrapper Windows service

Usage

stopService [-installroot <>] [-packagebase <>] [-servicename <>]

Options

Option	Description
installroot	Java wrapper service wrapper home directory
packagebase	Java wrapper service wrapper package installation directory
servicename	Java wrapper service wrapper Windows service name

The following types are defined for use with JavaServiceWrapper.

JavaServiceWrapperSetting

Overview

JavaServiceWrapperSetting: Java Service Wrapper configuration setting

Design

Super Type

Setting

Role	Abstract. (Objects cannot be created.)
Instance Names	Unique

JavaServiceWrapperJavaHome

Overview

JavaServiceWrapperJavaHome: Value of JAVA_HOME for the Java Service Wrapper

Design

Super Type

JavaServiceWrapperSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• JavaServiceWrapper

Attributes

Exported Attributes

Name	Property
javaServiceWrapperJavaHome	settingValue

JavaServiceWrapperJavaMainClass

Overview

JavaServiceWrapperJavaMainClass: Class implementing the Java Service Wrapper WrapperListener interface

Design

Super Type

JavaServiceWrapperSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• JavaServiceWrapper

Attributes

Exported Attributes

Name	Property
javaServiceWrapperJavaMainClass	settingValue

JavaServiceWrapperJavaClassPath

Overview

JavaServiceWrapperJavaClassPath: A comma separated list of additional CLASSPATH elements for the Java Service Wrapper

Design

Super Type

JavaServiceWrapperSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• JavaServiceWrapper

Attributes

Exported Attributes

Name	Property
javaServiceWrapperJavaClassPath	settingValue

JavaServiceWrapperJavaAdditional

Overview

JavaServiceWrapperJavaAdditional: Additional parameters for the Java Service Wrapper

Design

Super Type

JavaServiceWrapperSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• JavaServiceWrapper

Attributes

Exported Attributes

Name	Property
javaServiceWrapperJavaAdditional	settingValue

JavaServiceWrapperJavaInitMemory

Overview

JavaServiceWrapperJavaInitMemory: Initial Java heap size in MB for the Java Service Wrapper

Design

Super Type

JavaServiceWrapperSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• JavaServiceWrapper

Attributes

Exported Attributes

Name	Property
javaServiceWrapperJavaInitMemory	settingValue

JavaServiceWrapperJavaMaxMemory

Overview

JavaServiceWrapperJavaMaxMemory: Maximum Java heap size in MB for the Java Service Wrapper

Design

Super Type

JavaServiceWrapperSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• JavaServiceWrapper

Attributes

Exported Attributes

Name	Property
javaServiceWrapperJavaMaxMemory	settingValue

JavaServiceWrapperAppParameters

Overview

JavaServiceWrapperAppParameters: Application parameters for the Java Service Wrapper

Design

Super Type

JavaServiceWrapperSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• JavaServiceWrapper

Attributes

Exported Attributes

Name	Property
javaServiceWrapperAppParameters	settingValue

JavaServiceWrapperConsoleTitle

Overview

JavaServiceWrapperConsoleTitle: Title to use when running the Java Service Wrapper as a console

Design

Super Type

JavaServiceWrapperSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• JavaServiceWrapper

Attributes

Exported Attributes

Name	Property
javaServiceWrapperConsoleTitle	settingValue

JavaServiceWrapperNtServiceName

Overview

JavaServiceWrapperNtServiceName: Name of the Java Service Wrapper Windows service

Design

Super Type

JavaServiceWrapperSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• JavaServiceWrapper

Attributes

Exported Attributes

Name	Property
javaServiceWrapperNtServiceName	settingValue

JavaServiceWrapperNtServiceDisplayName

Overview

JavaServiceWrapperNtServiceDisplayName: Displayed name of the Java Service Wrapper Windows service

Design

Super Type

JavaServiceWrapperSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• JavaServiceWrapper

Attributes

Exported Attributes

Name	Property
javaServiceWrapperNtServiceDisplayName	settingValue

JavaServiceWrapperNtServiceDescription

Overview

JavaServiceWrapperNtServiceDescription: Description of the Java Service Wrapper Windows service

Design

Super Type

JavaServiceWrapperSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• JavaServiceWrapper

Attributes

Exported Attributes

Name	Property
javaServiceWrapperNtServiceDescription	settingValue

JavaServiceWrapperNtServiceStartType

Overview

JavaServiceWrapperNtServiceStartType: Mode in which the Java Service Wrapper Windows service is installed. AUTO_START or DEMAND_START.

Design

Super Type

JavaServiceWrapperSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• JavaServiceWrapper

Attributes

Exported Attributes

Name	Property
javaServiceWrapperNtServiceStartType	settingValue

JavaServiceWrapperNtServiceInteractive

Overview

JavaServiceWrapperNtServiceInteractive: Whether or not to allow the Java Service Wrapper Windows service to interact with the desktop.

Design

Super Type

JavaServiceWrapperSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• JavaServiceWrapper

Attributes

Exported Attributes

Name	Property
javaServiceWrapperNtServiceInteractive	settingValue

JavaServiceWrapperNtServiceAccount

Overview

JavaServiceWrapperNtServiceAccount: Account to use with the Java Service Wrapper Windows service.

Design

Super Type

JavaServiceWrapperSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• JavaServiceWrapper

Attributes

Exported Attributes

Name	Property
javaServiceWrapperNtServiceAccount	settingValue

JavaServiceWrapperNtServicePassword

Overview

JavaServiceWrapperNtServicePassword: Password to use with the Java Service Wrapper Windows service.

Design

Super Type

JavaServiceWrapperSetting

Role	Concrete. (Objects can be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

• JavaServiceWrapper

Attributes

Exported Attributes

Name	Property
javaServiceWrapperNtServicePassword	settingValue