Support for Server products ended Feb. 15, 2024. Learn what this means for you.

Servlet Context Parameter plugin module

Available:

Atlassian Plugin Framework 2.1 and later.
Note: The Servlet Context Parameter plugin module described below is available only for OSGi-based plugins using version 2.1 or later of the Plugin Framework.

Purpose of this Module Type

Servlet Context Parameter plugin modules allow you to set parameters in the Java Servlet context shared by your plugin's servlets, filters, and listeners.

Configuration

The root element for the Servlet Context Parameter plugin module is servlet-context-param. It allows the following attributes and child elements for configuration:

Attributes

Name*	Description
class	The class which implements this plugin module. The class you need to provide depends on the module type. For example, Confluence theme, layout and colour-scheme modules can use classes already provided in Confluence. So you can write a theme-plugin without any Java code. But for macro and listener modules you need to write your own implementing class and include it in your plugin. See the plugin framework guide to creating plugin module instances.
state	Indicate whether the plugin module should be disabled by default (value='disabled') or enabled by default (value='enabled'). Default: enabled.
i18n-name-key	The localisation key for the human-readable name of the plugin module.
key	The unique identifier of the plugin module. You refer to this key to use the resource from other contexts in your plugin, such as from the plugin Java code or JavaScript resources. 1 2 `<component-import key="appProps" interface="com.atlassian.sal.api.ApplicationProperties"/>` In the example, `appProps` is the key for this particular module declaration, for `component-import`, in this case. I.e. The identifier of the context parameter.
name	The human-readable name of the plugin module. I.e. The human-readable name of the context parameter. Default: the plugin key.
system	Indicates whether this plugin module is a system plugin module (value='true') or not (value='false'). Only available for non-OSGi plugins. Default: false.

*key attribute is required.

Elements

Name*	Description
description	The description of the plugin module. The 'key' attribute can be specified to declare a localisation key for the value instead of text in the element body. I.e. the description of the listener.
param-name	The servlet context parameter name.
param-value	The servlet context parameter value.

description

The description of the plugin module. The 'key' attribute can be specified to declare a localisation key for the value instead of text in the element body.

I.e. the description of the listener.

param-name

The servlet context parameter name.

param-value

The servlet context parameter value.

*param-name and param-value elements are required.

Example

Here is an example atlassian-plugin.xml file containing a single servlet context parameter:

1
2
<atlassian-plugin name="Hello World" key="example.plugin.helloworld" plugins-version="2">
    <plugin-info>
        <description>A basic Servlet context parameter module test</description>
        <vendor name="Atlassian Software Systems" url="http://www.atlassian.com"/>
        <version>1.0</version>
    </plugin-info>

    <servlet-context-param key="helloWorld">
        <description>Sets the Hello World text.</description>
        <param-name>text</param-name>
        <param-value>Hello World!</param-value>
    </servlet-context-param>
</atlassian-plugin>

Notes

Some information to be aware of when developing or configuring a Servlet Context Parameter plugin module:

This parameter will only be available to servlets, filters, and context listeners within your plugin.

Plugin Modules