• Configuration Property Overview
• Property List by Category
• Property List by Name

Standard and Professional Editions of the Java Service Wrapper are activated by a set of license keys obtained by purchasing a license agreement from Tanuki Software.

Users have the ability to purchase either Server or Development license agreements.

Server license agreements allow the user to generate a single license key which will authorize the use of multiple copies of the Wrapper on a single server. Server license keys are tied to the server using a hostid.

Development license agreements allow the user to generate multiple license keys which each authorize the Wrapper to be run with a single application on multiple servers. Development license keys are tied to the specific application.

For either type of license agreement, once a license agreement has been purchased, license keys can be generated using the License Management page.

Each type of license key is described below in detail.

• Server License Key Overview
• Development License Key Overview
• License In Cascading Configuration File

Server license keys consist of a set of properties which are placed directly into the wrapper.conf configuration file or included using a cascading configuration file. The license key is tied to a specific server using the host id specified in the license key.

The host id of a given server can be obtained by running the wrapper binary with the '-h' parameter from within a shell or command prompt. This will result in the following output.

Java Service Wrapper Professional Edition n.n.n
  Copyright (C) 1999-2008 Tanuki Software, Inc.  All Rights Reserved.
    http://wrapper.tanukisoftware.org

A license can be obtained from the Java Service Wrapper site:
  http://wrapper.tanukisoftware.org/doc/english/purchase.html

Licenses can be generated for any of the following Host Ids.
The first Host Id is recommended.
  Host Ids:
    00123456789a (#1)

Optional host name for license: myhost

Java Service Wrapper Professional Edition n.n.n
  Copyright (C) 1999-2008 Tanuki Software, Inc.  All Rights Reserved.
    http://wrapper.tanukisoftware.org

A license can be obtained from the Java Service Wrapper site:
  http://wrapper.tanukisoftware.org/doc/english/purchase.html

Licenses can be generated for any of the following Host Ids.
The first Host Id is recommended.
  Host Ids:
    00123456789a (eth0:avahi)
    00123456789b (eth1)

Any of the host ids shown can be used to generate the license key.

wrapper.license.type=NODE
wrapper.license.id=200804010006
wrapper.license.licensee=Acme, Inc.
wrapper.license.host_id=00123456789a
wrapper.license.features=pro, 64bit
wrapper.license.upgrade_term.begin_date=2008-04-01
wrapper.license.upgrade_term.end_date=2009-04-01
wrapper.license.key.1=0222-2e8a-6f6d-4a4a
wrapper.license.key.2=007d-7e3c-5e2a-427e
wrapper.license.key.3=ce16-f5f0-59f4-d18a
wrapper.license.key.4=b6ca-c31a-6be8-323d

• The type will always be 'NODE' for Server License keys.

• The id is used to uniquely identify the license key and will appear on your License Management page.

• The licensee value will be displayed in the console and wrapper log file whenever the Wrapper is launched. In the case of the license key above, the Wrapper output will appear as follows:

  Java Service Wrapper Professional Edition n.n.n Copyright (C) 1999-2008 Tanuki Software, Inc. All Rights Reserved. http://wrapper.tanukisoftware.org Licensed to Acme, Inc.

• The host id identifies the single server on which the Wrapper will be authorized to run.

• The features are used to describe the specific edition of the Wrapper which is authorized. In this case the 64-bit, Professional Edition is authorized. This will also authorize 32-bit and Standard Edition versions of the Wrapper to run.

• The upgrade term specifies the Wrapper release dates which will be authorized by the license key. The license above will authorize versions of the Wrapper released prior to 2009-04-01. Versions released within the specified upgrade term will be authorized to run beyond the end of the upgrade term.

• An optional lease term may also appear in some trial license keys. These specify the dates between which the Wrapper will be authorized to run. Once the lease term has expired, the Wrapper will no longer start up.

• The 4 keys are used to validate the rest of the license properties.

NOTE

The license key property values are specific and the license will fail to authorize the Wrapper if any of its values are modified in any way.

It is also possible to include the license keys for multiple servers in a single file by including the host names in the license key property names. The following example shows a license key given the host name 'myhost'. It is possible to change the host name portion of the license key properties without regenerating the key.

wrapper.myhost.license.type=NODE
wrapper.myhost.license.id=200804010006
wrapper.myhost.license.licensee=Acme, Inc.
wrapper.myhost.license.host_id=00123456789a
wrapper.myhost.license.features=pro, 64bit
wrapper.myhost.license.upgrade_term.begin_date=2008-04-01
wrapper.myhost.license.upgrade_term.end_date=2009-04-01
wrapper.myhost.license.key.1=0222-2e8a-6f6d-4a4a
wrapper.myhost.license.key.2=007d-7e3c-5e2a-427e
wrapper.myhost.license.key.3=ce16-f5f0-59f4-d18a
wrapper.myhost.license.key.4=b6ca-c31a-6be8-323d

Development license keys consist of a set of properties which are placed directly into the wrapper.conf configuration file or included using a cascading configuration file. The license key is tied to a specific application using the values of the application's main class.

The application's main class is specified using the wrapper.java.mainclass property. If the main class is one of the helper classes included with the Wrapper (org.tanukisoftware.wrapper.WrapperSimpleApp or org.tanukisoftware.wrapper.WrapperStartStopApp) then the main class will be specified using the wrapper.app.parameter.1 property. In either case the license will only authorize the Wrapper if the main class remains unchanged.

wrapper.license.type=DEV
wrapper.license.id=200804010003
wrapper.license.licensee=Acme, Inc.
wrapper.license.dev_application=Acme Control Server
wrapper.license.features=pro, 64bit
wrapper.license.upgrade_term.begin_date=2008-04-01
wrapper.license.upgrade_term.end_date=2009-04-01
wrapper.license.key.1=a0a5-b478-ca71-8d59
wrapper.license.key.2=9296-6f2d-0e58-75e6
wrapper.license.key.3=0f5d-2cf2-ad36-54f9
wrapper.license.key.4=b859-dc75-61d7-b0ca

• The type will always be 'DEV' for Development License keys.

• The id is used to uniquely identify the license key and will appear on your License Management page.

• The licensee and dev_application values will be displayed in the console and wrapper log file whenever the Wrapper is launched. In the case of the license key above, the Wrapper output will appear as follows:

  Java Service Wrapper Professional Edition n.n.n Copyright (C) 1999-2008 Tanuki Software, Inc. All Rights Reserved. http://wrapper.tanukisoftware.org Licensed to Acme, Inc. for Acme Control Server

• The features are used to describe the specific edition of the Wrapper which is authorized. In this case the 64-bit, Professional Edition is authorized. This will also authorize 32-bit and Standard Edition versions of the Wrapper to run.

• The upgrade term specifies the Wrapper release dates which will be authorized by the license key. The license above will authorize versions of the Wrapper released prior to 2009-04-01. Versions released within the specified upgrade term will be authorized to run beyond the end of the upgrade term.

• An optional lease term may also appear in some trial license keys. These specify the dates between which the Wrapper will be authorized to run. Once the lease term has expired, the Wrapper will no longer start up.

• The 4 keys are used to validate the rest of the license properties.

NOTE

The license key property values are specific and the license will fail to authorize the Wrapper if any of its values are modified in any way.

It is ofter desirable to place the Wrapper license key properties in a file other than the wrapper.conf. This can be done easily by making use of the Wrapper's Cascading Configuration Files functionality.

It is suggested that the license key properties be placed in a file called wrapper-license.conf, located in the same directory as the wrapper.conf file. The license file is then included by placing a line like the following at the top of your wrapper.conf file:

#include ../conf/wrapper-license.conf

Note that the include file path is relative to the location of the Wrapper binary and NOT the wrapper.conf file. See the page on Cascading Configuration Files for further details and advice on how to debug problems with include files.

If you notice something that is incorrect, missing, or simply feel that some part of this page could be explained better, feel free to log in and add a comment. You will need to register before you can log on.