1. Extensibility Guide
  2. Package and Deploy Customisations
  3. Customisation packaging
  4. Customizations in existing service layer without the need to expose a new customized REST endpoint

10.2.1 Customizations in existing service layer without the need to expose a new customized REST endpoint

  1. Building custom classes into customised jars:-

    The majority customizations that fall into this category for example Pre-Post hooks, domain and adapter extensions are done on artifacts present in the service jar mentioned in the previous section namely com.ofss.digx.app.<<moduleName>>.service.jar. So the corresponding extensions should be packaged in a jar named com.ofss.digx.cz.app.<<moduleName>>.service.jar

    Note:

    Similarily in case required artifacts related to extension classes get packaged into corresponding cz jars as mentioned above. For example if for a requirement we need to add a custom listener to a module say approval, the artifacts related to these listeners are packaged in a jar named com.ofss.digx.cz.jms.approval.listener.jar. This is depicted in the image below.

    Description of extensibilityguide40.png follows
    Description of the illustration extensibilityguide40.png

  2. Adding customised jars as dependencies in build scripts:-

    These custom jars can then be added to the war of the domain using the gradle scripts provided in the installer as demonstrated below:

    The patch set installer has the following folder structure

    OBDX_Patch_Installer\installables\dist\Domainwise\wars

    Taking ahead the current customization example we will refer module approval packaged within domain digx-admin. Please refer the below mentioned file for module approval. (As module approval is packaged in the domain named digx-admin)

    OBDX_Patch_Installer\installables\dist\Domainwise\wars\digx-admin\module.gradle


    Description of extensibilityguide41.png follows
    Description of the illustration extensibilityguide41.png

    There is a line in the above file as shown below:

    apply from: "../../cz/wars/digx-approval/module-cz.gradle"


    Description of extensibilityguide42.png follows
    Description of the illustration extensibilityguide42.png

    The highlighted line above refers to the file present inside the installer at the location given below.

    OBDX_Patch_Installer\installables\dist\Domainwise\cz\wars\digx-approval\module-cz.gradle

    So after customizations are done in a new jar say com.ofss.digx.cz.app.approval.service.jar, this jar can be specified in this (module-cz.gradle) file above as a dependency. Since dependencies in gradle are specified in group:artifact:version format, we can specify the dependency of this customized jar as below:

    warLibs "com.ofss.digx.cz.module.approval:com.ofss.digx.cz.app.account.service:$libs_digxVersion"

    1. Place custom jars in the folder such that it gets picked by the gradle script and is packaged within the domain war:-

      So that the above specified dependency of the customized jar gets resolved we need to place it in the folder structure as per group:artifact:version format.The repository defined for our base and customized product jars is

      OBDX_Patch_Installer\installables\gradle-repo

      Since in the above examplegroup isas mentioned below

      com.ofss.digx.cz.module.approval

      So wewillcreateafolderstructure\com\ofss\digx\cz\module\approvalinsideOBDX_Patch_Installer\installables\gradle-repo

      Now coming toartefact

      com.ofss.digx.cz.app.app roval.service

      For this we will create a folder named /com.ofss.digx.cz.app.approval.service inside the above mentioned folder.

      Finally the version is

      $libs_digxVersion

      This version is a variable. The value of this variable is defined in a file

      OBDX_Patch_Installer\core\config\gradle.properties.

      If the value of the variable is as shown below


      Description of extensibilityguide43.png follows
      Description of the illustration extensibilityguide43.png

      Create a folder named 22.2.0.0.0-SNAPSHOT inside the folder created for artefact above.

      Consequently the final folder structure should be as below

      OBDX_Patch_Installer\installables\gradle-repo\com\ofss\digx\cz\module\approval\ com.ofss.digx.cz.app.approval.service\22.2.0.0.0-SNAPSHOT

      Place your customised jar inside the above folder such that it gets picked by the gradle script and packaged inside the digx-admin war

Parent topic: Customisation packaging