Package swiss.trustbroker.config.dto

Class AnnouncementConfig

java.lang.Object
swiss.trustbroker.config.dto.AnnouncementConfig
public class AnnouncementConfig extends Object
Announcement configuration.
Potentially breaking changes:
  • With 1.10.0 value of attributes changed to Object to allow nested structures.
See Also:

  • Constructor Details

    • AnnouncementConfig

      public AnnouncementConfig()

    • AnnouncementConfig

      public AnnouncementConfig(boolean enabled, String syncSchedule, String cachePath, String serviceUrl, int lifeTimeMin, String truststorePath, String truststorePassword, String globalApplicationName, List<String> applicationNames, boolean enableAppSpecificQuery, Map<String,Object> attributes)
      Creates a new AnnouncementConfig instance.
      Parameters:
      enabled - Disable the service to discard all announcements.
      Default: false
      syncSchedule - Schedule for fetching current announcements. Cron expression.
      cachePath - Path for the local announcements cache.
      serviceUrl - REST endpoint to retrieve current announcements from.
      lifeTimeMin - After this many minutes of connection loss discard the messages from the cache.
      Default: 15
      truststorePath - TLS truststore used to establish HTTPS connection.
      truststorePassword - Password for the truststore.
      Always specify 
      $PKI_PASSPHRASE
      for passwords as a place-holder for the key decryption passphrase to be passed to the running XTB process.
      globalApplicationName - Global Announcement application name
      applicationNames - A list of application names:
      • Global announcements are shown to all users on every federated login
      • CP related announcements as well, but they can also lead to disabling the HRD tile when the CP 'application' is marked as unavailable.
      enableAppSpecificQuery - App specific queries enabled.
      attributes - Custom attributes that might be needed by the implementation.
      Since:
      1.13.0

  • Method Details

    • getApplicationNames

      public List<String> getApplicationNames()

    • builder

      public static AnnouncementConfig.AnnouncementConfigBuilder builder()

    • isEnabled

      public boolean isEnabled()
      Disable the service to discard all announcements.
      Default: false

    • getSyncSchedule

      public String getSyncSchedule()
      Schedule for fetching current announcements. Cron expression.

    • getCachePath

      public String getCachePath()
      Path for the local announcements cache.

    • getServiceUrl

      public String getServiceUrl()
      REST endpoint to retrieve current announcements from.

    • getLifeTimeMin

      public int getLifeTimeMin()
      After this many minutes of connection loss discard the messages from the cache.
      Default: 15

    • getTruststorePath

      public String getTruststorePath()
      TLS truststore used to establish HTTPS connection.

    • getTruststorePassword

      public String getTruststorePassword()
      Password for the truststore.
      Always specify 
      $PKI_PASSPHRASE
      for passwords as a place-holder for the key decryption passphrase to be passed to the running XTB process.

    • getGlobalApplicationName

      public String getGlobalApplicationName()
      Global Announcement application name
      Since:
      1.13.0

    • isEnableAppSpecificQuery

      public boolean isEnableAppSpecificQuery()
      App specific queries enabled.

    • getAttributes

      public Map<String,Object> getAttributes()
      Custom attributes that might be needed by the implementation.

    • setEnabled

      public void setEnabled(boolean enabled)
      Disable the service to discard all announcements.
      Default: false

    • setSyncSchedule

      public void setSyncSchedule(String syncSchedule)
      Schedule for fetching current announcements. Cron expression.

    • setCachePath

      public void setCachePath(String cachePath)
      Path for the local announcements cache.

    • setServiceUrl

      public void setServiceUrl(String serviceUrl)
      REST endpoint to retrieve current announcements from.

    • setLifeTimeMin

      public void setLifeTimeMin(int lifeTimeMin)
      After this many minutes of connection loss discard the messages from the cache.
      Default: 15

    • setTruststorePath

      public void setTruststorePath(String truststorePath)
      TLS truststore used to establish HTTPS connection.

    • setTruststorePassword

      public void setTruststorePassword(String truststorePassword)
      Password for the truststore.
      Always specify 
      $PKI_PASSPHRASE
      for passwords as a place-holder for the key decryption passphrase to be passed to the running XTB process.

    • setGlobalApplicationName

      public void setGlobalApplicationName(String globalApplicationName)
      Global Announcement application name
      Since:
      1.13.0

    • setApplicationNames

      public void setApplicationNames(List<String> applicationNames)
      A list of application names:
      • Global announcements are shown to all users on every federated login
      • CP related announcements as well, but they can also lead to disabling the HRD tile when the CP 'application' is marked as unavailable.

    • setEnableAppSpecificQuery

      public void setEnableAppSpecificQuery(boolean enableAppSpecificQuery)
      App specific queries enabled.

    • setAttributes

      public void setAttributes(Map<String,Object> attributes)
      Custom attributes that might be needed by the implementation.

    • 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