Package swiss.trustbroker.config.dto

Class AnnouncementConfig.AnnouncementConfigBuilder

java.lang.Object

swiss.trustbroker.config.dto.AnnouncementConfig.AnnouncementConfigBuilder

Enclosing class:

AnnouncementConfig

public static class AnnouncementConfig.AnnouncementConfigBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
AnnouncementConfig.AnnouncementConfigBuilder	applicationNames(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.
AnnouncementConfig.AnnouncementConfigBuilder	attributes(Map<String,Object> attributes)	Custom attributes that might be needed by the implementation.
AnnouncementConfig	build()
AnnouncementConfig.AnnouncementConfigBuilder	cachePath(String cachePath)	Path for the local announcements cache.
AnnouncementConfig.AnnouncementConfigBuilder	enableAppSpecificQuery(boolean enableAppSpecificQuery)	App specific queries enabled.
AnnouncementConfig.AnnouncementConfigBuilder	enabled(boolean enabled)	Disable the service to discard all announcements.
AnnouncementConfig.AnnouncementConfigBuilder	globalApplicationName(String globalApplicationName)	Global Announcement application name
AnnouncementConfig.AnnouncementConfigBuilder	lifeTimeMin(int lifeTimeMin)	After this many minutes of connection loss discard the messages from the cache.
AnnouncementConfig.AnnouncementConfigBuilder	serviceUrl(String serviceUrl)	REST endpoint to retrieve current announcements from.
AnnouncementConfig.AnnouncementConfigBuilder	syncSchedule(String syncSchedule)	Schedule for fetching current announcements.
String	toString()
AnnouncementConfig.AnnouncementConfigBuilder	truststorePassword(String truststorePassword)	Password for the truststore.
AnnouncementConfig.AnnouncementConfigBuilder	truststorePath(String truststorePath)	TLS truststore used to establish HTTPS connection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

enabled

public AnnouncementConfig.AnnouncementConfigBuilder enabled(boolean enabled)

Disable the service to discard all announcements.
Default: false

Returns:

this.

syncSchedule

public AnnouncementConfig.AnnouncementConfigBuilder syncSchedule(String syncSchedule)

Schedule for fetching current announcements. Cron expression.

Returns:

this.

cachePath

public AnnouncementConfig.AnnouncementConfigBuilder cachePath(String cachePath)

Path for the local announcements cache.

Returns:

this.

serviceUrl

public AnnouncementConfig.AnnouncementConfigBuilder serviceUrl(String serviceUrl)

REST endpoint to retrieve current announcements from.

Returns:

this.

lifeTimeMin

public AnnouncementConfig.AnnouncementConfigBuilder lifeTimeMin(int lifeTimeMin)

After this many minutes of connection loss discard the messages from the cache.
Default: 15

Returns:

this.

truststorePath

public AnnouncementConfig.AnnouncementConfigBuilder truststorePath(String truststorePath)

TLS truststore used to establish HTTPS connection.

Returns:

this.

truststorePassword

public AnnouncementConfig.AnnouncementConfigBuilder truststorePassword(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.

Returns:

this.

globalApplicationName

public AnnouncementConfig.AnnouncementConfigBuilder globalApplicationName(String globalApplicationName)

Global Announcement application name

Returns:

this.

Since:

1.13.0

applicationNames

public AnnouncementConfig.AnnouncementConfigBuilder applicationNames(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.

Returns:

this.

enableAppSpecificQuery

public AnnouncementConfig.AnnouncementConfigBuilder enableAppSpecificQuery(boolean enableAppSpecificQuery)

App specific queries enabled.

Returns:

this.

attributes

public AnnouncementConfig.AnnouncementConfigBuilder attributes(Map<String,Object> attributes)

Custom attributes that might be needed by the implementation.

Returns:

this.

build

public AnnouncementConfig build()

toString

public String toString()

Overrides:

toString in class Object