How to access jahia.properties from OSGi service

Question

Jahia officially recommends using OSGi configuration files (cfg) whenever possible to manage configurations. However, in some situations, you may need to access jahia.properties values from OSGi compliant code.

Answer

To read a Jahia property from Java code using OSGi, you'll need to use the SettingsBean. 

The SettingsBean can be used in 2 ways: 

• The best way is to inject it as an OSGi service, as done below:

  import org.jahia.api.settings.SettingsBean;
  @Reference(service = SettingsBean.class)
  public void setSettingsBean(SettingsBean settingsBean) {
    this.settingsBean = settingsBean;
  }

• The other way (less clean) is to use:

  import org.jahia.settings.SettingsBean;
  SettingsBean.getInstance();

Depending on how you want to use it, please note that the package is different.

Once the settingsBean is available to use in your class, it is possible to either: 

• Use a direct method giving access to the property, for instance: getMaxNameSize()

• Using the generic method: settingsBean.getString("myProperty", "myDefaultValue");

  Where:
  • myProperty is the key of the property you want to read
  • myDefaultValue is the default value if the property is not found