Configuring Entitlement

The Entitlement element specifies the module to use for validating permissions to resources within AMPS. AMPS allows you to set the default Entitlement for the instance as a whole, and also to set the Entitlement on each Transport individually.

Entitlement elements are not required. The instance authentication defaults to using the amps-default-entitlement-module if no Entitlement element is specified for the instance. An individual Transport defaults to using the instance Entitlement if no Entitlement element is provided for that Transport.

The Entitlement section describes how AMPS handles entitlements and the default modules in more detail.

Described below are the configuration items for setting Entitlement. Expand each item for more details.

Module

This element specifies the name of the module that will be used for entitlement.

The value of this element must be the Name of an entitlement module loaded in the Modules section of the configuration file or one of the entitlement modules that AMPS loads by default.

By default, AMPS loads the entitlement modules described in the following section.

Options

A list of options to provide to the module for this instance of the module.

AMPS allows you to pass options to the module by specifying elements within the Options element. The exact options that the module requires, if any, are determined by the creator of the module.

Entitlement Modules Loaded by Default

AMPS loads two entitlement modules by default. For more information about these modules, refer to the Entitlement section.