Package swiss.trustbroker.federation.xmlconfig

Class Definition.DefinitionBuilder

java.lang.Object
swiss.trustbroker.federation.xmlconfig.Definition.DefinitionBuilder
Enclosing class:
Definition
public static class Definition.DefinitionBuilder extends Object

  • Method Details

    • name

      public Definition.DefinitionBuilder name(String name)
      Short name used in auditing and for IDM attribute addressing. Compound primary key member in attribute maps using Definition(De)Serializer.
      Returns:
      this.

    • namespaceUri

      public Definition.DefinitionBuilder namespaceUri(String namespaceUri)
      The long name is used in the generated SAML assertion towards the RP. Compound primary key member in attribute maps using Definition(De)Serializer.
      Returns:
      this.

    • source

      public Definition.DefinitionBuilder source(String source)
      Source of the definition Compound primary key member in attribute maps using Definition(De)Serializer.
      Returns:
      this.

    • altName

      public Definition.DefinitionBuilder altName(String altName)
      Known external attributes we just document here - used when we cannot use namespaceUri due to semantics.
      Returns:
      this.

    • oidcNames

      public Definition.DefinitionBuilder oidcNames(String oidcNames)
      The claim names used when emitting an attribute to an OIDC client (comma-separated - as an attribute, it cannot be a List).
      Returns:
      this.
      See Also:
      • Definition.oidcNamesToList(String)
      • Definition.oidcNameListToString(List)

    • cid

      public Definition.DefinitionBuilder cid(Boolean cid)
      Indicates whether this field is considered CID (client identifying data).
      Default: null - global default is used
      Returns:
      this.
      Since:
      1.8.0

    • multiValued

      public Definition.DefinitionBuilder multiValued(Multivalued multiValued)
      Multi value handling.
      Default: ORIGINAL
      Returns:
      this.

    • mappers

      public Definition.DefinitionBuilder mappers(String mappers)
      Comma-separated list of mappers to be used for the value.
      Returns:
      this.
      Since:
      1.9.0

    • oidcMapper

      @Deprecated public Definition.DefinitionBuilder oidcMapper(ClaimsMapper oidcMapper)
      Deprecated.
      use mappers
      Mapper to be used for the value.
      Returns:
      this.

    • provision

      public Definition.DefinitionBuilder provision(String provision)
      Provision this attribute to IDM.
      The value or list of comma-separated values indicate into what type(s) of IDM object provisioning services should provision this data.
      The actual fields to provision would usually be selected based on name/namespace URI.
      Generic values: true (a provisioning service selects an appropriate target), false (not provisioned - single value only).
      Default: false
      Returns:
      this.
      Since:
      1.9.0
      See Also:
      • IdmProvisioningService

    • provisioningId

      public Definition.DefinitionBuilder provisioningId(Boolean provisioningId)
      ID attribute for provisioning.
      Returns:
      this.
      Since:
      1.9.0
      See Also:
      • IdmProvisioningService

    • value

      public Definition.DefinitionBuilder value(String value)
      Single value from constant configuration (we currently only use single valued in XML via ConstAttributes).
      Returns:
      this.

    • scope

      public Definition.DefinitionBuilder scope(String scope)
      To restrict emitting an attribute, the scope can be set as follows:
      • saml: Use only in SAML assertions
      • oidc: Use only in OIDC tokens (oidcName must be set)
      If not set, the attribute is emitted on all protocols and any requested OIDC scope.
      Returns:
      this.

    • required

      public Definition.DefinitionBuilder required(Boolean required)
      Indicates whether this attribute is mandatory.
      For an AuthnResponse, this attribute must always be included
      Returns:
      this.
      Since:
      1.14.0

    • build

      public Definition build()

    • toString

      public String toString()
      Overrides:
      toString in class Object