Class 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:
    Serialized Form
    • Constructor Detail

      • ConfigurationBean

        public ConfigurationBean()
        Empty constructor.
    • Method Detail

      • getModules

        public List<IModule> getModules()

        getModules.

        Returns:
        a List object.
      • getName

        public String getName()

        getName.

        Returns:
        a String object.
      • isBookshelvesEnabled

        @Deprecated
        public boolean isBookshelvesEnabled()
        Deprecated.

        isBookshelvesEnabled.

        Returns:
        a boolean.
      • isBookmarksEnabled

        public boolean isBookmarksEnabled()

        isBookmarksEnabled.

        Returns:
        a boolean.
      • isSearchSavingEnabled

        public boolean isSearchSavingEnabled()
      • 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.
      • getTimeMatrixHits

        public int getTimeMatrixHits()

        getTimeMatrixHits.

        Returns:
        Total hit number for the time matrix
      • isPiwikTracking

        @Deprecated
        public boolean isPiwikTracking()
        Deprecated.
      • 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:
      • 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.

        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.
      • isDoublePageNavigationEnabled

        public boolean isDoublePageNavigationEnabled()

        isDoublePageNavigationEnabled.

        Returns:
        a boolean.
      • isSitelinksEnabled

        public boolean isSitelinksEnabled()

        isSitelinksEnabled.

        Returns:
        a boolean.
      • getRestApiUrlForIIIFPresention

        public String getRestApiUrlForIIIFPresention()
        Returns:
      • 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
      • getSidebarWidgetUsageCitationLinksForLevel

        public List<CitationLink> getSidebarWidgetUsageCitationLinksForLevel​(String levelName)
        Parameters:
        levelName -
        Returns:
        List of configured citation links
      • isSubthemeDiscriminatorFieldSet

        public boolean isSubthemeDiscriminatorFieldSet()

        isSubthemeDiscriminatorFieldSet.

        Returns:
        a boolean.
      • getTwitterName

        public String getTwitterName()

        getTwitterName.

        Returns:
        a String object.
      • isDisplayCopyrightInfo

        @Deprecated(since="22.07")
        public boolean isDisplayCopyrightInfo()
        Deprecated.
        Superseded by isCopyrightIndicatorEnabled
      • isCopyrightIndicatorEnabled

        public boolean isCopyrightIndicatorEnabled()
        Returns:
      • getCopyrightIndicatorStyle

        public String getCopyrightIndicatorStyle()
        Returns:
      • isDisplaySocialMediaShareLinks

        public boolean isDisplaySocialMediaShareLinks()
      • getMapBoxToken

        public String getMapBoxToken()
      • getMapBoxUser

        public String getMapBoxUser()
      • getMapBoxStyleId

        public String getMapBoxStyleId()
      • getSearchHitsPerPageValues

        public List<Integer> getSearchHitsPerPageValues()
        Returns:
      • getFeedbackEmailRecipients

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

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

        public boolean isDisplayUserGeneratedContentBelowImage()
      • 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()
      • isDisplayAddressSearchInMap

        public boolean isDisplayAddressSearchInMap()
      • isArchivesEnabled

        public boolean isArchivesEnabled()
      • getSearchSortingAscendingKey

        public String getSearchSortingAscendingKey​(String field)
      • getSearchSortingDescendingKey

        public String getSearchSortingDescendingKey​(String field)
      • isTranslateFacetFieldLabels

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

        public boolean useHeatmapForMapSearch()
      • getMarkerForMapSearch

        public GeoMapMarker getMarkerForMapSearch()
      • getSelectionColorForMapSearch

        public String getSelectionColorForMapSearch()
      • useHeatmapForFacetting

        public boolean useHeatmapForFacetting()
      • getMarkerForFacetting

        public GeoMapMarker getMarkerForFacetting()
      • getSelectionColorForFacetting

        public String getSelectionColorForFacetting()
      • useHeatmapForCMSMaps

        public boolean useHeatmapForCMSMaps()
      • getDefaultMarkerForCMSMaps

        public GeoMapMarker getDefaultMarkerForCMSMaps()
      • getGeomapAnnotationZoom

        public int getGeomapAnnotationZoom()
      • getCampaignGeomapInitialViewAsJson

        public String getCampaignGeomapInitialViewAsJson()
      • getCampaignGeomapTilesource

        public String getCampaignGeomapTilesource()
      • isConfigEditorEnabled

        public boolean isConfigEditorEnabled()
        Returns: