Package swiss.trustbroker.config.dto

Class GuiProperties.GuiPropertiesBuilder

java.lang.Object

swiss.trustbroker.config.dto.GuiProperties.GuiPropertiesBuilder

Enclosing class:

GuiProperties

public static class GuiProperties.GuiPropertiesBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
GuiProperties.GuiPropertiesBuilder	announcementCookie(CookieProperties announcementCookie)	XTB can (via a plugin) support announcements to communicate with the federating user.
GuiProperties.GuiPropertiesBuilder	banners(List<Banner> banners)	Banners.
GuiProperties	build()
GuiProperties.GuiPropertiesBuilder	buttons(List<GuiButtons> buttons)	Buttons enabled for the theme.
GuiProperties.GuiPropertiesBuilder	claimsProviderNoticeCookie(CookieProperties claimsProviderNoticeCookie)	XTB can (via a plugin) support a notice screen that can be configured, where an end user can set a cookie to not show the screen next time.
GuiProperties.GuiPropertiesBuilder	defaultLanguage(String defaultLanguage)	Default language for the UI.
GuiProperties.GuiPropertiesBuilder	features(List<GuiFeatures> features)	Feature enabled for the theme.
GuiProperties.GuiPropertiesBuilder	images(String images)	Resource path where images used in the ClaimsProviderDefinitions are stored.
GuiProperties.GuiPropertiesBuilder	languageCookie(CookieProperties languageCookie)	Attributes for the cookie that stores the user's selected language.
GuiProperties.GuiPropertiesBuilder	maxBanners(Integer maxBanners)	Limit the number of banners shown on HRD.
GuiProperties.GuiPropertiesBuilder	taggedResourceMaxAgeSec(int taggedResourceMaxAgeSec)	Browser caching max-age in seconds for resources that have are tagged with an ETAG (a hash or version number).
GuiProperties.GuiPropertiesBuilder	themeAssets(String themeAssets)	Resource path where theme assets are stored.
GuiProperties.GuiPropertiesBuilder	themeCookie(CookieProperties themeCookie)	Attributes for the cookie that stores the user's theme (if there is a theme selector).
String	toString()
GuiProperties.GuiPropertiesBuilder	translations(String translations)	Resource path where UI language support files in JSON format are stored.
GuiProperties.GuiPropertiesBuilder	versionedResourceMaxAgeDay(int versionedResourceMaxAgeDay)	Browser caching max-age in days for resources that have resource version in the path (a hash or version number).
GuiProperties.GuiPropertiesBuilder	versionedResourcePaths(String[] versionedResourcePaths)	Paths of resources that have resource version in the path (a hash or version number).

Methods inherited from class java.lang.Object

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

Method Details

images

public GuiProperties.GuiPropertiesBuilder images(String images)

Resource path where images used in the ClaimsProviderDefinitions are stored.

Returns:

this.

See Also:

• ClaimsProviderMappings
• ClaimsProviderDefinitions

translations

public GuiProperties.GuiPropertiesBuilder translations(String translations)

Resource path where UI language support files in JSON format are stored.

Returns:

this.

themeAssets

public GuiProperties.GuiPropertiesBuilder themeAssets(String themeAssets)

Resource path where theme assets are stored.

Returns:

this.

defaultLanguage

public GuiProperties.GuiPropertiesBuilder defaultLanguage(String defaultLanguage)

Default language for the UI.

Returns:

this.

buttons

public GuiProperties.GuiPropertiesBuilder buttons(List<GuiButtons> buttons)

Buttons enabled for the theme.

Returns:

this.

features

public GuiProperties.GuiPropertiesBuilder features(List<GuiFeatures> features)

Feature enabled for the theme.

Returns:

this.

banners

public GuiProperties.GuiPropertiesBuilder banners(List<Banner> banners)

Banners.

Returns:

this.

Since:

1.9.0

maxBanners

public GuiProperties.GuiPropertiesBuilder maxBanners(Integer maxBanners)

Limit the number of banners shown on HRD.
For usability reasons, the area consumed by banners should be limited, so the number should be very small.

Returns:

this.

Since:

1.9.0

See Also:

• Banner.getOrder()

themeCookie

public GuiProperties.GuiPropertiesBuilder themeCookie(CookieProperties themeCookie)

Attributes for the cookie that stores the user's theme (if there is a theme selector).

Returns:

this.

languageCookie

public GuiProperties.GuiPropertiesBuilder languageCookie(CookieProperties languageCookie)

Attributes for the cookie that stores the user's selected language.

Returns:

this.

announcementCookie

public GuiProperties.GuiPropertiesBuilder announcementCookie(CookieProperties announcementCookie)

XTB can (via a plugin) support announcements to communicate with the federating user. These cookie preferences are used to customize it's client side behavior.

Returns:

this.

claimsProviderNoticeCookie

public GuiProperties.GuiPropertiesBuilder claimsProviderNoticeCookie(CookieProperties claimsProviderNoticeCookie)

XTB can (via a plugin) support a notice screen that can be configured, where an end user can set a cookie to not show the screen next time. These cookie preferences are used to customize it's client side behavior.

Returns:

this.

Since:

1.14.0

versionedResourceMaxAgeDay

public GuiProperties.GuiPropertiesBuilder versionedResourceMaxAgeDay(int versionedResourceMaxAgeDay)

Browser caching max-age in days for resources that have resource version in the path (a hash or version number).
These resources can be cached for a long period as any change will result in a new resource version.

Returns:

this.

Since:

1.10.0

versionedResourcePaths

public GuiProperties.GuiPropertiesBuilder versionedResourcePaths(String[] versionedResourcePaths)

Paths of resources that have resource version in the path (a hash or version number).

Returns:

this.

Since:

1.10.0

taggedResourceMaxAgeSec

public GuiProperties.GuiPropertiesBuilder taggedResourceMaxAgeSec(int taggedResourceMaxAgeSec)

Browser caching max-age in seconds for resources that have are tagged with an ETAG (a hash or version number).
These resources can be cached for some time after which the ETAG has to be checked.

Returns:

this.

Since:

1.10.0

build

public GuiProperties build()

toString

public String toString()

Overrides:

toString in class Object