Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

All other property names are prefixed by the module ID, followed by a period (.), and then a property suffix. The following suffixes are supported. Only "name" is required.

Suffix

Description

name

A human-readable but brief name

desc

A longer, human-readable description

url

A URL for more information or documentation

postenable

A message to display to a deployer that enables the module

postdisable

A message to display to a deployer that disables the module

n.src

Classpath or HTTP/HTTPS resource location for resource N managed by the module

n.dest

Filesystem location relative to idp.home for resource N to be placed when enabled

n.replace

A true/false value indicating whether a resource should directly overwrite an existing copy of itself. Default is false.

n.optional

A true/false value indicating whether the absence of a resource should influence whether the module is enabled or not. Default is false. This is useful to allow deployers to remove a file without the module thinking it's then disabled.

n.exec

A true/false value indicating whether a file should be marked executable on POSIX systems. Default is false.

The final 5 properties are a repeating pair (src/dest) for each resource managed by the module, with the others being optional. Resources are numbered starting at 1 and increasing atomically up to the last resource managed (no gaps allowed). Sources are generally classpath-based and should be absolute to ensure proper lookup. Destinations are filesystem paths relative to the IdP's install tree.

...