Aperçu des propriétés des clés de licence

Les éditions Standard et Professional du Java Service Wrapper sont activées par un ensemble de clés de licence. Les clés de licence doivent être définies dans la propriété de clé de licence incluse dans le fichier de configuration du Wrapper.

Liste des propriétés de clé de licence

Chaque type de propriété de clé de licence est décrit en détail ci-dessous (clé de licence serveur, clé de licence de développement).

  • wrapper.license.debug
  • wrapper.license.dev_application
  • wrapper.license.features
  • wrapper.license.host_id
  • wrapper.license.id
  • wrapper.license.key.<n>
  • wrapper.license.lease_term.begin_date
  • wrapper.license.lease_term.end_date
  • wrapper.license.licensee
  • wrapper.license.type
  • wrapper.license.upgrade_term.begin_date
  • wrapper.license.upgrade_term.end_date

Des problèmes ?

Si vous rencontrez des problèmes de licence, veuillez définir la propriété wrapper.license.debug et activer le débogage des fichiers d'inclusion. Combinés, la plupart des problèmes de configuration deviennent évidents.

Aperçu des propriétés de clé de licence serveur

Les clés de licence serveur consistent en un ensemble de propriétés qui sont placées directement dans le fichier de configuration wrapper.conf ou incluses à l'aide d'un fichier de configuration en cascade. La clé de licence est liée à un HostId spécifique.

Le HostId d'un serveur donné peut être obtenu en exécutant wrapper -h depuis un shell ou une invite de commandes à l'emplacement du binaire du Wrapper (généralement le dossier bin). Cela produira la sortie suivante :

Exemple de sortie :
Java Service Wrapper Professional Edition nn-bit n.n.n
  Copyright (C) 1999-20nn Tanuki Software, Ltd. All Rights Reserved.
    https://wrapper.tanukisoftware.com

The Java Service Wrapper requires a License Key to activate the
software.  Licenses can be purchased on the Java Service Wrapper
web site:
  https://wrapper.tanukisoftware.com/purchase

You can also immediately obtain a one-month Free trial license:
  https://wrapper.tanukisoftware.com/trial

License Keys can be generated for any of the following HostIds:
  HostId #1:   00123456789a
  HostId #2:   00123456789b

You may include license keys for several servers within a single file by
  prefixing the property names of each key with their respective
  server host name or HostId. Please use the following syntax:
  wrapper.<hostname|hostid>.license.*.
  The host name of this machine is: myhost

N'importe lequel des HostIds affichés peut être utilisé pour générer la clé de licence.

Exemple de clé de licence serveur :
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=2024-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
  • La valeur de wrapper.license.type sera toujours 'NODE' pour les clés de licence serveur.

  • La valeur de wrapper.license.id est utilisée pour identifier de manière unique la clé de licence et apparaîtra sur votre page de gestion des licences.

  • La valeur de wrapper.license.licensee sera affichée dans la console et le fichier wrapper.log à chaque lancement du Wrapper. Dans le cas de la clé de licence ci-dessus, la sortie du Wrapper apparaîtra comme suit :

    Java Service Wrapper Professional Edition nn-bit n.n.n
      Copyright (C) 1999-2023 Tanuki Software, Ltd.  All Rights Reserved.
        https://wrapper.tanukisoftware.org
      Licensed to Acme, Inc.
    
  • La propriété wrapper.license.host_id identifie le serveur unique sur lequel le Wrapper sera autorisé à s'exécuter.

  • Les valeurs de wrapper.license.features sont utilisées pour décrire le nombre de bits et l'édition du Wrapper qui est autorisé. Dans ce cas, l'édition Professional 64 bits est autorisée. Cela autorisera également les versions inférieures 32 bits et Standard Edition du Wrapper à s'exécuter.

  • wrapper.license.upgrade_term.begin_date et wrapper.license.upgrade_term.end_date spécifient les dates de publication du Wrapper qui seront autorisées par la clé de licence. La licence ci-dessus autorisera les versions du Java Service Wrapper publiées avant le 2024-04-01. Les versions du Wrapper publiées pendant la période de mise à niveau spécifiée seront autorisées à être mises à niveau et également à s'exécuter au-delà de la fin de la période de mise à niveau.

  • Une période de location facultative peut également apparaître dans certaines clés de licence d'essai. Celles-ci spécifient les dates entre lesquelles le Wrapper sera autorisé à s'exécuter. Une fois la période de location expirée, le Wrapper ne démarrera plus.

  • Les propriétés wrapper.license.key.1-4 sont utilisées pour valider le reste des propriétés de licence.

NOTE

Les valeurs des propriétés de clé de licence sont spécifiques et la clé de licence ne parviendra pas à autoriser le Wrapper si l'une de ses valeurs est modifiée de quelque manière que ce soit.

Il est également possible d'inclure les clés de licence pour plusieurs serveurs dans un seul fichier en incluant les noms d'hôte dans les noms des propriétés de clé de licence. L'exemple suivant montre une clé de licence avec le nom d'hôte « myhost ». Il est possible de modifier la partie nom d'hôte des propriétés de clé de licence sans régénérer la clé.

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=2024-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

Alternativement, à partir de la version 3.3.2 du Wrapper, il est possible d'utiliser les HostIds eux-mêmes dans les noms des propriétés de clé de licence. Cela permet de définir plus d'une clé de licence, chacune pour un HostId différent. Un exemple où cela est nécessaire est un système qui utilise une carte réseau à équilibrage de charge où le HostId change en fonction de la carte physique sous-jacente actuellement active.

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

Aperçu des propriétés de clé de licence de développement

Les clés de licence de développement consistent en un ensemble de propriétés qui sont placées directement dans le fichier de configuration wrapper.conf ou incluses à l'aide d'un fichier de configuration en cascade. La clé de licence est liée à une application spécifique en utilisant les valeurs de la classe principale de l'application.

La classe principale de l'application est spécifiée à l'aide de la propriété wrapper.java.mainclass. Si la classe principale est l'une des classes d'aide fournies avec le Wrapper (org.tanukisoftware.wrapper.WrapperSimpleApp ou org.tanukisoftware.wrapper.WrapperStartStopApp), alors la classe principale sera spécifiée à l'aide de la propriété wrapper.app.parameter.1. Dans les deux cas, la licence n'autorisera le Wrapper que si la classe principale reste inchangée.

Exemple de clé de licence de développement :
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=2024-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
  • La valeur de wrapper.license.type sera toujours 'DEV' pour les clés de licence de développement.

  • La valeur de wrapper.license.id est utilisée pour identifier de manière unique la clé de licence et apparaîtra sur votre page de gestion des licences.

  • Les valeurs de wrapper.license.licensee et wrapper.license.dev_application seront affichées dans la console et le fichier wrapper.log à chaque lancement du Wrapper. Dans le cas de la clé de licence ci-dessus, la sortie du Wrapper apparaîtra comme suit :

    Java Service Wrapper Professional Edition nn-bit n.n.n
      Copyright (C) 1999-2023 Tanuki Software, Ltd.  All Rights Reserved.
        http://wrapper.tanukisoftware.org
      Licensed to Acme, Inc. for Acme Control Server
    
  • Les valeurs de wrapper.license.features sont utilisées pour décrire l'édition spécifique du Wrapper qui est autorisée. Dans ce cas, l'édition Professional 64 bits est autorisée. Cela autorisera également les versions inférieures 32 bits et Standard Edition du Wrapper à s'exécuter.

  • Les propriétés wrapper.license.upgrade_term.begin_date et wrapper.license.upgrade_term.end_date spécifient les dates de publication du Wrapper qui seront autorisées par la clé de licence. La licence ci-dessus autorisera les versions du Java Service Wrapper publiées avant le 2024-04-01. Les versions du Wrapper publiées pendant la période de mise à niveau spécifiée seront autorisées à être mises à niveau et également à s'exécuter au-delà de la fin de la période de mise à niveau.

  • Une période de location facultative peut également apparaître dans certaines clés de licence d'essai. Celles-ci spécifient les dates entre lesquelles le Wrapper sera autorisé à s'exécuter. Une fois la période de location expirée, le Wrapper ne démarrera plus.

  • Les propriétés wrapper.license.key.1-4 sont utilisées pour valider le reste des propriétés de licence.

    À partir de la version 3.3.6 du Wrapper, il est également possible d'obfusquer la période de mise à niveau dans une 5e valeur de clé. Cela peut être utile pour éviter de montrer aux clients la date de fin de la période de mise à niveau d'un éditeur de logiciels. Comme la période de mise à niveau de la clé de licence est obfusquée, cela peut bien sûr rendre un peu plus difficile le support des utilisateurs qui mettent à niveau le Wrapper par eux-mêmes. Lorsqu'un binaire du Wrapper plus récent que ce que la période de mise à niveau autorise est exécuté, le message d'erreur inclura la date de fin de la période, il s'agit donc d'un problème mineur.

    La fonctionnalité de période de mise à niveau obfusquée est accessible lors du téléchargement d'une clé de licence nouvelle ou existante.

Exemple de clé de licence de développement :
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.key.0=ada5-ac8d-6f2d-54f9
wrapper.license.key.1=a0a5-b478-ca71-8d59
wrapper.license.key.2=5296-6d2d-0e58-79e6
wrapper.license.key.3=6f5d-acf2-3d36-64f9
wrapper.license.key.4=c859-dcf5-61d7-b8ca

NOTE

Les valeurs des propriétés de clé de licence sont spécifiques et la clé de licence ne parviendra pas à autoriser le Wrapper si l'une de ses valeurs est modifiée de quelque manière que ce soit.

Fichier de licence dans un fichier de configuration en cascade

Il est souvent souhaitable de placer les propriétés de la clé de licence du Wrapper dans un fichier autre que le wrapper.conf. Cela peut être facilement réalisé en utilisant la fonctionnalité « fichier include » (style en cascade) des fichiers de configuration.

Il est recommandé de placer les propriétés de la clé de licence dans un fichier nommé wrapper-license.conf, situé dans le même répertoire que le fichier wrapper.conf. Le fichier de licence est ensuite inclus en plaçant une ligne comme la suivante en haut de votre fichier wrapper.conf :

@include ../conf/wrapper-license.conf

Notez que le chemin du fichier include est relatif à l'emplacement du binaire Wrapper et NON au fichier wrapper.conf. Consultez la section sur le fichier de configuration en cascade (« fichier include ») pour plus de détails et des conseils sur comment déboguer les problèmes liés aux fichiers include.

Pour simplifier la gestion d'un grand nombre de fichiers de licence, le Wrapper peut être configuré pour charger les fichiers de licence en fonction des noms d'hôte. Cela permet de déployer tous les fichiers de licence sur tous les serveurs.

@include ../conf/wrapper-license-%WRAPPER_HOST_NAME%.conf

Problèmes ?

Si vous rencontrez des problèmes de licence, veuillez définir la propriété wrapper.license.debug et activer le débogage des fichiers include. Utilisés ensemble, la plupart des problèmes de configuration deviennent évidents.