Skip to end of metadata
Go to start of metadata

Available:

Servlet Context Parameter plugin modules are available in JIRA 4.0 and later.

 

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

Required

Description

Default

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').

enabled

i18n-name-key

 

The localisation key for the human-readable name of the plugin module.

 

key

(tick)

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.

<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.

N/A

name

 

The human-readable name of the plugin module. I.e. The human-readable name of the context parameter.

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.

false

Elements

Name

Required

Description

Default

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

(tick)

The servlet context parameter name.

N/A

param-value

(tick)

The servlet context parameter value.

N/A

Example

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

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.

RELATED TOPICS

Information sourced from Plugin Framework documentation

  • No labels