Configuring Broker

The Broker is configured through environment variables or system properties, depending on your deployment type.

Common Configuration

These settings are required regardless of your deployment method.

Application Configuration

Property Description
oslc.broker.host Your Broker public URL (e.g., https://your-server:your-port/)
jira-cloud.host Your Jira Cloud URL (e.g., https://company.atlassian.net/)
jira-cloud.oauth.client.id OAuth Client ID from Atlassian Developer Console
jira-cloud.oauth.client.secret OAuth Client Secret from Atlassian Developer Console
jakarta.persistence.jdbc.url JDBC connection URL (e.g., jdbc:postgresql://database_server:5432/broker)
jakarta.persistence.jdbc.user Database username
jakarta.persistence.jdbc.password Database password

Standalone Tomcat Configuration

For standalone Tomcat deployments, configuration is done via a Tomcat context file.

File Locations

Component Location
Tomcat context configuration $CATALINA_BASE/conf/Catalina/localhost/oslc-connect-jira.xml
Logging configuration (see logging page) $CATALINA_BASE/conf/logback.xml
JVM settings $CATALINA_BASE/bin/setenv.sh
SSL Configuration $CATALINA_BASE/bin/server.xml
WAR file deployment $CATALINA_BASE/webapps/
Log files ${user.home}/oslc-connect-jira-cloud/logs/

Context Configuration (oslc-connect-jira.xml)

The Broker properties are configured in the Tomcat context file. Edit configuration/oslc-connect-jira.xml and replace the placeholder values:

<?xml version='1.0' encoding='UTF-8'?>
<Context>

  <Parameter name="logback.configurationFile" value="$CATALINA_BASE/conf/logback.xml" override="1"/>

  <Parameter name="oslc.broker.host" value="https://your-server:your-port/" override="1"/>

  <Parameter name="jira-cloud.host" value="https://company.atlassian.net/" override="1"/>
  <Parameter name="jira-cloud.oauth.client.id" value="your_oauth_client_id" override="1"/>
  <Parameter name="jira-cloud.oauth.client.secret" value="your_oauth_client_secret" override="1"/>

  <Parameter name="jakarta.persistence.jdbc.url" value="jdbc:postgresql://your_database_host:your_database_port/broker" override="1"/>
  <Parameter name="jakarta.persistence.jdbc.user" value="your_database_user" override="1"/>
  <Parameter name="jakarta.persistence.jdbc.password" value="your_database_password" override="1"/>

</Context>

JVM Settings (setenv.sh)

The setenv file configures JVM memory settings: -Xms512M -Xmx2048M

Deploying the WAR File

Remove application cache (if exists): $CATALINA_BASE/work/Catalina/localhost/oslc-connect-jira

Copy the WAR file in: $CATALINA_BASE/webapps/

Starting and Stopping Tomcat

Start Tomcat with: $CATALINA_BASE/bin/startup script

Stop Tomcat with: $CATALINA_BASE/bin/shutdown script

Those scripts can be launched as a service.

Verify Deployment

Access the application at: https://your-server:port/oslc-connect-jira/

Check the logs for any errors: ~/oslc-connect-jira-cloud/logs/broker.log

Important: You must restart Tomcat for configuration changes to take effect.