Versions Compared

Key

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

...

Code Block
languagetext
titleorg/example/module/impl/module.properties
collapsetrue
# You can assign a shorter module ID to use independent of the class.
org.example.module.impl.Example = org.example.Example

org.example.Example.name = Example Module
org.example.Example.desc = Feature that does an example thing
org.example.Example.url = https://wiki.example.org/docs/ExampleModule
org.example.Example.1.src = /org/example/module/conf/example.xml
org.example.Example.1.dest = conf/example-config.xml
org.example.Example.2.src = /org/example/module/views/example.vm
org.example.Example.2.dest = views/example.vm
org.example.Example.3.src = /org/example/module/edit-webapp/example.jsp
org.example.Example.3.dest = edit-webapp/example.jsp
org.example.Example.postenable = Customize edit-webapp/example.jsp and rebuild war to deploy.

Core IdP

...

Modules

The IdP modules that are part of the core software release are implemented inside of the idp-conf-impl Maven module as subtypes of the CoreIdPModule implementation class. This allows the module "url" property to be relative to the proper IdP wiki space (IDP4 initially). All modules are implemented in classes in impl packages and are assigned IDs that are prefixed with "idp.", further subdivided by functional area. The layout is as follows:

...

Note that the other content inside net/shibboleth/idp/ is outside the module "sphere" and are generally the internal system resources that used to reside in the idp.home/system/ folder.

Project Plugin Modules

Modules packaged within plugins produced by the Shibboleth Project should implement them based on the PluginIdPModule implementation class, a special case of depending on an implementation class in a separate module. This is strictly to "hide" the class from third parties. This allows the module "url" property to be relative to the proper wiki space (TBD initially).