Package swiss.trustbroker.federation.xmlconfig

Class ClaimsProvider.ClaimsProviderBuilder

java.lang.Object
swiss.trustbroker.federation.xmlconfig.ClaimsProvider.ClaimsProviderBuilder
Enclosing class:
ClaimsProvider
public static class ClaimsProvider.ClaimsProviderBuilder extends Object

  • Method Details

    • id

      public ClaimsProvider.ClaimsProviderBuilder id(String id)
      References the issuer ID of the CP.
      Returns:
      this.

    • enabled

      public ClaimsProvider.ClaimsProviderBuilder enabled(Boolean enabled)
      Allow pre-configuration of ClaimsProviderMappings with enabled or disabled ClaimsParty in profiles and only pick them per relying party in setup. Default: Unset value signals an enabled claims party and ignoring entries with the same id in the profile.
      Returns:
      this.
      Since:
      1.9.0

    • clientNetworks

      public ClaimsProvider.ClaimsProviderBuilder clientNetworks(String clientNetworks)
      A comma separated list of network identifiers. When computing the HRD screen the incoming loadbalancer HTTP Header Client_Network (is considered to filter out CPs that are not defined on the incoming network, mainly:
      • INTRANET (intranet)
      • INTERNET (external networks)
      Returns:
      this.

    • relyingPartyAlias

      public ClaimsProvider.ClaimsProviderBuilder relyingPartyAlias(String relyingPartyAlias)
      By providing a relying party ID on the HRD declaration, it's not necessary anymore to copy and paste entire RP definition files just to be able to automatically selecting an RP without showing a HRD selection screen. The relyingPartyAlias can refer to these three inputs:
      • SAML AuthnRequest.Issuer ID
      • SAML AuthnRequest.ProviderName
      • OIDC client_id
      The HRD entries with a relyingPartyAlias attribute are not shown on the HRD screen but are used to directly dispatch towards the CP when an RP with this issuer ID comes along.
      If no alias matches through and no HRD entries without an alias remain, all the tiles are displayed through.
      Returns:
      this.

    • hrdHintAlias

      public ClaimsProvider.ClaimsProviderBuilder hrdHintAlias(String hrdHintAlias)
      The HRD hint parameter sent by the RP is matched against the following attributes of the ClaimsProvider element.
      This allows decoupling the RP configuration from the internal CP ID. If configured, only the alias is checked against the HRD hint to avoid accidental dependency on the CP ID.
      The HRD hint is matched against the following ClaimsProvider fields in the given order:
      1. hrdHintAlias
      2. name
      3. id
      Name and/or ID might be URNs, in which case the hrdHintAlias can also help avoiding URL parameter encoding issues.
      Returns:
      this.
      Since:
      1.10.0
      See Also:

    • banner

      public ClaimsProvider.ClaimsProviderBuilder banner(String banner)
      Show this banner above the HRD selection area if tile is enabled.
      Returns:
      this.
      Since:
      1.9.0

    • order

      public ClaimsProvider.ClaimsProviderBuilder order(Integer order)
      Indicates the order of display in the UI. Special values:
      1. less or equal 0 - do not show in UI
      2. 1xx - first priority CPs (displayed larger, ordered numerically)
      3. 2xx - second priority CPs (displayed larger, ordered numerically)
      4. 3xx - third priority CPs (displayed smalled, ordered numerically)
      Default: ordered of definition in the XML
      Returns:
      this.
      Since:
      1.9.0

    • name

      public ClaimsProvider.ClaimsProviderBuilder name(String name)
      Name displayed to the user directly. The XTB SPA frontend uses it to translate the name into a text with the translation service. The skinny frontend uses the items directly.
      Returns:
      this.

    • title

      public ClaimsProvider.ClaimsProviderBuilder title(String title)
      Title for the CP tile and help item.
      The fallback order (if not defined) is: title > name > ID
      Returns:
      this.

    • description

      public ClaimsProvider.ClaimsProviderBuilder description(String description)
      Text displayed in the CP tile.
      The fallback order (if not defined) is: description > name > ID
      Returns:
      this.

    • img

      public ClaimsProvider.ClaimsProviderBuilder img(String img)
      Image displayed in the HRD large view.
      Returns:
      this.

    • button

      @Deprecated public ClaimsProvider.ClaimsProviderBuilder button(String button)
      Deprecated.
      remove
      Image displayed in the small view. This feature was removed and replaced by shortcut/color rendering. The small view was dropped in v1.5.
      Returns:
      this.

    • shortcut

      public ClaimsProvider.ClaimsProviderBuilder shortcut(String shortcut)
      A usually two-character code identifying the CP on small screens.
      Returns:
      this.

    • color

      public ClaimsProvider.ClaimsProviderBuilder color(String color)
      HTML color code identifying the CP on small screens.
      Returns:
      this.

    • noticeEnabled

      public ClaimsProvider.ClaimsProviderBuilder noticeEnabled(Boolean noticeEnabled)
      Notice enabled
      Returns:
      this.
      Since:
      1.14.0

    • noticeMaxAgeSec

      public ClaimsProvider.ClaimsProviderBuilder noticeMaxAgeSec(Integer noticeMaxAgeSec)
      Notice max age
      Returns:
      this.
      Since:
      1.14.0

    • noticeClaimsProviders

      public ClaimsProvider.ClaimsProviderBuilder noticeClaimsProviders(List<String> noticeClaimsProviders)
      The list of ClaimsProviders name
      Returns:
      this.
      Since:
      1.14.0

    • build

      public ClaimsProvider build()

    • toString

      public String toString()
      Overrides:
      toString in class Object