ControlTier > elements
 

JavaServiceWrapper

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

Overview

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

This type manages the Tanuki Software Java Wrapper Service, and allows a dependent Service object to be automatically deployed.

A JavaServiceWrapperZip object should be added as a child dependency.

A Service object should also be added as a child dependency.

Appropriate Settings should be added to JavaServiceWrapper object to configure the appropriate Java based configuration to run the underlying Service.

An example of using JavaServiceWrapper for managing the JBossServer type is here: Windows service example.

See: Tanuki Software Ltd. - Java Service Wrapper.

Design

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

Constraints

Attributes

Exported Attributes

Name Property Description
installRoot deployment-install-root The deployment-install-root is exported as the "installRoot" attribute. It is used to default the -installroot option in many commands.

Defaults for Imported Attributes

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

Commands

View the available commands in the User Reference.

Related Types

The following types are defined for use with JavaServiceWrapper.

JavaServiceWrapperAppParameters

Overview

JavaServiceWrapperAppParameters: Application commandline parameters for the Java Service Wrapper, space separated.

The value should be a space separated list of parameters to pass to the main class defined with a JavaServiceWrapperJavaMainClass Setting object.

When the JavaServiceWrapperMainClass value is "org.tanukisoftware.wrapper.WrapperSimpleApp", then the value of this setting should be the Main class name of the target Java application, followed by the commandline parameters separated by spaces.

For example:

org.myapp.Main -param value

See: Java Service Wrapper - Integration Methods.

See: wrapper.java.mainclass Property.

Design

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

Constraints

Allowed Parent Dependencies

Attributes

Exported Attributes
Name Property
javaServiceWrapperAppParameters settingValue

JavaServiceWrapperConsoleTitle

Overview

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

If configured to run in a console window, this will be the title given to the window.

See: wrapper.console.title Property.

Design

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

Constraints

Allowed Parent Dependencies

Attributes

Exported Attributes
Name Property
javaServiceWrapperConsoleTitle settingValue

JavaServiceWrapperJavaAdditional

Overview

JavaServiceWrapperJavaAdditional: A list of additional JAVA_OPTS for the Java Service Wrapper, space separated

The values are split at the space characters and generated into the wrapper.conf file as separate numbered properties.

See: wrapper.java.additional<n> Property.

Design

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

Constraints

Allowed Parent Dependencies

Attributes

Exported Attributes
Name Property
javaServiceWrapperJavaAdditional settingValue

JavaServiceWrapperJavaClassPath

Overview

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

The comma-separated java class paths for this Setting will be added to a default set which includes the necessary jars for the Tanuki service wrapper software.

Design

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

Constraints

Allowed Parent Dependencies

Attributes

Exported Attributes
Name Property
javaServiceWrapperJavaClassPath settingValue

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

Attributes

Exported Attributes
Name Property
javaServiceWrapperJavaHome settingValue

JavaServiceWrapperJavaInitMemory

Overview

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

Used in the wrapper.conf configuration file.

See: wrapper.java.initmemory Property.

Design

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

Constraints

Allowed Parent Dependencies

Attributes

Exported Attributes
Name Property
javaServiceWrapperJavaInitMemory settingValue

JavaServiceWrapperJavaMainClass

Overview

JavaServiceWrapperJavaMainClass: Class implementing the Java Service Wrapper WrapperListener interface

The main class to set with this Setting is most often one provided by the Tanuki software, such as "org.tanukisoftware.wrapper.WrapperSimpleApp", unless target Java software to manage has its own implementation.

See: Java Service Wrapper - Integration Methods.

Design

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

Constraints

Allowed Parent Dependencies

Attributes

Exported Attributes
Name Property
javaServiceWrapperJavaMainClass settingValue

JavaServiceWrapperJavaMaxMemory

Overview

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

Used in the wrapper.conf configuration file.

See: wrapper.java.maxmemory Property.

Design

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

Constraints

Allowed Parent Dependencies

Attributes

Exported Attributes
Name Property
javaServiceWrapperJavaMaxMemory settingValue

JavaServiceWrapperNtServiceAccount

Overview

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

Note
The usage of this setting is not currently enabled in this implementation.

See: wrapper.ntservice.account Property.

Design

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

Constraints

Allowed Parent Dependencies

Attributes

Exported Attributes
Name Property
javaServiceWrapperNtServiceAccount settingValue

JavaServiceWrapperNtServiceDescription

Overview

JavaServiceWrapperNtServiceDescription: Description of the Java Service Wrapper Windows service

See: wrapper.ntservice.description Property.

Design

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

Constraints

Allowed Parent Dependencies

Attributes

Exported Attributes
Name Property
javaServiceWrapperNtServiceDescription settingValue

JavaServiceWrapperNtServiceDisplayName

Overview

JavaServiceWrapperNtServiceDisplayName: Displayed name of the Java Service Wrapper Windows service

See: wrapper.ntservice.displayname Property.

Design

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

Constraints

Allowed Parent Dependencies

Attributes

Exported Attributes
Name Property
javaServiceWrapperNtServiceDisplayName settingValue

JavaServiceWrapperNtServiceInteractive

Overview

JavaServiceWrapperNtServiceInteractive: Whether or not to allow the Java Service Wrapper Windows service to interact with the desktop. (true/false)

See: wrapper.ntservice.interactive Property.

Design

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

Constraints

Allowed Parent Dependencies
Allowed Property Values
Property Allowed Values Default Enforced
settingValue
  • false
  • true
  • true
true

Attributes

Exported Attributes
Name Property
javaServiceWrapperNtServiceInteractive settingValue

JavaServiceWrapperNtServiceName

Overview

JavaServiceWrapperNtServiceName: Identifying Name of the Java Service Wrapper Windows service

This is the identifier used by Windows, and should be unique among all Windows Service. Make sure that all JavaServiceWrapper objects have different values for this setting.

See: wrapper.ntservice.name Property.

Design

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

Constraints

Allowed Parent Dependencies

Attributes

Exported Attributes
Name Property Description
javaServiceWrapperNtServiceName settingValue This attribute is used by the lifecycle commands of JavaServiceWrapper to uniquely identify the Windows Service that is being managed.

JavaServiceWrapperNtServicePassword

Overview

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

Note
The usage of this setting is not currently enabled in this implementation.

See: wrapper.ntservice.password Property.

Design

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

Constraints

Allowed Parent Dependencies

Attributes

Exported Attributes
Name Property
javaServiceWrapperNtServicePassword settingValue

JavaServiceWrapperNtServiceStartType

Overview

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

See: wrapper.ntservice.starttype Property.

Design

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

Constraints

Allowed Parent Dependencies
Allowed Property Values
Property Allowed Values Default Enforced
settingValue
  • AUTO_START
  • DEMAND_START
  • AUTO_START
true

Attributes

Exported Attributes
Name Property
javaServiceWrapperNtServiceStartType settingValue

JavaServiceWrapperSetting

Overview

JavaServiceWrapperSetting: Java Service Wrapper configuration setting

This abstract Setting subtype is the supertype for all JavaServiceWrapper Setting types.

Design

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