Class HomeName

java.lang.Object
swiss.trustbroker.federation.xmlconfig.HomeName
All Implemented Interfaces:
Serializable

public class HomeName extends Object implements Serializable
Home Name configuration.
See Also:
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
     
  • Constructor Summary

    Constructors
    Constructor
    Description
     
    HomeName(String attrValue, String reference, String migrationAlias, String value)
    Creates a new HomeName instance.
  • Method Summary

    Modifier and Type
    Method
    Description
     
    protected boolean
     
    boolean
     
    Overridden by value.
    Used for provisioning during migration from a CP to another.
     
    The homeName is usually consumed from the home name attribute and identifies the CP attribute to consume the CP identity from.
    The configuration is optional and provides a static value, when the e-id based CPs are not sending the attribute in the CP Attributes already or the value is computed from the CP SAML Response mainly for compatibility reasons, see GeneralDeriveHomeName.groovy for the special handling of this attribute.
    int
     
    void
    setAttrValue(String attrValue)
    Overridden by value.
    void
    setMigrationAlias(String migrationAlias)
    Used for provisioning during migration from a CP to another.
    void
    setReference(String reference)
    The homeName is usually consumed from the home name attribute and identifies the CP attribute to consume the CP identity from.
    void
    The configuration is optional and provides a static value, when the e-id based CPs are not sending the attribute in the CP Attributes already or the value is computed from the CP SAML Response mainly for compatibility reasons, see GeneralDeriveHomeName.groovy for the special handling of this attribute.
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • HomeName

      public HomeName()
    • HomeName

      public HomeName(String attrValue, String reference, String migrationAlias, String value)
      Creates a new HomeName instance.
      Parameters:
      attrValue - Overridden by value.
      reference - The homeName is usually consumed from the home name attribute and identifies the CP attribute to consume the CP identity from. If not specified or not provided by CP the SAML Response Subject NameID is used.
      migrationAlias - Used for provisioning during migration from a CP to another.
      value - The configuration is optional and provides a static value, when the e-id based CPs are not sending the attribute in the CP Attributes already or the value is computed from the CP SAML Response mainly for compatibility reasons, see GeneralDeriveHomeName.groovy for the special handling of this attribute.
      Since:
      1.9.0
      See Also:
      • getValue()
      • IdmProvisioningRequest.getHomeNameMigrationAlias()
  • Method Details

    • getName

      public String getName()
    • builder

      public static HomeName.HomeNameBuilder builder()
    • getAttrValue

      public String getAttrValue()
      Overridden by value.
      See Also:
    • getReference

      public String getReference()
      The homeName is usually consumed from the home name attribute and identifies the CP attribute to consume the CP identity from. If not specified or not provided by CP the SAML Response Subject NameID is used.
    • getMigrationAlias

      public String getMigrationAlias()
      Used for provisioning during migration from a CP to another.
      Since:
      1.9.0
      See Also:
      • IdmProvisioningRequest.getHomeNameMigrationAlias()
    • getValue

      public String getValue()
      The configuration is optional and provides a static value, when the e-id based CPs are not sending the attribute in the CP Attributes already or the value is computed from the CP SAML Response mainly for compatibility reasons, see GeneralDeriveHomeName.groovy for the special handling of this attribute.
    • setAttrValue

      public void setAttrValue(String attrValue)
      Overridden by value.
      See Also:
    • setReference

      public void setReference(String reference)
      The homeName is usually consumed from the home name attribute and identifies the CP attribute to consume the CP identity from. If not specified or not provided by CP the SAML Response Subject NameID is used.
    • setMigrationAlias

      public void setMigrationAlias(String migrationAlias)
      Used for provisioning during migration from a CP to another.
      Since:
      1.9.0
      See Also:
      • IdmProvisioningRequest.getHomeNameMigrationAlias()
    • setValue

      public void setValue(String value)
      The configuration is optional and provides a static value, when the e-id based CPs are not sending the attribute in the CP Attributes already or the value is computed from the CP SAML Response mainly for compatibility reasons, see GeneralDeriveHomeName.groovy for the special handling of this attribute.
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • canEqual

      protected boolean canEqual(Object other)
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object