Versions Compared

Key

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

...

Typically, the convention is to put the Spring beans that define the flow's objects into the same directory with the flow file and then import it into the flow file.

Naming Considerations

If extensions define names for properties, beans, storage contexts or cookies, it's best to adhere to the recommendations listed below to avoid conflicts with existing names. Property names should not start with "idp.", bean names should not start with "shibboleth.", as these prefixes are reserved by the core project. It's recommended to choose your organization's Internet domain name in reverse order (or some other domain related to your extension) as the base for naming, e.g. "org.example". The following recommendations refer to this name as "base name". If you're implementing Java classes, you may just use your classes' package names (or parts of it) for building the various names.

Properties (configuration properties and message translation keys):

  • Prefix all properties with the base name.
    Examples: "org.example.idp.foo.storage.StorageService", "org.example.idp.foo.authn.apiHost"

Beans:

  • Prefix the names of all beans defined in a global context with the base name.
    Example: "org.example.idp.foo.authn.ClassifiedMessageMap"

Storage Contexts:

  • For persisting data via the org.opensaml.storage.StorageService interface, you need to specify a context name. Prefix the context names with the base name.
    Example: "org.example.idp.foo.authn/rememberSelection"

Cookies:

  • Prefix the names of cookies with the base name, replacing dots with dashes. (Dots are allowed, but seem not to be widely used.)
    Example: "org_example_idp_foo_rememberSelection"