About

AddHeader Plugin allows to inject an arbitrary header to the SP response. The header value can be either static and specified in the plugin configuration or dynamic (at the moment a field from the 'authenticated' identity in future possibly other sources).

Protocol

The plugin is never interfaced with directly. It only acts as filter.

Configuration

AddHeader Plugin can be placed anywhere in the chain, preferably in the very beginning or the very end. When using the 'identity' as the source of the value for the header and inserting the plugin in the auth chain make sure to put the plugin after the authn plugin, otherwise it will have no effect.

chains.record = addheader,relay
chains.auth = authn,addheader

Registration

plugins.addheader = com.indexdata.serviceproxy.plugins.AddHeaderPlugin

Properties

HEADER_NAME

Specifies the name of the injected header.

Mandatory, no default

Example:

    addheader.HEADER_NAME = X-SP-Realm

HEADER_SOURCE

Controls where to read the value for the header from. Possible values include: 'identity', 'config'

Mandatory, no default

Example:

    addheader.HEADER_SOURCE = identity

HEADER_VALUE

Depending on the HEADER_SOURCE setting this field can either contain the verbatim value (if HS='config') or the name of the field that will get expanded when the header is injected (e.g HS='identity' will allow to specify 'identity' memebers here like 'realm')

Mandatory, no default

Example:

    addheader.HEADER_VALUE = realm