Simba Drivers Decoupled from JasperReports Server WAR File

The following Simba JDBC drivers will be getting removed from the JasperReports Server WAR file:

• Athena
• Cassandra
• Impala
• Neo4j
• Spark

Important Note: No default DataSource properties or configurations are changed, Jaspersoft is removing the JAR files from the WAR file.

How to Get the Simba Drivers

Refer to the following URLs to get these Simba Drivers:

How to Install a Driver

To Install a Driver:

1) Create a custom components folder at the buildomatic level.
    In components folder, add the following folders: 
    a) A META-INF folder which contains components.properties file. In the property file, create these two properties:
        connectors.XXX.enabled = true|false
        connectors.XXX.artifacts = XXX.jar
    b) Create a folder named XXX-connector in which to place the JAR file.
    
    This folder structure can be achieved by executing target:
        <jrs bin>buildomatic> js-ant gen-components-metainf -DcomponentId=XXX(connector name) -DcomponentArtifacts=YYY(Driver along with version).jar 
        
2) After creating the folder structure, execute target js-ant install-components.

For example: <jrs bin>buildomatic> js-ant install-components

This will repackage the jasperserver-pro.WAR and deploy the JAR in the Tomcat WEB-INF/lib folder.

3) To update the JAR version, change the JAR version in components->META-INF->components.properties file at connectors.XXX.artifacts=YYY.jar

then place the specified version JAR in the components>XXX-connector folder and run script js-ant install-components. 
For example: <jrs bin>buildomatic> js-ant install-components

4) To remove a JAR, create or update components>META-INF>components.properties file as connectors.XXX.enabled = false OR you can add connectors.XXX.enabled = false in default_master.properties file and run js-ant install-components. 

For example: <jrs bin>buildomatic> js-ant install-components

How to Enable or Disable a Driver

To disable a driver, keep the entry connectors.XXX(connector).enabled = false in components>META-INF>components.properties file
To enable a driver, keep the entry connectors.XXX(connector).enabled = true in components>META-INF>components.properties file

After repackaging and Tomcat deployment is done, restart Tomcat.
    
To only repackage jasperserver-pro.WAR, run script:  <jrs bin>buildomatic> js-ant package-components
To only deploy in Tomcat webapp/WEB-INF/lib, run script:  <jrs bin>buildomatic> js-ant deploy-components
To repackage jasperserver-pro.WAR and deploy in Tomcat webapp/WEB-INF/lib, run script: <jrs bin>buildomatic> js-ant install-components

How to Download a Driver using the URL

Enable a driver using URL by following these steps:
If there is any custom component, include in lib WEB-INFlib without having JAR in the system, there is an option to keep the corresponding URL through which you can download the JAR property:
connectors.${project.artifactId}.url={URL from where we can download URL}

For example, for simba-athena, this folder structure can be achieved by using ant command:
    <jrs>/jasperserverbuildomatic> js-ant gen-components-metainf -DcomponentId=simba-athena -DcomponentArtifacts=AthenaJDBC42-2.0.35.1000.jar -DcomponentUrl=https://s3.amazonaws.com/athena-downloads/drivers/JDBC/SimbaAthenaJDBC-2.0.35.1000/AthenaJDBC42-2.0.35.1000.jar

Case 1:
    connectors.simba-athena.enabled=true
    connectors.simba-athena.artifacts=AthenaJDBC42-2.0.35.1000.jar
    connectors.simba-athena.url=https://s3.amazonaws.com/athena-downloads/drivers/JDBC/SimbaAthenaJDBC-2.0.35.1000/AthenaJDBC42-2.0.35.1000.jar
    
    Driver will get downloaded into /tmp/componentsXXX/components/simba-athena-connector 

Case 2:
    connectors.simba-athena.enabled=
    connectors.simba-athena.artifacts=AthenaJDBC42-2.0.35.1000.jar
    connectors.simba-athena.url=https://s3.amazonaws.com/athena-downloads/drivers/JDBC/SimbaAthenaJDBC-2.0.35.1000/AthenaJDBC42-2.0.35.1000.jar
    The simba-athena.enabled property will be considered to true because we are providing the URL property and the driver will get downloaded.

Case 3:
    connectors.simba-athena.enabled=true
    connectors.simba-athena.artifacts=AthenaJDBC42-2.jar
    connectors.simba-athena.url=https://s3.amazonaws.com/athena-downloads/drivers/JDBC/SimbaAthenaJDBC-2.0.35.1000/AthenaJDBC42-2.0.35.1000.jar
    
    If the driver name format differs from the download path, you can mention the required format in connectors.simba-athena.artifacts so that the driver will get renamed to required format .

Case 4:
    connectors.simba-athena.enabled=
    connectors.simba-athena.artifacts=
    connectors.simba-athena.url=https://s3.amazonaws.com/athena-downloads/drivers/JDBC/SimbaAthenaJDBC-2.0.35.1000/AthenaJDBC42-2.0.35.1000.jar
    
    In this case, it will treat enabled flag to true and artifacts will be assigned with AthenaJDBC42-2.0.35.1000.jar from URL