Class ConfigurationBean

java.lang.Object
io.goobi.viewer.managedbeans.ConfigurationBean
All Implemented Interfaces:
Serializable

@Named @ApplicationScoped public class ConfigurationBean extends Object implements Serializable
This is a wrapper class for the Configuration class for access from HTML.
See Also:
  • Constructor Details

    • ConfigurationBean

      public ConfigurationBean()
      Empty constructor.
  • Method Details

    • getModules

      public List<IModule> getModules()

      getModules.

      Returns:
      a List object.
    • getName

      public String getName()

      getName.

      Returns:
      a String object.
    • isBookmarksEnabled

      public boolean isBookmarksEnabled()

      isBookmarksEnabled.

      Returns:
      a boolean.
    • isSearchSavingEnabled

      public boolean isSearchSavingEnabled()
    • useOpenSeadragon

      public boolean useOpenSeadragon() throws ViewerConfigurationException

      useOpenSeadragon.

      Returns:
      a boolean.
      Throws:
      ViewerConfigurationException - if any.
    • useTiles

      public boolean useTiles(String pageType, String mimeType) throws ViewerConfigurationException

      useTiles.

      Parameters:
      pageType - a String object.
      mimeType - a String object.
      Returns:
      a boolean.
      Throws:
      ViewerConfigurationException - if any.
    • showImageNavigator

      public boolean showImageNavigator(String pageType, String mimeType) throws ViewerConfigurationException
      whether to show a navigator element in the openseadragon viewe
      Parameters:
      pageType - get settings for this pageType
      mimeType - get settings for this image type
      Returns:
      true if navigator should be shown
      Throws:
      ViewerConfigurationException
    • getFooterHeight

      public int getFooterHeight(String pageType, String mimeType) throws ViewerConfigurationException

      getFooterHeight.

      Parameters:
      pageType - a String object.
      mimeType - a String object.
      Returns:
      a int.
      Throws:
      ViewerConfigurationException - if any.
    • getImageSizes

      public List<String> getImageSizes(String pageType, String mimeType) throws ViewerConfigurationException

      getImageSizes.

      Parameters:
      pageType - a String object.
      mimeType - a String object.
      Returns:
      a List object.
      Throws:
      ViewerConfigurationException - if any.
    • getTileSizes

      public Map<Integer,List<Integer>> getTileSizes(String pageType, String mimeType) throws ViewerConfigurationException

      getTileSizes.

      Parameters:
      pageType - a String object.
      mimeType - a String object.
      Returns:
      a Map object.
      Throws:
      ViewerConfigurationException - if any.
    • useTiles

      public boolean useTiles() throws ViewerConfigurationException

      useTiles.

      Returns:
      a boolean.
      Throws:
      ViewerConfigurationException - if any.
    • useTilesFullscreen

      public boolean useTilesFullscreen() throws ViewerConfigurationException

      useTilesFullscreen.

      Returns:
      a boolean.
      Throws:
      ViewerConfigurationException - if any.
    • useTilesCrowd

      public boolean useTilesCrowd() throws ViewerConfigurationException

      useTilesCrowd.

      Returns:
      a boolean.
      Throws:
      ViewerConfigurationException - if any.
    • getFooterHeight

      public int getFooterHeight() throws ViewerConfigurationException

      getFooterHeight.

      Returns:
      a int.
      Throws:
      ViewerConfigurationException - if any.
    • getFooterHeightFullscreen

      public int getFooterHeightFullscreen() throws ViewerConfigurationException

      getFooterHeightFullscreen.

      Returns:
      a int.
      Throws:
      ViewerConfigurationException - if any.
    • getFooterHeightCrowd

      public int getFooterHeightCrowd() throws ViewerConfigurationException

      getFooterHeightCrowd.

      Returns:
      a int.
      Throws:
      ViewerConfigurationException - if any.
    • isRememberImageZoom

      public boolean isRememberImageZoom()

      isRememberImageZoom.

      Returns:
      a boolean.
    • isRememberImageRotation

      public boolean isRememberImageRotation()

      isRememberImageRotation.

      Returns:
      a boolean.
    • isDisplayStatistics

      public boolean isDisplayStatistics()

      isDisplayStatistics.

      Returns:
      a boolean.
    • isDisplaySearchRssLinks

      public boolean isDisplaySearchRssLinks()

      isDisplaySearchRssLinks.

      Returns:
      a boolean.
    • isAdvancedSearchEnabled

      public boolean isAdvancedSearchEnabled()

      isAdvancedSearchEnabled.

      Returns:
      a boolean.
    • isTimelineSearchEnabled

      public boolean isTimelineSearchEnabled()

      isTimelineSearchEnabled.

      Returns:
      a boolean.
    • isCalendarSearchEnabled

      public boolean isCalendarSearchEnabled()

      isCalendarSearchEnabled.

      Returns:
      a boolean.
    • isDisplayBreadcrumbs

      public boolean isDisplayBreadcrumbs()

      isDisplayBreadcrumbs.

      Returns:
      a boolean.
    • isDisplayMetadataPageLinkBlock

      public boolean isDisplayMetadataPageLinkBlock()

      isDisplayMetadataPageLinkBlock.

      Returns:
      a boolean.
    • isPagePdfEnabled

      public boolean isPagePdfEnabled()

      isPagePdfEnabled.

      Returns:
      a boolean.
    • getRssTitle

      public String getRssTitle()

      getRssTitle.

      Returns:
      a String object.
    • isDisplayTagCloudStartpage

      public boolean isDisplayTagCloudStartpage()

      isDisplayTagCloudStartpage.

      Returns:
      a boolean.
    • isDisplaySearchResultNavigation

      public boolean isDisplaySearchResultNavigation()

      isDisplaySearchResultNavigation.

      Returns:
      a boolean.
    • isDisplayStructType

      public boolean isDisplayStructType()

      isDisplayStructType.

      Returns:
      a boolean.
    • isDisplayCollectionBrowsing

      public boolean isDisplayCollectionBrowsing()

      isDisplayCollectionBrowsing.

      Returns:
      a boolean.
    • isDisplayUserNavigation

      public boolean isDisplayUserNavigation()

      isDisplayUserNavigation.

      Returns:
      a boolean.
    • isDisplayTagCloudNavigation

      public boolean isDisplayTagCloudNavigation()

      isDisplayTagCloudNavigation.

      Returns:
      a boolean.
    • isDisplayTitlePURL

      public boolean isDisplayTitlePURL()

      isDisplayTitlePURL.

      Returns:
      a boolean.
    • isSidebarTocWidgetVisible

      public boolean isSidebarTocWidgetVisible()

      isSidebarTocWidgetVisible.

      Returns:
      a boolean.
    • isSidebarTocWidgetVisibleInFullscreen

      public boolean isSidebarTocWidgetVisibleInFullscreen()

      isSidebarTocWidgetVisibleInFullscreen.

      Returns:
      a boolean.
    • isSidebarOpacLinkVisible

      public boolean isSidebarOpacLinkVisible()

      isSidebarOpacLinkVisible.

      Returns:
      a boolean.
    • isSidebarTocPageNumbersVisible

      public boolean isSidebarTocPageNumbersVisible()

      isSidebarTocPageNumbersVisible.

      Returns:
      a boolean.
    • isSidebarPageLinkVisible

      public boolean isSidebarPageLinkVisible()

      isSidebarPageLinkVisible.

      Returns:
      a boolean.
    • isSidebarCalendarLinkVisible

      public boolean isSidebarCalendarLinkVisible()

      isSidebarCalendarLinkVisible.

      Returns:
      a boolean.
    • isSidebarMetadataLinkVisible

      public boolean isSidebarMetadataLinkVisible()

      isSidebarMetadataLinkVisible.

      Returns:
      a boolean.
    • isSidebarThumbsLinkVisible

      public boolean isSidebarThumbsLinkVisible()

      isSidebarThumbsLinkVisible.

      Returns:
      a boolean.
    • isSidebarFulltextLinkVisible

      public boolean isSidebarFulltextLinkVisible()

      isSidebarFulltextLinkVisible.

      Returns:
      a boolean.
    • isTocTreeView

      public boolean isTocTreeView(String docStructType)

      isTocTreeView.

      Parameters:
      docStructType - a String object.
      Returns:
      a boolean.
    • isSidebarTocTreeView

      public boolean isSidebarTocTreeView()

      isSidebarTocTreeView.

      Returns:
      a boolean.
    • getSidebarTocLengthBeforeCut

      public int getSidebarTocLengthBeforeCut()

      getSidebarTocLengthBeforeCut.

      Returns:
      a int.
    • isDisplayTitleBreadcrumbs

      public boolean isDisplayTitleBreadcrumbs()

      isDisplayTitleBreadcrumbs.

      Returns:
      a boolean.
    • getTitleBreadcrumbsMaxTitleLength

      public int getTitleBreadcrumbsMaxTitleLength()

      getTitleBreadcrumbsMaxTitleLength.

      Returns:
      a int.
    • isDisplayTimeMatrix

      public boolean isDisplayTimeMatrix()

      isDisplayTimeMatrix.

      Returns:
      a boolean.
    • isDisplayCrowdsourcingModuleLinks

      public boolean isDisplayCrowdsourcingModuleLinks()

      isDisplayCrowdsourcingModuleLinks.

      Returns:
      a boolean.
    • getTimeMatrixStartYear

      public int getTimeMatrixStartYear(String subTheme) throws PresentationException, IndexUnreachableException

      getTimeMatrixStartYear.

      Parameters:
      subTheme -
      Returns:
      a int.
      Throws:
      PresentationException - if any.
      IndexUnreachableException - if any.
    • getTimeMatrixEndYear

      public int getTimeMatrixEndYear(String subTheme) throws PresentationException, IndexUnreachableException

      getTimeMatrixEndYear.

      Parameters:
      subTheme -
      Returns:
      a int.
      Throws:
      PresentationException - if any.
      IndexUnreachableException - if any.
    • getTimeMatrixHits

      public int getTimeMatrixHits()

      getTimeMatrixHits.

      Returns:
      Total hit number for the time matrix
    • isPiwikTrackingEnabled

      public boolean isPiwikTrackingEnabled()

      isPiwikTracking.

      Returns:
      a boolean.
    • getPiwikBaseURL

      public String getPiwikBaseURL()

      getPiwikBaseURL.

      Returns:
      a String object.
    • getPiwikSiteID

      public String getPiwikSiteID()

      getPiwikSiteID.

      Returns:
      a String object.
    • getAnchorThumbnailMode

      public String getAnchorThumbnailMode()

      getAnchorThumbnailMode.

      Returns:
      a String object.
    • getSortFields

      public List<String> getSortFields()

      getSortFields.

      Returns:
      a List object.
    • getTocIndentation

      public int getTocIndentation()

      getTocIndentation.

      Returns:
      a int.
    • isPageBrowseEnabled

      public boolean isPageBrowseEnabled()

      isPageBrowseEnabled.

      Returns:
      a boolean.
    • isPageBrowseStep1Visible

      public boolean isPageBrowseStep1Visible()

      isPageBrowseStep1Visible.

      Returns:
      a boolean.
    • isPageBrowseStep2Visible

      public boolean isPageBrowseStep2Visible()

      isPageBrowseStep2Visible.

      Returns:
      a boolean.
    • isPageBrowseStep3Visible

      public boolean isPageBrowseStep3Visible()

      isPageBrowseStep3Visible.

      Returns:
      a boolean.
    • getPageBrowseStep1

      public int getPageBrowseStep1()

      getPageBrowseStep1.

      Returns:
      a int.
    • getPageBrowseStep2

      public int getPageBrowseStep2()

      getPageBrowseStep2.

      Returns:
      a int.
    • getPageBrowseStep3

      public int getPageBrowseStep3()

      getPageBrowseStep3.

      Returns:
      a int.
    • getPageSelectDropdownDisplayMinPages

      public int getPageSelectDropdownDisplayMinPages()
      Returns:
      Configured value
    • getReCaptchaSiteKey

      public String getReCaptchaSiteKey()

      getReCaptchaSiteKey.

      Returns:
      a String object.
    • isUseReCaptcha

      public boolean isUseReCaptcha()

      isUseReCaptcha.

      Returns:
      a boolean.
    • isTocEpubEnabled

      public boolean isTocEpubEnabled()

      isTocEpubEnabled.

      Returns:
      a boolean.
    • isGeneratePdfInTaskManager

      public boolean isGeneratePdfInTaskManager()

      isGeneratePdfInTaskManager.

      Returns:
      a boolean.
    • isDocHierarchyPdfEnabled

      public boolean isDocHierarchyPdfEnabled()

      isDocHierarchyPdfEnabled.

      Returns:
      a boolean.
    • isShowSearchInItem

      public boolean isShowSearchInItem()

      isShowSearchInItem. </p

      Returns:
      a boolean.
    • isContentUploadEnabled

      public boolean isContentUploadEnabled()

      isContentUploadEnabled.

      Returns:
      a boolean.
    • isTranskribusEnabled

      public boolean isTranskribusEnabled()

      isTranskribusEnabled.

      Returns:
      a boolean.
    • isSearchExcelExportEnabled

      public boolean isSearchExcelExportEnabled()

      isSearchExcelExportEnabled.

      Returns:
      a boolean.
    • isSearchRisExportEnabled

      public boolean isSearchRisExportEnabled()

      isSearchRisExportEnabled.

      Returns:
      a boolean.
    • isDoublePageNavigationEnabled

      public boolean isDoublePageNavigationEnabled()

      isDoublePageNavigationEnabled.

      Returns:
      a boolean.
    • isSitelinksEnabled

      public boolean isSitelinksEnabled()

      isSitelinksEnabled.

      Returns:
      a boolean.
    • getRestApiUrl

      public String getRestApiUrl() throws ViewerConfigurationException

      getRestApiUrl.

      Returns:
      REST API URL
      Throws:
      ViewerConfigurationException - if any.
    • getRestApiUrlForIIIFPresention

      public String getRestApiUrlForIIIFPresention()
      Returns:
      Configured value
    • getIiifApiUrl

      public String getIiifApiUrl() throws ViewerConfigurationException

      getIiifApiUrl.

      Returns:
      a String object.
      Throws:
      ViewerConfigurationException - if any.
    • getRestApiUrlV1

      public String getRestApiUrlV1()
      Returns:
      The url to the /api/v1 Rest Api
    • getIso639_1

      public String getIso639_1(String language)

      getIso639_1.

      Parameters:
      language - a String object.
      Returns:
      a String object.
    • getIso639_2B

      public String getIso639_2B(String language)

      getIso639_2B.

      Parameters:
      language - a String object.
      Returns:
      a String object.
    • getTranslation

      public String getTranslation(String language, String locale)

      getTranslation.

      Parameters:
      language - a String object.
      locale - a String object.
      Returns:
      a String object.
    • isDisplaySidebarBrowsingTerms

      public boolean isDisplaySidebarBrowsingTerms()

      isDisplaySidebarBrowsingTerms.

      Returns:
      a boolean.
    • isDisplaySidebarRssFeed

      public boolean isDisplaySidebarRssFeed()

      isDisplaySidebarRssFeed.

      Returns:
      a boolean.
    • isDisplaySidebarWidgetUsage

      public boolean isDisplaySidebarWidgetUsage()

      isDisplayWidgetUsage.

      Returns:
      a boolean.
    • isDisplaySidebarWidgetUsageCitationLinks

      public boolean isDisplaySidebarWidgetUsageCitationLinks()

      isDisplaySidebarWidgetUsageCitationLinks.

      Returns:
      a boolean.
    • isDisplaySidebarWidgetUsageCitationRecommendation

      public boolean isDisplaySidebarWidgetUsageCitationRecommendation()

      isDisplaySidebarWidgetUsageCitationRecommendation.

      Returns:
      a boolean.
    • getSidebarWidgetUsagePageDownloadOptions

      public List<DownloadOption> getSidebarWidgetUsagePageDownloadOptions()
      Returns:
      List of configured DownloadOption items
    • isDisplaySidebarWidgetUsagePageDownloadOptions

      public boolean isDisplaySidebarWidgetUsagePageDownloadOptions()
    • getSidebarWidgetUsageCitationRecommendationStyles

      public List<String> getSidebarWidgetUsageCitationRecommendationStyles()
      Returns:
      List of available citation style names
    • isSubthemeDiscriminatorFieldSet

      public boolean isSubthemeDiscriminatorFieldSet()

      isSubthemeDiscriminatorFieldSet.

      Returns:
      a boolean.
    • getTwitterName

      public String getTwitterName()

      getTwitterName.

      Returns:
      a String object.
    • isCopyrightIndicatorEnabled

      public boolean isCopyrightIndicatorEnabled()
      Returns:
      Configured value
    • getCopyrightIndicatorStyle

      public String getCopyrightIndicatorStyle()
      Returns:
      Configured value
    • isDisplaySocialMediaShareLinks

      public boolean isDisplaySocialMediaShareLinks()
      Returns:
      Configured value
    • getMapBoxToken

      public String getMapBoxToken()
      Returns:
      Configured value
    • getMapBoxUser

      public String getMapBoxUser()
      Returns:
      Configured value
    • getMapBoxStyleId

      public String getMapBoxStyleId()
      Returns:
      Configured value
    • getSearchHitsPerPageValues

      public List<Integer> getSearchHitsPerPageValues()
      Returns:
      Configured value
    • getSearchChildHitsInitialLoadLimit

      public int getSearchChildHitsInitialLoadLimit()
      Returns:
      Configured value
    • getSearchChildHitsToLoadOnExpand

      public int getSearchChildHitsToLoadOnExpand()
    • getFeedbackEmailRecipients

      public List<EmailRecipient> getFeedbackEmailRecipients()
      Returns:
      Configured value
    • isDefaultSortFieldRandom

      public boolean isDefaultSortFieldRandom()
      Returns:
      true if default sorting field is 'RANDOM'; false otherwise
    • isDisplayUserGeneratedContentBelowImage

      public boolean isDisplayUserGeneratedContentBelowImage()
      Returns:
      Configured value
    • isDisplayDocstructNavigation

      public boolean isDisplayDocstructNavigation(String template, boolean fallbackToDefaultTemplate)
      Parameters:
      template -
      fallbackToDefaultTemplate -
      Returns:
      true if docstruct navigation is enabled and properly configured; false otherwise
    • isDisplayAnnotationTextInImage

      public boolean isDisplayAnnotationTextInImage()
      Returns:
      Configured value
    • isDisplayAddressSearchInMap

      public boolean isDisplayAddressSearchInMap()
      Returns:
      Configured value
    • isArchivesEnabled

      public boolean isArchivesEnabled()
      Returns:
      Configured value
    • getSearchSortingAscendingKey

      public String getSearchSortingAscendingKey(String field)
      Parameters:
      field -
      Returns:
      Configured value
    • getSearchSortingDescendingKey

      public String getSearchSortingDescendingKey(String field)
      Parameters:
      field -
      Returns:
      Configured value
    • getSearchResultGroupNames

      public List<String> getSearchResultGroupNames()
      Returns:
      List of names of the configured search result groups
    • isTranslateFacetFieldLabels

      public boolean isTranslateFacetFieldLabels(String facetField)
      Parameters:
      facetField -
      Returns:
      Configured value
    • useHeatmapForMapSearch

      public boolean useHeatmapForMapSearch()
      Returns:
      Configured value
    • getMarkerForMapSearch

      public GeoMapMarker getMarkerForMapSearch()
      Returns:
      Configured value
    • getSelectionColorForMapSearch

      public String getSelectionColorForMapSearch()
      Returns:
      Configured value
    • useHeatmapForFacetting

      public boolean useHeatmapForFacetting()
      Returns:
      Configured value
    • getMarkerForFacetting

      public GeoMapMarker getMarkerForFacetting()
      Returns:
      Configured value
    • getSelectionColorForFacetting

      public String getSelectionColorForFacetting()
      Returns:
      Configured value
    • useHeatmapForCMSMaps

      public boolean useHeatmapForCMSMaps()
      Returns:
      Configured value
    • getDefaultMarkerForCMSMaps

      public GeoMapMarker getDefaultMarkerForCMSMaps()
      Returns:
      Configured value
    • getGeomapAnnotationZoom

      public int getGeomapAnnotationZoom()
      Returns:
      Configured value
    • getCampaignGeomapInitialViewAsJson

      public String getCampaignGeomapInitialViewAsJson()
    • getCampaignGeomapTilesource

      public String getCampaignGeomapTilesource()
      Returns:
      Configured value
    • isConfigEditorEnabled

      public boolean isConfigEditorEnabled()
      Returns:
      Configured value
    • isDisplaySearchHitNumbers

      public boolean isDisplaySearchHitNumbers()
      Returns:
      Configured value
    • getGeomapFiltersAsJson

      public String getGeomapFiltersAsJson()
    • getGeomapFeatureTitleOptions

      public List<javax.faces.model.SelectItem> getGeomapFeatureTitleOptions()
    • getMetadataConfiguration

      public List<Metadata> getMetadataConfiguration(String type)
    • getMetadataConfiguration

      public List<Metadata> getMetadataConfiguration(String type, String template)
    • getPageType

      public String getPageType(String name)
      Parameters:
      name -
      Returns:
      Configured value
    • isFacetFieldDisplayValueFilter

      public boolean isFacetFieldDisplayValueFilter(String facetField)
      Parameters:
      facetField -
      Returns:
      Configured value