Package swiss.trustbroker.federation.xmlconfig

Interface PathReference

All Known Implementing Classes:
ClaimsParty, ClaimsProviderSetup, CounterParty, RelyingParty, RelyingPartySetup
public interface PathReference
A base config class that mau contain references relative to its file path.
General resolution order:
  1. Name relative to the subfolder of the file that defines the ReferenceHolder.
  2. Name relative to the global directory of the referenced type.
    • For scripts definition/scripts configured in globalScriptPath.
    • For profiles definition/profiles configured in globalProfilesPath.
    • For certificates keystore appending the subfolder.
  3. Name relative to the top directory of the referenced type.
    • For scripts definition.
    • For profiles definition.
    • For certificates keystore.
E.g. Suppose definition/test/app/SetupRP_Test.xml references a script named hooks/Test.groovy. This is searched in the following order:
  1. definition/test/app/hooks/Test.groovy
  2. definition/scripts/hooks/Test.groovy
  3. definition/hooks/Test.groovy
Suppose it also references a certificate named service/keystore.pem. This is searched in the following order:
  1. definition/test/app/service/keystore.pem
  2. keystore/test/app/service/keystore.pem
  3. keystore/service/keystore.pem
Suppose it also references a profile named base/ProfileRP_Test.xml. This is searched in the following order:
  1. definition/test/app/base/ProfileRP_Test.xml
  2. definition/profiles/base/ProfileRP_Test.xml
  3. definition/base/ProfileRP_Test.xml
Since:
1.7.0

  • Method Details

    • getSubPath

      String getSubPath()
      Returns:
      The file's path relative to the definition directory.

    • setSubPath

      void setSubPath(String subPath)
      Parameters:
      subPath - The file's path relative to the definition directory.