java.lang.Object
- de.xima.fc.gui.bean.portal.UserPortalConfigBean

All Implemented Interfaces:

IStateHolder, Serializable
```
@Named
@ViewScoped
public class UserPortalConfigBean
extends Object
implements Serializable, IStateHolder
```
Configuration of a single selected user portal via different tabs.

Since:

8.2.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

UserPortalConfigBean()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<String>`	`completeLanguageTag(String query)`	When the user triggers an autocomplete for a language tag input.
`Map<String,Object>`	`createFileUploadAttributes(String type, String fileKey)`
`void`	`deleteUserPortalContent(UserPortalContentViewModel userPortalContentViewModel)`
`void`	`discardChanges()`	Discards the changes.
`void`	`evaluateSelectedContentEditPermissions()`
`EConnectionStatus`	`getConnectionStatus(IServerModel server)`	Gets the connection status of the given server.
`List<String>`	`getCustomPortalFileKeys()`	A list of custom file keys that can be configured on the advanced tab of a user portal.
`List<String>`	`getCustomPortalMessageKeys()`	A list of custom message keys that can be configured on the advanced tab of a user portal.
`Map<String,String>`	`getDefaultPortalFileTextContent()`
`Map<String,String>`	`getDefaultUserPortalContentFileTextContent()`
`String`	`getFormDesignerUriOfSelectedFormContent()`
`List<FrontendServer>`	`getFsToReconnect()`
`LocaleBean`	`getLocaleBean()`
`UserPortalViewModel`	`getModel()`
`de.xima.fc.gui.bean.portal.UserPortalConfigBean.PermissionEvaluationCache`	`getPermissionEvaluationCache()`
`UserPortal`	`getPortal()`
`Map<String,String>`	`getPortalFileTextContent()`
`Locale`	`getRequestedDefaultLocale()`	Gets the requested default locale for the user portal configuration.
`Locale`	`getRequestedLocale()`	Gets the requested locale for the user portal configuration.
`ResourceBundleBean`	`getResourceBundleBean()`
`SelectionBean`	`getSelectionBean()`
`SessionUserManager`	`getUserManager()`
`UserPermissionsBean`	`getUserPermissionsBean()`
`UserPortalBean`	`getUserPortalBean()`
`Map<String,String>`	`getUserPortalContentFileTextContent()`
`String`	`getUserPortalContentLinkTooltip(UserPortalContentViewModel userPortalContentViewModel)`
`List<org.apache.commons.lang3.tuple.Pair<String,String>>`	`getUserPortalUrls(IServerModel server)`	Gets the URL to the user portal for the given server (with additional client information if the server is a client frontend server).
`ViewContextBean`	`getViewContextBean()`
`void`	`init()`
`boolean`	`isCanUserEditSelectedFormContent()`
`boolean`	`isCanUserEditTenantResources()`
`boolean`	`isCanUserEditTenantTemplateUrls()`
`boolean`	`isConnected(IServerModel server)`	Returns whether the given server is connected.
`void`	`newUserPortal()`	Creates a new user portal and prepares it for editing.
`void`	`onAddCustomPortalFileKeyClicked()`
`void`	`onAddNewTagClicked()`	When the user clicks the "Add" button to create a new tag, this method will be called.
`void`	`onAfterPortalDeleted()`	Called when a portal deleted.
`void`	`onDefaultLocaleChanged()`	When the default locale of the portal was changed, usually when the user selected a different locale in the backend UI.
`void`	`onEditTagClicked(UserPortalContentTagViewModel tag)`	Called when the user clicks the "Edit" button for a tag.
`void`	`onFileDeleted(String type, String fileKey)`	Called when the user click on the button to delete an existing file.
`void`	`onFileUploaded(org.primefaces.event.FileUploadEvent event)`	Called when the user uploads a file in the backend UI.
`void`	`onLocaleAdded()`	When the user added a new locale, such as by clicking on the add button in the language selector.
`void`	`onLocaleChanged(String languageTag)`	Called when the user changes the locale in the UI.
`void`	`onLocaleDeleted(String languageTag)`	When the user deleted an available locale, such as by clicking on the delete button in the language selector.
`void`	`onPropertyKeyChange(javax.faces.event.ValueChangeEvent event)`	Called when the user changes the key of a custom message.
`void`	`onRemoveCustomPortalFileKeyClicked(String key)`
`void`	`onRemoveCustomPortalMessageKeyClicked(String key)`
`void`	`onReorderInputAuthenticators(org.primefaces.event.ReorderEvent event)`	When the user reordered input login services via the UI.
`void`	`onReorderRedirectAuthenticators(org.primefaces.event.ReorderEvent event)`	When the user reordered redirect login services via the UI.
`void`	`reconnectFrontendServers()`
`String`	`resolveTagBackgroundColor(UserPortalContentTagViewModel tag)`	Resolves the color for the background of a given tag, used to display the tag on the UI.
`String`	`resolveTagTextColor(UserPortalContentTagViewModel tag)`	Resolves the text color for the background of a given tag, used to display the tag on the UI.
`void`	`saveChanges()`	Saves the changes.
`void`	`setFirstPortalFromList(List<UserPortal> portals)`	Selects the first portal from the given list of portals.
`void`	`setFsToReconnect(List<FrontendServer> fsToReconnect)`
`void`	`setRequestedDefaultLocale(Locale requestedDefaultLocale)`	Gets the requested default locale for the user portal configuration.
`void`	`setRequestedLocale(Locale requestedLocale)`	Sets the requested locale for the user portal configuration.
`void`	`setSelectedUserPortalContent(UserPortalContentViewModel selectedUserPortalContent)`
`boolean`	`showConnectionStatus(IServerModel server)`	Returns whether the connection status should be shown for the given server.
`List<UserPortalFileViewModel>`	`wrapFile(UserPortalFileViewModel file)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - UserPortalConfigBean
```
public UserPortalConfigBean()
```
- Method Detail
  - init
```
@PostConstruct
public void init()
```
  - setSelectedUserPortalContent
```
public void setSelectedUserPortalContent(UserPortalContentViewModel selectedUserPortalContent)
```
  - isCanUserEditTenantResources
```
public boolean isCanUserEditTenantResources()
```
  - isCanUserEditTenantTemplateUrls
```
public boolean isCanUserEditTenantTemplateUrls()
```
  - getCustomPortalFileKeys
```
public List<String> getCustomPortalFileKeys()
```
    A list of custom file keys that can be configured on the advanced tab of a user portal.
    
    Returns:
    
    List of custom file keys.
  - getCustomPortalMessageKeys
```
public List<String> getCustomPortalMessageKeys()
```
    A list of custom message keys that can be configured on the advanced tab of a user portal.
    
    Returns:
    
    List of custom message keys.
  - getUserPortalUrls
```
public List<org.apache.commons.lang3.tuple.Pair<String,String>> getUserPortalUrls(IServerModel server)
```
    Gets the URL to the user portal for the given server (with additional client information if the server is a client frontend server).
    
    Parameters:
    
    server - Server to get the URL for.
    
    Returns:
    
    URL to the user portal.
  - getConnectionStatus
```
public EConnectionStatus getConnectionStatus(IServerModel server)
```
    Gets the connection status of the given server.
    
    Parameters:
    
    server - Server to get the connection status for.
    
    Returns:
    
    Connection status of the server.
  - showConnectionStatus
```
public boolean showConnectionStatus(IServerModel server)
```
    Returns whether the connection status should be shown for the given server.
    
    Parameters:
    
    server - Server to check.
    
    Returns:
    
    true if the connection status should be shown, false otherwise.
  - isConnected
```
public boolean isConnected(IServerModel server)
```
    Returns whether the given server is connected.
    
    Parameters:
    
    server - Server to check.
    
    Returns:
    
    true if the server is connected, false otherwise.
  - getRequestedDefaultLocale
```
public Locale getRequestedDefaultLocale()
```
    Gets the requested default locale for the user portal configuration. The view should just use UserPortalViewModel.getDefaultLocale() ()}, but then we run into issues when the user changes the locale. The data for the current locale needs to be applied first, then the locale needs to be changed. Otherwise, the data is applied to the wrong locale.
    
    Returns:
    
    Requested default locale for the user portal configuration.
  - getRequestedLocale
```
public Locale getRequestedLocale()
```
    Gets the requested locale for the user portal configuration. The view should just use UserPortalViewModel.getSelectedLocale(), but then we run into issues when the user changes the locale. The data for the current locale needs to be applied first, then the locale needs to be changed. Otherwise, the data is applied to the wrong locale.
    
    Returns:
    
    Requested locale for the user portal configuration.
  - setFirstPortalFromList
```
public void setFirstPortalFromList(List<UserPortal> portals)
```
    Selects the first portal from the given list of portals.
    
    Parameters:
    
    portals - List of portals to select from.
  - completeLanguageTag
```
public List<String> completeLanguageTag(String query)
```
    When the user triggers an autocomplete for a language tag input. Searches the well-known locales for a match, either by language tag or by display name.
    
    Parameters:
    
    query - The query to complete.
    
    Returns:
    
    List of language tags that match the query.
  - newUserPortal
```
public void newUserPortal()
```
    Creates a new user portal and prepares it for editing.
  - onAddCustomPortalFileKeyClicked
```
public void onAddCustomPortalFileKeyClicked()
```
  - onAddNewTagClicked
```
public void onAddNewTagClicked()
```
    When the user clicks the "Add" button to create a new tag, this method will be called. It will create a new tag with the given name and add it to the list of tags.
  - onAfterPortalDeleted
```
public void onAfterPortalDeleted()
```
    Called when a portal deleted. Checks if the currently edited portal still exists. If not, finds a new portal to edit and loads its configuration.
  - getUserPortalContentLinkTooltip
```
public String getUserPortalContentLinkTooltip(UserPortalContentViewModel userPortalContentViewModel)
```
  - onDefaultLocaleChanged
```
public void onDefaultLocaleChanged()
```
    When the default locale of the portal was changed, usually when the user selected a different locale in the backend UI.
  - onEditTagClicked
```
public void onEditTagClicked(UserPortalContentTagViewModel tag)
```
    Called when the user clicks the "Edit" button for a tag. Prepares the model so that the tag can be edited.
    
    Parameters:
    
    tag - Tag to edit.
  - onFileDeleted
```
public void onFileDeleted(String type,
                          String fileKey)
```
    Called when the user click on the button to delete an existing file.
    
    Parameters:
    
    type - The type of the file (user portal content or user portal)
    
    fileKey - The key of the file to delete.
  - onFileUploaded
```
public void onFileUploaded(org.primefaces.event.FileUploadEvent event)
```
    Called when the user uploads a file in the backend UI.
    
    Parameters:
    
    event - File upload event with the file.
  - wrapFile
```
public List<UserPortalFileViewModel> wrapFile(UserPortalFileViewModel file)
```
  - createFileUploadAttributes
```
public Map<String,Object> createFileUploadAttributes(String type,
                                                           String fileKey)
```
  - onLocaleAdded
```
public void onLocaleAdded()
```
    When the user added a new locale, such as by clicking on the add button in the language selector. Adds the locale to the list of available locales, selects the new locale, and updates the model so that the new locale can be edited.
  - onLocaleChanged
```
public void onLocaleChanged(String languageTag)
```
    Called when the user changes the locale in the UI. This will prepare the view model so that the data for that locale can be edited.
  - onLocaleDeleted
```
public void onLocaleDeleted(String languageTag)
```
    When the user deleted an available locale, such as by clicking on the delete button in the language selector. Removes the locale from the list of available locales, and, if the deleted locale was the currently selected locale, changes the locale to the default locale and updates the model.
    
    Parameters:
    
    languageTag - The language tag of the deleted locale.
  - onRemoveCustomPortalFileKeyClicked
```
public void onRemoveCustomPortalFileKeyClicked(String key)
```
  - deleteUserPortalContent
```
public void deleteUserPortalContent(UserPortalContentViewModel userPortalContentViewModel)
```
  - onRemoveCustomPortalMessageKeyClicked
```
public void onRemoveCustomPortalMessageKeyClicked(String key)
```
  - onReorderInputAuthenticators
```
public void onReorderInputAuthenticators(org.primefaces.event.ReorderEvent event)
```
    When the user reordered input login services via the UI. Updates the model with the new order.
    
    Parameters:
    
    event - Reorder event with the new order.
  - onReorderRedirectAuthenticators
```
public void onReorderRedirectAuthenticators(org.primefaces.event.ReorderEvent event)
```
    When the user reordered redirect login services via the UI. Updates the model with the new order.
    
    Parameters:
    
    event - Reorder event with the new order.
  - resolveTagBackgroundColor
```
public String resolveTagBackgroundColor(UserPortalContentTagViewModel tag)
```
    Resolves the color for the background of a given tag, used to display the tag on the UI. Uses the configured color first, falling back to the default color.
    
    Parameters:
    
    tag - Tag to resolve the background color for.
    
    Returns:
    
    Background color for the tag.
  - resolveTagTextColor
```
public String resolveTagTextColor(UserPortalContentTagViewModel tag)
```
    Resolves the text color for the background of a given tag, used to display the tag on the UI. Uses the configured color, falling back to the default color.
    
    Parameters:
    
    tag - Tag to resolve the background color for.
    
    Returns:
    
    Background color for the tag.
  - saveChanges
```
public void saveChanges()
```
    Description copied from interface: IStateHolder
    
    Saves the changes.
    
    Specified by:
    
    saveChanges in interface IStateHolder
  - discardChanges
```
public void discardChanges()
```
    Description copied from interface: IStateHolder
    
    Discards the changes.
    
    Specified by:
    
    discardChanges in interface IStateHolder
  - reconnectFrontendServers
```
public void reconnectFrontendServers()
```
  - evaluateSelectedContentEditPermissions
```
public void evaluateSelectedContentEditPermissions()
```
  - getFormDesignerUriOfSelectedFormContent
```
public String getFormDesignerUriOfSelectedFormContent()
```
  - onPropertyKeyChange
```
public void onPropertyKeyChange(javax.faces.event.ValueChangeEvent event)
```
    Called when the user changes the key of a custom message. Updates the key in the model and in all properties of every locale.
    
    Parameters:
    
    event - Value change event with the old and new key.
  - getDefaultPortalFileTextContent
```
public Map<String,String> getDefaultPortalFileTextContent()
```
  - getDefaultUserPortalContentFileTextContent
```
public Map<String,String> getDefaultUserPortalContentFileTextContent()
```
  - getPortalFileTextContent
```
public Map<String,String> getPortalFileTextContent()
```
  - getUserPortalContentFileTextContent
```
public Map<String,String> getUserPortalContentFileTextContent()
```
  - getUserManager
```
public SessionUserManager getUserManager()
```
  - getLocaleBean
```
public LocaleBean getLocaleBean()
```
  - getSelectionBean
```
public SelectionBean getSelectionBean()
```
  - getUserPermissionsBean
```
public UserPermissionsBean getUserPermissionsBean()
```
  - getUserPortalBean
```
public UserPortalBean getUserPortalBean()
```
  - getViewContextBean
```
public ViewContextBean getViewContextBean()
```
  - getResourceBundleBean
```
public ResourceBundleBean getResourceBundleBean()
```
  - getModel
```
public UserPortalViewModel getModel()
```
  - getPortal
```
public UserPortal getPortal()
```
  - getFsToReconnect
```
public List<FrontendServer> getFsToReconnect()
```
  - isCanUserEditSelectedFormContent
```
public boolean isCanUserEditSelectedFormContent()
```
  - getPermissionEvaluationCache
```
public de.xima.fc.gui.bean.portal.UserPortalConfigBean.PermissionEvaluationCache getPermissionEvaluationCache()
```
  - setRequestedDefaultLocale
```
public void setRequestedDefaultLocale(Locale requestedDefaultLocale)
```
    Gets the requested default locale for the user portal configuration. The view should just use, but then we run into issues when the user changes the locale. The data for the current locale needs to be applied first, then the locale needs to be changed. Otherwise, the data is applied to the wrong locale.
  - setRequestedLocale
```
public void setRequestedLocale(Locale requestedLocale)
```
    Sets the requested locale for the user portal configuration. The view should just use, but then we run into issues when the user changes the locale. The data for the current locale needs to be applied first, then the locale needs to be changed. Otherwise, the data is applied to the wrong locale.
  - setFsToReconnect
```
public void setFsToReconnect(List<FrontendServer> fsToReconnect)
```

Class UserPortalConfigBean

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserPortalConfigBean

Method Detail

init

setSelectedUserPortalContent

isCanUserEditTenantResources

isCanUserEditTenantTemplateUrls

getCustomPortalFileKeys

getCustomPortalMessageKeys

getUserPortalUrls

getConnectionStatus

showConnectionStatus

isConnected

getRequestedDefaultLocale

getRequestedLocale

setFirstPortalFromList

completeLanguageTag

newUserPortal

onAddCustomPortalFileKeyClicked

onAddNewTagClicked

onAfterPortalDeleted

getUserPortalContentLinkTooltip

onDefaultLocaleChanged

onEditTagClicked

onFileDeleted

onFileUploaded

wrapFile

createFileUploadAttributes

onLocaleAdded

onLocaleChanged

onLocaleDeleted

onRemoveCustomPortalFileKeyClicked

deleteUserPortalContent

onRemoveCustomPortalMessageKeyClicked

onReorderInputAuthenticators

onReorderRedirectAuthenticators

resolveTagBackgroundColor

resolveTagTextColor

saveChanges

discardChanges

reconnectFrontendServers

evaluateSelectedContentEditPermissions

getFormDesignerUriOfSelectedFormContent

onPropertyKeyChange

getDefaultPortalFileTextContent

getDefaultUserPortalContentFileTextContent

getPortalFileTextContent

getUserPortalContentFileTextContent

getUserManager

getLocaleBean

getSelectionBean

getUserPermissionsBean

getUserPortalBean

getViewContextBean

getResourceBundleBean

getModel

getPortal

getFsToReconnect

isCanUserEditSelectedFormContent

getPermissionEvaluationCache

setRequestedDefaultLocale

setRequestedLocale

setFsToReconnect