Package io.goobi.viewer.controller

Class Configuration

java.lang.Object
io.goobi.viewer.controller.AbstractConfiguration
io.goobi.viewer.controller.Configuration
public class Configuration extends AbstractConfiguration

Configuration class.

  • Field Details

  • Constructor Details

    • Configuration

      public Configuration(String configFilePath)

      Constructor for Configuration.

      Parameters:
      configFilePath - a String object.

  • Method Details

    • loadStopwords

      protected static Set<String> loadStopwords(String stopwordsFilePath) throws IOException

      loadStopwords.

      Parameters:
      stopwordsFilePath - a String object.
      Returns:
      a Set object.
      Throws:
      IOException - if any.

    • getStopwords

      public Set<String> getStopwords()
      Returns the stopwords loading during initialization.
      Returns:
      a Set object.

    • getConfigLocalPath

      public String getConfigLocalPath()

      getConfigLocalPath.

      Returns:
      the path to the local config_viewer.xml file.

    • getLocalRessourceBundleFile

      public String getLocalRessourceBundleFile()

      getLocalRessourceBundleFile.

      Returns:
      a String object.

    • getViewerThumbnailsPerPage

      public int getViewerThumbnailsPerPage()

      getViewerThumbnailsPerPage.

      Returns:
      a int.

    • getViewerMaxImageWidth

      public int getViewerMaxImageWidth()

      getViewerMaxImageWidth.

      Returns:
      a int.

    • getViewerMaxImageHeight

      public int getViewerMaxImageHeight()

      getViewerMaxImageHeight.

      Returns:
      a int.

    • getViewerMaxImageScale

      public int getViewerMaxImageScale()

      getViewerMaxImageScale.

      Returns:
      a int.

    • isRememberImageZoom

      public boolean isRememberImageZoom()

      isRememberImageZoom.

      Returns:
      a boolean.

    • isRememberImageRotation

      public boolean isRememberImageRotation()

      isRememberImageRotation.

      Returns:
      a boolean.

    • getDfgViewerUrl

      public String getDfgViewerUrl()

      getDfgViewerUrl.

      Returns:
      a String object.

    • getDfgViewerSourcefileField

      public String getDfgViewerSourcefileField()
      Returns:
      Configured value

    • getMetadataListTypes

      public List<String> getMetadataListTypes(String prefix)
      Parameters:
      prefix - Optional prefix for filtering
      Returns:
      List of type attribute values of matching lists

    • getMetadataConfigurationForTemplate

      public List<Metadata> getMetadataConfigurationForTemplate(String type, String template, boolean fallbackToDefaultTemplate, boolean topstructValueFallbackDefaultValue)
      Parameters:
      type -
      template -
      fallbackToDefaultTemplate -
      topstructValueFallbackDefaultValue -
      Returns:
      List of metadata configurations

    • getMetadataTemplates

      public Map<String,List<Metadata>> getMetadataTemplates(String type)
      Parameters:
      type -
      Returns:
      Map<String, List<Metadata>>

    • getMetadataTemplates

      public Map<String,List<Metadata>> getMetadataTemplates(String type, boolean fallbackToDefaultTemplate, boolean topstructValueFallbackDefaultValue)
      Parameters:
      type -
      fallbackToDefaultTemplate -
      topstructValueFallbackDefaultValue -
      Returns:
      Map<String, List<Metadata>>

    • getSearchHitMetadataForTemplate

      public List<Metadata> getSearchHitMetadataForTemplate(String template)
      Returns the list of configured metadata for search hit elements.
      Parameters:
      template - a String object.
      Returns:
      a List object.

    • getPageMetadataForTemplate

      public List<Metadata> getPageMetadataForTemplate(String template)
      Returns the list of configured metadata for pages.
      Parameters:
      template - a String object.
      Returns:
      a List object.

    • getHighlightMetadataForTemplate

      public List<Metadata> getHighlightMetadataForTemplate(String template)
      Returns the list of configured metadata for Highlights which reference a record.
      Parameters:
      template - a String object.
      Returns:
      a List object.

    • getMetadataViews

      public List<MetadataView> getMetadataViews()
      Returns:
      Configured values

    • getMainMetadataForTemplate

      public List<Metadata> getMainMetadataForTemplate(int index, String template)
      Parameters:
      index -
      template -
      Returns:
      List of configured Metadata fields for the given template

    • getSidebarMetadataForTemplate

      public List<Metadata> getSidebarMetadataForTemplate(String template)
      Returns the list of configured metadata for the sidebar.
      Parameters:
      template - Template name
      Returns:
      List of configured metadata for configured fields

    • getArchiveMetadata

      public List<Metadata> getArchiveMetadata()
      Returns the list of configured metadata for the archives.
      Returns:
      List of configured metadata for configured fields

    • getNormdataFieldsForTemplate

      public List<String> getNormdataFieldsForTemplate(String template)

      getNormdataFieldsForTemplate.

      Parameters:
      template - Template name
      Returns:
      List of normdata fields configured for the given template name

    • getTocLabelConfiguration

      public List<Metadata> getTocLabelConfiguration(String template)

      getTocLabelConfiguration.

      Parameters:
      template - a String object.
      Returns:
      a List object.

    • getGeoMapFeatureConfiguration

      public Metadata getGeoMapFeatureConfiguration(String option, String template)

    • getMetadataListForGeomapMarkerConfig

      public String getMetadataListForGeomapMarkerConfig(String option)

    • getMetadataListForGeomapItemConfig

      public String getMetadataListForGeomapItemConfig(String option)

    • getGeomapFeatureConfigurations

      public Map<String,Metadata> getGeomapFeatureConfigurations(String option)

    • getGeomapItemConfigurations

      public Map<String,Metadata> getGeomapItemConfigurations(String option)

    • getGeomapFeatureTitleOptions

      public List<jakarta.faces.model.SelectItem> getGeomapFeatureTitleOptions()
      Returns:
      Configured values

    • getGeomapDefaultView

      public View getGeomapDefaultView()

    • getGeomapFilter

      public GeomapItemFilter getGeomapFilter(String name)

    • getGeomapFilters

      public List<GeomapItemFilter> getGeomapFilters()

    • getRecordGeomapFeatureSetConfigs

      public List<FeatureSetConfiguration> getRecordGeomapFeatureSetConfigs(String templateName)

    • getTocAnchorGroupElementsPerPage

      public int getTocAnchorGroupElementsPerPage()
      Returns number of elements displayed per paginator page in a table of contents for anchors and groups. Values below 1 disable pagination (all elements are displayed on the single page).
      Returns:
      a int.

    • getAdditionalFilesDisplayFilters

      public List<IFilterConfiguration> getAdditionalFilesDisplayFilters()

      Returns a regex such that all download files which filenames fit this regex should not be visible in the downloads widget. If an empty string is returned, all downloads should remain visible

      Returns:
      a regex or an empty string if no downloads should be hidden

    • isDisplaySidebarWidgetCitationCitationRecommendation

      public boolean isDisplaySidebarWidgetCitationCitationRecommendation()
      Returns:
      Boolean value

    • getSidebarWidgetCitationCitationRecommendationStyles

      public List<String> getSidebarWidgetCitationCitationRecommendationStyles()
      Returns:
      List of available citation style names

    • getSidebarWidgetCitationCitationRecommendationSource

      public Metadata getSidebarWidgetCitationCitationRecommendationSource()
      Returns:
      Configured values

    • getSidebarWidgetCitationCitationRecommendationDocstructMapping

      public Map<String,String> getSidebarWidgetCitationCitationRecommendationDocstructMapping()
      Returns:
      Map containing mappings DOCSTRCT -> citeproc type

    • isDisplaySidebarWidgetCitationCitationLinks

      public boolean isDisplaySidebarWidgetCitationCitationLinks()
      Returns:
      Boolean value

    • getSidebarWidgetCitationCitationLinks

      public List<CitationLink> getSidebarWidgetCitationCitationLinks()
      Returns:
      Configured values

    • getSidebarWidgetDownloadsPageDownloadOptions

      public List<DownloadOption> getSidebarWidgetDownloadsPageDownloadOptions()
      Returns a list of configured page download options.
      Returns:
      List of configured DownloadOption items

    • isDisplayWidgetDownloadsDownloadOptions

      public boolean isDisplayWidgetDownloadsDownloadOptions()
      Returns:
      Configured value

    • isDisplaySidebarWidgetDownloadsPdfPageRange

      public boolean isDisplaySidebarWidgetDownloadsPdfPageRange()
      Returns:
      Configured value; otherwise false

    • getSidebarWidgetsForView

      public List<String> getSidebarWidgetsForView(String view)
      Parameters:
      view - Record view name
      Returns:
      List of sidebar widget names to display in the given view (in the intended order)

    • isSidebarWidgetForViewCollapsible

      public boolean isSidebarWidgetForViewCollapsible(String view, String widget)
      Parameters:
      view - Record view name
      widget - Widget name
      Returns:
      true if widget configured as collapsible; false otherwise; default is false

    • isSidebarWidgetForViewCollapsedByDefault

      public boolean isSidebarWidgetForViewCollapsedByDefault(String view, String widget)
      Parameters:
      view - Record view name
      widget - Widget name
      Returns:
      true if widget configured as collapsed by default; false otherwise; default is false

    • getCalendarDocStructTypes

      public List<String> getCalendarDocStructTypes()
      Returns the list of structure elements allowed to be shown in calendar view
      Returns:
      a List object.

    • isBrowsingMenuEnabled

      public boolean isBrowsingMenuEnabled()

      isBrowsingMenuEnabled.

      Returns:
      a boolean.

    • getBrowsingMenuIndexSizeThreshold

      public int getBrowsingMenuIndexSizeThreshold()

      getBrowsingMenuIndexSizeThreshold.

      Returns:
      Solr doc count threshold for browsing term calculation

    • getBrowsingMenuHitsPerPage

      public int getBrowsingMenuHitsPerPage()

      getBrowsingMenuHitsPerPage.

      Returns:
      a int.

    • getBrowsingMenuFields

      public List<BrowsingMenuFieldConfig> getBrowsingMenuFields()
      Returns the list of index fields to be used for term browsing.
      Returns:
      a List object.

    • getBrowsingMenuSortingIgnoreLeadingChars

      public String getBrowsingMenuSortingIgnoreLeadingChars()
      Returns:
      Configured value

    • getDocstrctWhitelistFilterQuery

      public String getDocstrctWhitelistFilterQuery()

      getDocstrctWhitelistFilterQuery.

      Returns:
      a String object.

    • getCollectionSplittingChar

      public String getCollectionSplittingChar(String field)

      getCollectionSplittingChar.

      Parameters:
      field - a String object.
      Returns:
      a String object.

    • getConfiguredCollectionFields

      public List<String> getConfiguredCollectionFields()
      Returns:
      Configured values

    • getCollectionSortOrders

      public Map<String,String> getCollectionSortOrders(String field)
      Get all configured sortOrders for collections in the given field, mapped against regex which should match the collection(s) which subcollections should be sorted according the sortOrder
      Parameters:
      field - the solr fild on which the collection is based
      Returns:
      a map of regular expressions matching collection names and associated sortOrders

    • getCollectionSorting

      public List<DcSortingList> getCollectionSorting(String field)

      getCollectionSorting.

      Parameters:
      field - a String object.
      Returns:
      a List object.

    • getCollectionBlacklist

      public List<String> getCollectionBlacklist(String field)
      Returns collection names to be omitted from search results, listings etc.
      Parameters:
      field - a String object
      Returns:
      a List object.

    • getCollectionDefaultSortFields

      public Map<String,String> getCollectionDefaultSortFields(String field)
      Returns the index field by which records in the collection with the given name are to be sorted in a listing.
      Parameters:
      field - a String object.
      Returns:
      a String object.

    • getCollectionDisplayNumberOfVolumesLevel

      public int getCollectionDisplayNumberOfVolumesLevel(String field)

      getCollectionDisplayNumberOfVolumesLevel.

      Parameters:
      field - a String object.
      Returns:
      a int.

    • getCollectionDisplayDepthForSearch

      public int getCollectionDisplayDepthForSearch(String field)

      getCollectionDisplayDepthForSearch.

      Parameters:
      field - a String object.
      Returns:
      a int.

    • getCollectionHierarchyField

      public String getCollectionHierarchyField()

      getCollectionHierarchyField.

      Returns:
      a String object.

    • isAddCollectionHierarchyToBreadcrumbs

      public boolean isAddCollectionHierarchyToBreadcrumbs(String field)

      isAddCollectionHierarchyToBreadcrumbs.

      Parameters:
      field - a String object.
      Returns:
      a boolean.

    • getSolrUrl

      public String getSolrUrl()

      getSolrUrl.

      Returns:
      a String object.

    • getDownloadUrl

      public String getDownloadUrl()

      getDownloadUrl.

      Returns:
      a String object.

    • getViewerBaseUrl

      public String getViewerBaseUrl()
      Get the base url of the viewer. This is the url up to the context path. The returned url always ends with a '/'
      Returns:
      The base viewer url

    • getRestApiUrl

      public String getRestApiUrl()

      getRestApiUrl.

      Returns:
      The url to the viewer REST API as configured in the config_viewer. The url always ends with "/"

    • getIIIFApiUrl

      public String getIIIFApiUrl()
      url to rest api url for record media files. Always ends with a slash
      Returns:
      Configured value

    • isUseIIIFApiUrlForCmsMediaUrls

      public boolean isUseIIIFApiUrlForCmsMediaUrls()
      Returns:
      Configured value

    • getSourceFileUrl

      public String getSourceFileUrl()

      getSourceFileUrl.

      Returns:
      a String object.

    • getMarcUrl

      public String getMarcUrl()

      getMarcUrl.

      Returns:
      a String object.

    • getDcUrl

      public String getDcUrl()

      getDcUrl.

      Returns:
      a String object.

    • getEseUrl

      public String getEseUrl()

      getEseUrl.

      Returns:
      a String object.

    • getSearchHitsPerPageValues

      public List<Integer> getSearchHitsPerPageValues()

      getSearchHitsPerPageValues.

      Returns:
      List of configured values

    • isDisplaySearchHitNumbers

      public boolean isDisplaySearchHitNumbers()
      Returns:
      Configured value; default value if none found

    • getSearchChildHitsInitialLoadLimit

      public int getSearchChildHitsInitialLoadLimit()

    • getSearchChildHitsToLoadOnExpand

      public int getSearchChildHitsToLoadOnExpand()

    • getSearchHitsPerPageDefaultValue

      public int getSearchHitsPerPageDefaultValue()

      getSearchHitsPerPageDefaultValue.

      Returns:
      value element that is marked as default value; 10 if none found

    • getFulltextFragmentLength

      public int getFulltextFragmentLength()

      getFulltextFragmentLength.

      Returns:
      a int.

    • isAdvancedSearchEnabled

      public boolean isAdvancedSearchEnabled()

      isAdvancedSearchEnabled.

      Returns:
      a boolean.

    • getAdvancedSearchTemplateNames

      public List<String> getAdvancedSearchTemplateNames()
      Returns:
      List of configured template names

    • getAdvancedSearchDefaultTemplateName

      public String getAdvancedSearchDefaultTemplateName()
      Returns:
      _DEFAULT or the name of the first template in the list

    • getAdvancedSearchTemplateQuery

      public String getAdvancedSearchTemplateQuery(String template)
      Parameters:
      template -
      Returns:
      Value of the query attribute; empty string if none found

    • getAdvancedSearchFields

      public List<AdvancedSearchFieldConfiguration> getAdvancedSearchFields(String template, boolean fallbackToDefaultTemplate, String language)

      getAdvancedSearchFields.

      Parameters:
      template -
      fallbackToDefaultTemplate -
      language -
      Returns:
      a List object.

    • isDisplayAdditionalMetadataEnabled

      public boolean isDisplayAdditionalMetadataEnabled()

      isDisplayAdditionalMetadataEnabled.

      Returns:
      a boolean.

    • getDisplayAdditionalMetadataIgnoreFields

      public List<String> getDisplayAdditionalMetadataIgnoreFields()

      getDisplayAdditionalMetadataIgnoreFields.

      Returns:
      List of configured fields; empty list if none found.

    • getDisplayAdditionalMetadataTranslateFields

      public List<String> getDisplayAdditionalMetadataTranslateFields()

      Returns a list of additional metadata fields thats are configured to have their values translated. Field names are normalized (i.e. things like _UNTOKENIZED are removed).

      Returns:
      List of configured fields; empty list if none found.

    • getDisplayAdditionalMetadataOnelineFields

      public List<String> getDisplayAdditionalMetadataOnelineFields()

      getDisplayAdditionalMetadataIgnoreFields.

      Returns:
      List of configured fields; empty list if none found.

    • getDisplayAdditionalMetadataSnippetFields

      public List<String> getDisplayAdditionalMetadataSnippetFields()

      getDisplayAdditionalMetadataSnippetFields.

      Returns:
      List of configured fields; empty list if none found.

    • getDisplayAdditionalMetadataNoHighlightFields

      public List<String> getDisplayAdditionalMetadataNoHighlightFields()

      getDisplayAdditionalMetadataNoHighlightFields.

      Returns:
      List of configured fields; empty list if none found.

    • isAdvancedSearchFieldHierarchical

      public boolean isAdvancedSearchFieldHierarchical(String field, String template, boolean fallbackToDefaultTemplate)

      isAdvancedSearchFieldHierarchical.

      Parameters:
      field - a String object.
      template -
      fallbackToDefaultTemplate -
      Returns:
      a boolean.

    • isAdvancedSearchFieldRange

      public boolean isAdvancedSearchFieldRange(String field, String template, boolean fallbackToDefaultTemplate)

      isAdvancedSearchFieldRange.

      Parameters:
      field - a String object.
      template -
      fallbackToDefaultTemplate -
      Returns:
      a boolean.

    • isAdvancedSearchFieldAllowMultipleItems

      public boolean isAdvancedSearchFieldAllowMultipleItems(String field, String template, boolean fallbackToDefaultTemplate)

      isAdvancedSearchFieldAllowMultipleItems.

      Parameters:
      field - a String object.
      template -
      fallbackToDefaultTemplate -
      Returns:
      a boolean.

    • isAdvancedSearchFieldUntokenizeForPhraseSearch

      public boolean isAdvancedSearchFieldUntokenizeForPhraseSearch(String field, String template, boolean fallbackToDefaultTemplate)

      isAdvancedSearchFieldUntokenizeForPhraseSearch.

      Parameters:
      field - a String object.
      template -
      fallbackToDefaultTemplate -
      Returns:
      a boolean.

    • getAdvancedSearchFieldDisplaySelectItemsThreshold

      public int getAdvancedSearchFieldDisplaySelectItemsThreshold(String field, String template, boolean fallbackToDefaultTemplate)
      Parameters:
      field -
      template -
      fallbackToDefaultTemplate -
      Returns:
      Configured value

    • getAdvancedSearchFieldSelectType

      public String getAdvancedSearchFieldSelectType(String field, String template, boolean fallbackToDefaultTemplate)
      Parameters:
      field -
      template -
      fallbackToDefaultTemplate -
      Returns:
      Configured value

    • getAdvancedSearchFieldSeparatorLabel

      public String getAdvancedSearchFieldSeparatorLabel(String field, String template, boolean fallbackToDefaultTemplate)

      isAdvancedSearchFieldHierarchical.

      Parameters:
      field - a String object.
      template -
      fallbackToDefaultTemplate -
      Returns:
      Label attribute value for the given field name

    • getAdvancedSearchFieldReplaceRegex

      public String getAdvancedSearchFieldReplaceRegex(String field, String template, boolean fallbackToDefaultTemplate)
      Parameters:
      field -
      template -
      fallbackToDefaultTemplate -
      Returns:
      Configured value; null if none found

    • getAdvancedSearchFieldReplaceWith

      public String getAdvancedSearchFieldReplaceWith(String field, String template, boolean fallbackToDefaultTemplate)
      Parameters:
      field -
      template -
      fallbackToDefaultTemplate -
      Returns:
      Configured value; null if none found

    • getAdvancedSearchFieldDefaultOperator

      public String getAdvancedSearchFieldDefaultOperator(String field, String template, boolean fallbackToDefaultTemplate)
      Parameters:
      field -
      template -
      fallbackToDefaultTemplate -
      Returns:
      Configured value; null if none found

    • getAdvancedSearchTemplateFirstLineDefaultOperator

      public String getAdvancedSearchTemplateFirstLineDefaultOperator(String template)
      Parameters:
      template -
      Returns:
      Configured value; null if none found

    • isTimelineSearchEnabled

      public boolean isTimelineSearchEnabled()

      isTimelineSearchEnabled.

      Returns:
      a boolean.

    • isCalendarSearchEnabled

      public boolean isCalendarSearchEnabled()

      isCalendarSearchEnabled.

      Returns:
      a boolean.

    • getStaticQuerySuffix

      public String getStaticQuerySuffix()

      getStaticQuerySuffix.

      Returns:
      a String object.

    • getPreviousVersionIdentifierField

      public String getPreviousVersionIdentifierField()

      getPreviousVersionIdentifierField.

      Returns:
      a String object.

    • getNextVersionIdentifierField

      public String getNextVersionIdentifierField()

      getNextVersionIdentifierField.

      Returns:
      a String object.

    • getVersionLabelField

      public String getVersionLabelField()

      getVersionLabelField.

      Returns:
      a String object.

    • getIndexedMetsFolder

      public String getIndexedMetsFolder()

      getIndexedMetsFolder.

      Returns:
      a String object.

    • getIndexedLidoFolder

      public String getIndexedLidoFolder()

      getIndexedLidoFolder.

      Returns:
      a String object.

    • getIndexedEadFolder

      public String getIndexedEadFolder()

      getIndexedEadFolder.

      Returns:
      a String object.

    • getIndexedDenkxwebFolder

      public String getIndexedDenkxwebFolder()

      getIndexedDenkxwebFolder.

      Returns:
      a String object.

    • getIndexedDublinCoreFolder

      public String getIndexedDublinCoreFolder()

      getIndexedDublinCoreFolder.

      Returns:
      a String object.

    • getPageSelectionFormat

      public String getPageSelectionFormat()

      getPageSelectionFormat.

      Returns:
      a String object.

    • getMediaFolder

      public String getMediaFolder()

      getMediaFolder.

      Returns:
      a String object.

    • getPdfFolder

      public String getPdfFolder()

      getPdfFolder.

      Returns:
      a String object.

    • getVocabulariesFolder

      public String getVocabulariesFolder()

      getVocabulariesFolder.

      Returns:
      a String object.

    • getOrigContentFolder

      public String getOrigContentFolder()

      getOrigContentFolder.

      Returns:
      a String object.

    • getCmsMediaFolder

      public String getCmsMediaFolder()

      getCmsMediaFolder.

      Returns:
      a String object.

    • getCmsTextFolder

      public String getCmsTextFolder()

      getCmsTextFolder.

      Returns:
      a String object.

    • getAltoFolder

      public String getAltoFolder()

      getAltoFolder.

      Returns:
      a String object.

    • getAltoCrowdsourcingFolder

      public String getAltoCrowdsourcingFolder()

      getAltoCrowdsourcingFolder.

      Returns:
      a String object.

    • getAbbyyFolder

      public String getAbbyyFolder()

      getAbbyyFolder.

      Returns:
      a String object.

    • getFulltextFolder

      public String getFulltextFolder()

      getFulltextFolder.

      Returns:
      a String object.

    • getFulltextCrowdsourcingFolder

      public String getFulltextCrowdsourcingFolder()

      getFulltextCrowdsourcingFolder.

      Returns:
      a String object.

    • getTeiFolder

      public String getTeiFolder()

      getTeiFolder.

      Returns:
      a String object.

    • getCmdiFolder

      public String getCmdiFolder()

      getCmdiFolder.

      Returns:
      a String object.

    • getAnnotationFolder

      public String getAnnotationFolder()

      getAnnotationFolder.

      Returns:
      a String object.

    • getHotfolder

      public String getHotfolder()

      getHotfolder.

      Returns:
      a String object.

    • getTempFolder

      public String getTempFolder()

      getTempFolder.

      Returns:
      a String object.

    • getUrnResolverFields

      public List<String> getUrnResolverFields()
      Returns:
      Configured values

    • isUrnDoRedirect

      public boolean isUrnDoRedirect()

      isUrnDoRedirect.

      Returns:
      a boolean.

    • isUserRegistrationEnabled

      public boolean isUserRegistrationEnabled()

      isUserRegistrationEnabled.

      Returns:
      a boolean.

    • getSecurityQuestions

      public List<SecurityQuestion> getSecurityQuestions()
      Returns:
      Configured values

    • isShowOpenIdConnect

      public boolean isShowOpenIdConnect()

      isShowOpenIdConnect.

      Returns:
      a boolean.

    • getAuthenticationProviders

      public List<IAuthenticationProvider> getAuthenticationProviders()

      getAuthenticationProviders.

      Returns:
      a List object.

    • getSmtpServer

      public String getSmtpServer()

      getSmtpServer.

      Returns:
      a String object.

    • getSmtpUser

      public String getSmtpUser()

      getSmtpUser.

      Returns:
      a String object.

    • getSmtpPassword

      public String getSmtpPassword()

      getSmtpPassword.

      Returns:
      a String object.

    • getSmtpSenderAddress

      public String getSmtpSenderAddress()

      getSmtpSenderAddress.

      Returns:
      a String object.

    • getSmtpSenderName

      public String getSmtpSenderName()

      getSmtpSenderName.

      Returns:
      a String object.

    • getSmtpSecurity

      public String getSmtpSecurity()

      getSmtpSecurity.

      Returns:
      a String object.

    • getSmtpPort

      public int getSmtpPort()
      Returns:
      Configured SMTP port number; -1 if not configured

    • isDisplayCollectionBrowsing

      public boolean isDisplayCollectionBrowsing()

      isDisplayCollectionBrowsing.

      Returns:
      a boolean.

    • isDisplayUserNavigation

      public boolean isDisplayUserNavigation()

      isDisplayUserNavigation.

      Returns:
      a boolean.

    • isDisplayTagCloudNavigation

      public boolean isDisplayTagCloudNavigation()

      isDisplayTagCloudNavigation.

      Returns:
      a boolean.

    • isDisplayStatistics

      public boolean isDisplayStatistics()

      isDisplayStatistics.

      Returns:
      a boolean.

    • isDisplayTimeMatrix

      public boolean isDisplayTimeMatrix()

      isDisplayTimeMatrix.

      Returns:
      a boolean.

    • isDisplayCrowdsourcingModuleLinks

      public boolean isDisplayCrowdsourcingModuleLinks()

      isDisplayCrowdsourcingModuleLinks.

      Returns:
      a boolean.

    • getTheme

      public String getTheme()

      getTheme.

      Returns:
      a String object.

    • getThemeRootPath

      public String getThemeRootPath()

      getThemeRootPath.

      Returns:
      a String object.

    • getName

      public String getName()

      getName.

      Returns:
      a String object.

    • getDescription

      public String getDescription()

      getDescription.

      Returns:
      a String object.

    • isDisplayTagCloudStartpage

      public boolean isDisplayTagCloudStartpage()
      Returns:
      a boolean.

    • isDisplaySearchResultNavigation

      public boolean isDisplaySearchResultNavigation()

      isDisplaySearchResultNavigation.

      Returns:
      a boolean.

    • isFoldout

      public boolean isFoldout(String sidebarElement)

      isFoldout.

      Parameters:
      sidebarElement - a String object.
      Returns:
      a boolean.

    • isSidebarViewsWidgetObjectViewLinkVisible

      public boolean isSidebarViewsWidgetObjectViewLinkVisible()

      isSidebarViewsWidgetObjectViewLinkVisible.

      Returns:
      a boolean.

    • isSidebarViewsWidgetCalendarViewLinkVisible

      public boolean isSidebarViewsWidgetCalendarViewLinkVisible()

      isSidebarViewsWidgetCalendarViewLinkVisible.

      Returns:
      a boolean.

    • isSidebarViewsWidgetTocViewLinkVisible

      public boolean isSidebarViewsWidgetTocViewLinkVisible()

      This method checks whether the TOC link in the sidebar views widget is enabled. To check whether the sidebar TOC widget is enabled, use isSidebarTocVisible().

      Returns:
      a boolean.

    • isSidebarViewsWidgetThumbsViewLinkVisible

      public boolean isSidebarViewsWidgetThumbsViewLinkVisible()

      isSidebarViewsWidgetThumbsViewLinkVisible.

      Returns:
      a boolean.

    • isSidebarViewsWidgetMetadataViewLinkVisible

      public boolean isSidebarViewsWidgetMetadataViewLinkVisible()

      isSidebarViewsWidgetMetadataViewLinkVisible.

      Returns:
      a boolean.

    • isSidebarViewsWidgetFulltextLinkVisible

      public boolean isSidebarViewsWidgetFulltextLinkVisible()

      isSidebarViewsWidgetFulltextLinkVisible.

      Returns:
      a boolean.

    • isSidebarViewsWidgetOpacLinkVisible

      public boolean isSidebarViewsWidgetOpacLinkVisible()

      isSidebarViewsWidgetOpacLinkVisible.

      Returns:
      a boolean.

    • isSearchInItemOnlyIfFullTextAvailable

      public boolean isSearchInItemOnlyIfFullTextAvailable()

      isSearchInItemOnlyIfFullTextAvailable.

      Returns:
      a boolean.

    • isSidebarTocWidgetVisibleInFullscreen

      public boolean isSidebarTocWidgetVisibleInFullscreen()

      This method checks whether the TOC widget is enabled. To check whether the sidebar TOC link in the views widget is enabled, use isSidebarTocVisible().

      Returns:
      a boolean.

    • getSidebarTocPageNumbersVisible

      public boolean getSidebarTocPageNumbersVisible()

      getSidebarTocPageNumbersVisible.

      Returns:
      a boolean.

    • getSidebarTocLengthBeforeCut

      public int getSidebarTocLengthBeforeCut()

      getSidebarTocLengthBeforeCut.

      Returns:
      a int.

    • getSidebarTocInitialCollapseLevel

      public int getSidebarTocInitialCollapseLevel()

      getSidebarTocInitialCollapseLevel.

      Returns:
      a int.

    • getSidebarTocCollapseLengthThreshold

      public int getSidebarTocCollapseLengthThreshold()

      getSidebarTocCollapseLengthThreshold.

      Returns:
      a int.

    • getSidebarTocLowestLevelToCollapseForLength

      public int getSidebarTocLowestLevelToCollapseForLength()

      getSidebarTocLowestLevelToCollapseForLength.

      Returns:
      a int.

    • isSidebarTocTreeView

      public boolean isSidebarTocTreeView()

      isSidebarTocTreeView.

      Returns:
      a boolean.

    • isTocTreeView

      public boolean isTocTreeView(String docStructType)

      isTocTreeView.

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

    • isDisplaySidebarBrowsingTerms

      public boolean isDisplaySidebarBrowsingTerms()

      isDisplaySidebarBrowsingTerms.

      Returns:
      a boolean.

    • isSidebarRssFeedWidgetEnabled

      public boolean isSidebarRssFeedWidgetEnabled()

      isSidebarRssFeedWidgetEnabled.

      Returns:
      a boolean.

    • getAllFacetFields

      public List<String> getAllFacetFields()

      Returns a list containing all simple facet fields.

      Returns:
      a List object.

    • getRegularFacetFields

      public List<String> getRegularFacetFields()
      Returns:
      Configured values

    • getBooleanFacetFields

      public List<String> getBooleanFacetFields()

      getBooleanFacetFields.

      Returns:
      a List object.

    • getHierarchicalFacetFields

      public List<String> getHierarchicalFacetFields()

      getHierarchicalFacetFields.

      Returns:
      a List object.

    • getRangeFacetFields

      public List<String> getRangeFacetFields()

      getRangeFacetFields.

      Returns:
      List of facet fields to be used as range values

    • getRangeFacetFieldMinValue

      public int getRangeFacetFieldMinValue(String facetField)
      Parameters:
      facetField -
      Returns:
      Configured value

    • getRangeFacetFieldMaxValue

      public int getRangeFacetFieldMaxValue(String facetField)
      Parameters:
      facetField -
      Returns:
      Configured value

    • getFacetFieldStyle

      public String getFacetFieldStyle(String facetField)
      Parameters:
      facetField -
      Returns:
      Configured value

    • getGeoFacetFields

      public List<String> getGeoFacetFields()

      getGeoFacetFields.

      Returns:
      a List object.

    • getGeoFacetFieldPredicate

      public String getGeoFacetFieldPredicate(String facetField)
      Parameters:
      facetField -
      Returns:
      Configured value

    • isShowSearchHitsInGeoFacetMap

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

    • getInitialFacetElementNumber

      public int getInitialFacetElementNumber(String facetField)

      getInitialFacetElementNumber.

      Parameters:
      facetField - a String object.
      Returns:
      Number of initial facet values

    • getFacetFieldDescriptionKey

      public String getFacetFieldDescriptionKey(String facetField)

      getFacetFieldDescriptionKey.

      Parameters:
      facetField - a String object.
      Returns:
      Optional description message key

    • getSortOrder

      public String getSortOrder(String facetField)

      getSortOrder.

      Parameters:
      facetField - a String object.
      Returns:
      a String object.

    • getPriorityValuesForFacetField

      public List<String> getPriorityValuesForFacetField(String field)
      Returns a list of values to prioritize for the given facet field.
      Parameters:
      field - a String object.
      Returns:
      List of priority values; empty list if none found for the given field

    • getLabelFieldForFacetField

      public String getLabelFieldForFacetField(String facetField)
      Parameters:
      facetField -
      Returns:
      Configured value

    • isTranslateFacetFieldLabels

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

    • getGroupToLengthForFacetField

      public int getGroupToLengthForFacetField(String facetField)
      Parameters:
      facetField -
      Returns:
      Configured value

    • isAlwaysApplyFacetFieldToUnfilteredHits

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

    • isFacetFieldSkipInWidget

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

    • isFacetFieldDisplayValueFilter

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

    • getFacetFieldType

      public String getFacetFieldType(String facetField)
      Parameters:
      facetField -
      Returns:
      Configured value

    • getMultiValueOperatorForField

      public String getMultiValueOperatorForField(String facetField)
      Parameters:
      facetField -
      Returns:
      Configured value

    • isSortingEnabled

      public boolean isSortingEnabled()

      isSortingEnabled.

      Returns:
      a boolean.

    • getDefaultSortField

      public String getDefaultSortField(String language)

      getDefaultSortField.

      Parameters:
      language -
      Returns:
      a String object.

    • getSortFields

      public List<String> getSortFields()

      getSortFields.

      Returns:
      a List object.

    • getSearchSortingOptions

      public List<SearchSortingOption> getSearchSortingOptions(String language)
      Parameters:
      language -
      Returns:
      List of SearchSortingOptions from configured sorting fields

    • getStaticSortFields

      public List<String> getStaticSortFields()

      getStaticSortFields.

      Returns:
      a List object.

    • getSearchSortingKeyAscending

      public Optional<String> getSearchSortingKeyAscending(String field)
      Parameters:
      field -
      Returns:
      Configured value

    • getSearchSortingKeyDescending

      public Optional<String> getSearchSortingKeyDescending(String field)
      Parameters:
      field -
      Returns:
      Configured value

    • getUrnResolverUrl

      public String getUrnResolverUrl()

      getUrnResolverUrl.

      Returns:
      a String object.

    • getThumbnailImageAccessMaxWidth

      public int getThumbnailImageAccessMaxWidth()
      The maximal image size retrievable with only the permission to view thumbnails
      Returns:
      the maximal image width

    • getUnzoomedImageAccessMaxWidth

      public int getUnzoomedImageAccessMaxWidth()
      The maximal image size retrievable with the permission to view images but without the permission to zoom images
      Returns:
      the maximal image width, default ist 600

    • isFullAccessForLocalhost

      public boolean isFullAccessForLocalhost()

      isFullAccessForLocalhost.

      Returns:
      a boolean.

    • isGeneratePdfInMessageQueue

      public boolean isGeneratePdfInMessageQueue()

      isGeneratePdfInMessageQueue.

      Returns:
      a boolean.

    • isPdfApiDisabled

      public boolean isPdfApiDisabled()

      isPdfApiDisabled.

      Returns:
      a boolean.

    • isTitlePdfEnabled

      public boolean isTitlePdfEnabled()

      isTitlePdfEnabled.

      Returns:
      a boolean.

    • isTocPdfEnabled

      public boolean isTocPdfEnabled()

      isTocPdfEnabled.

      Returns:
      a boolean.

    • isMetadataPdfEnabled

      public boolean isMetadataPdfEnabled()

      isMetadataPdfEnabled.

      Returns:
      a boolean.

    • isPagePdfEnabled

      public boolean isPagePdfEnabled()

      isPagePdfEnabled.

      Returns:
      a boolean.

    • isDocHierarchyPdfEnabled

      public boolean isDocHierarchyPdfEnabled()

      isDocHierarchyPdfEnabled.

      Returns:
      a boolean.

    • isTitleEpubEnabled

      public boolean isTitleEpubEnabled()

      isTitleEpubEnabled.

      Returns:
      a boolean.

    • isTocEpubEnabled

      public boolean isTocEpubEnabled()

      isTocEpubEnabled.

      Returns:
      a boolean.

    • isMetadataEpubEnabled

      public boolean isMetadataEpubEnabled()

      isMetadataEpubEnabled.

      Returns:
      a boolean.

    • getDownloadFolder

      public String getDownloadFolder(String type)

      getDownloadFolder.

      Parameters:
      type - a String object.
      Returns:
      a String object.

    • getExternalResourceUrlTemplates

      public List<String> getExternalResourceUrlTemplates()

    • getExternalResourceTimeBeforeDeletion

      public Duration getExternalResourceTimeBeforeDeletion()

    • getRssFeedItems

      public int getRssFeedItems()

      getRssFeedItems.

      Returns:
      a int.

    • getRssTitle

      public String getRssTitle()

      getRssTitle.

      Returns:
      a String object.

    • getRssDescription

      public String getRssDescription()

      getRssDescription.

      Returns:
      a String object.

    • getRssCopyrightText

      public String getRssCopyrightText()

      getRssCopyrightText.

      Returns:
      a String object.

    • getThumbnailsWidth

      public int getThumbnailsWidth()

      getThumbnailsWidth.

      Returns:
      a int.

    • getThumbnailsHeight

      public int getThumbnailsHeight()

      getThumbnailsHeight.

      Returns:
      a int.

    • getAnchorThumbnailMode

      public String getAnchorThumbnailMode()

      getAnchorThumbnailMode.

      Returns:
      a String object.

    • getDisplayBreadcrumbs

      public boolean getDisplayBreadcrumbs()

      getDisplayBreadcrumbs.

      Returns:
      a boolean.

    • getDisplayMetadataPageLinkBlock

      public boolean getDisplayMetadataPageLinkBlock()

      getDisplayMetadataPageLinkBlock.

      Returns:
      a boolean.

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

    • useTiles

      public boolean useTiles(PageType view, String imageMimeType) throws ViewerConfigurationException

      useTiles.

      Parameters:
      view - a PageType object.
      imageMimeType - the mimetype to which the configuration should apply.
      Returns:
      a boolean.
      Throws:
      ViewerConfigurationException - if any.

    • showImageNavigator

      public boolean showImageNavigator(PageType view, String imageMimeType) throws ViewerConfigurationException
      whether to show a navigator element in the openseadragon viewe
      Parameters:
      view - get settings for this pageType
      imageMimeType - the mimetype to which the configuration should apply.
      Returns:
      true if navigator should be shown
      Throws:
      ViewerConfigurationException

    • showImageThumbnailGallery

      public boolean showImageThumbnailGallery(PageType view, String imageMimeType) throws ViewerConfigurationException
      Throws:
      ViewerConfigurationException

    • getFooterHeight

      public int getFooterHeight() throws ViewerConfigurationException

      getFooterHeight.

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

    • getFullscreenFooterHeight

      public int getFullscreenFooterHeight() throws ViewerConfigurationException

      getFullscreenFooterHeight.

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

    • getFooterHeight

      public int getFooterHeight(PageType view, String imageMimeType) throws ViewerConfigurationException

      getFooterHeight.

      Parameters:
      view - a PageType object.
      imageMimeType - the mimetype to which the configuration should apply.
      Returns:
      a int.
      Throws:
      ViewerConfigurationException - if any.

    • getImageViewZoomScales

      public List<String> getImageViewZoomScales() throws ViewerConfigurationException

      getImageViewZoomScales.

      Returns:
      a List object.
      Throws:
      ViewerConfigurationException - if any.

    • getImageViewZoomScales

      public List<String> getImageViewZoomScales(String view) throws ViewerConfigurationException

      getImageViewZoomScales.

      Parameters:
      view - a String object.
      Returns:
      a List object.
      Throws:
      ViewerConfigurationException - if any.

    • getImageViewZoomScales

      public List<String> getImageViewZoomScales(PageType view, String imageMimeType) throws ViewerConfigurationException

      getImageViewZoomScales.

      Parameters:
      view - a PageType object.
      imageMimeType - the mimetype to which the configuration should apply.
      Returns:
      a List object.
      Throws:
      ViewerConfigurationException - if any.

    • getTileSizes

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

      getTileSizes.

      Returns:
      the configured tile sizes for imageView as a hashmap linking each tile size to the list of resolutions to use with that size
      Throws:
      ViewerConfigurationException - if any.

    • getTileSizes

      public Map<Integer,List<Integer>> getTileSizes(PageType view, String imageMimeType) throws ViewerConfigurationException

      getTileSizes.

      Parameters:
      view - a PageType object.
      imageMimeType - the mimetype to which the configuration should apply.
      Returns:
      a Map object.
      Throws:
      ViewerConfigurationException - if any.

    • getZoomImageViewConfig

      public org.apache.commons.configuration2.BaseHierarchicalConfiguration getZoomImageViewConfig(PageType pageType, String imageMimeType) throws ViewerConfigurationException

      getZoomImageViewConfig.

      Parameters:
      pageType - a PageType object.
      imageMimeType - the mimetype to which the configuration should apply.
      Returns:
      a SubnodeConfiguration object.
      Throws:
      ViewerConfigurationException - if any.

    • getBreadcrumbsClipping

      public int getBreadcrumbsClipping()

      getBreadcrumbsClipping.

      Returns:
      a int.

    • getDisplayStructType

      public boolean getDisplayStructType()

      getDisplayStructType.

      Returns:
      a boolean.

    • getSearchHitMetadataValueNumber

      public int getSearchHitMetadataValueNumber()

      getSearchHitMetadataValueNumber.

      Returns:
      a int.

    • getSearchHitMetadataValueLength

      public int getSearchHitMetadataValueLength()

      getSearchHitMetadataValueLength.

      Returns:
      a int.

    • isWatermarkTextConfigurationEnabled

      public boolean isWatermarkTextConfigurationEnabled()
      Returns:
      true if enabled or not configured; false otherwise

    • getWatermarkTextConfiguration

      public List<String> getWatermarkTextConfiguration()
      Returns the preference order of data to be used as an image footer text.
      Returns:
      a List object.

    • getWatermarkFormat

      public String getWatermarkFormat()

      getWatermarkFormat.

      Returns:
      a String object.

    • getStopwordsFilePath

      public String getStopwordsFilePath()

      getStopwordsFilePath.

      Returns:
      a String object.

    • getPageType

      public String getPageType(PageType type)
      Returns the locally configured page type name for URLs (e.g. "bild" instead of default "image").
      Parameters:
      type - a PageType object.
      Returns:
      a String object.

    • getRecordTargetPageType

      public String getRecordTargetPageType(String publicationType)

      getRecordTargetPageType.

      Parameters:
      publicationType - a String object.
      Returns:
      a String object.

    • getPageTypeExitView

      public String getPageTypeExitView(PageType type)

    • getFulltextPercentageWarningThreshold

      public int getFulltextPercentageWarningThreshold()

      getFulltextPercentageWarningThreshold.

      Returns:
      a int.

    • getFallbackDefaultLanguage

      public String getFallbackDefaultLanguage()
      Returns:
      Configured value

    • getFeedbackEmailRecipients

      public List<EmailRecipient> getFeedbackEmailRecipients()

      getFeedbackEmailAddresses.

      Returns:
      a String object.

    • getDefaultFeedbackEmailAddress

      public String getDefaultFeedbackEmailAddress()
      Returns:
      Configured value

    • isBookmarksEnabled

      public boolean isBookmarksEnabled()

      isBookmarksEnabled.

      Returns:
      a boolean.

    • getPageLoaderThreshold

      public int getPageLoaderThreshold()

      getPageLoaderThreshold.

      Returns:
      a int.

    • isPreventProxyCaching

      public boolean isPreventProxyCaching()

      isPreventProxyCaching.

      Returns:
      a boolean.

    • getDatabaseConnectionAttempts

      public int getDatabaseConnectionAttempts()

      getDatabaseConnectionAttempts.

      Returns:
      a int.

    • reviewEnabledForComments

      public boolean reviewEnabledForComments()
      Returns:
      Configured value

    • getViewerHome

      public String getViewerHome()

      getViewerHome.

      Returns:
      a String object.

    • getWatermarkIdField

      public List<String> getWatermarkIdField()

      getWatermarkIdField.

      Returns:
      a List object.

    • isDocstructNavigationEnabled

      public boolean isDocstructNavigationEnabled()
      Returns:
      Configured value

    • getDocstructNavigationTypes

      public List<String> getDocstructNavigationTypes(String template, boolean fallbackToDefaultTemplate)
      Parameters:
      template -
      fallbackToDefaultTemplate -
      Returns:
      Configured value

    • getSubthemeMainTheme

      public String getSubthemeMainTheme()

      getSubthemeMainTheme.

      Returns:
      a String object.

    • getSubthemeDiscriminatorField

      public String getSubthemeDiscriminatorField()

      getSubthemeDiscriminatorField.

      Returns:
      a String object.

    • getTagCloudSampleSize

      public int getTagCloudSampleSize(String fieldName)

      getTagCloudSampleSize.

      Parameters:
      fieldName - a String object.
      Returns:
      a int.

    • getTocVolumeSortFieldsForTemplate

      public List<StringPair> getTocVolumeSortFieldsForTemplate(String template)

      getTocVolumeSortFieldsForTemplate.

      Parameters:
      template - a String object.
      Returns:
      a List object.

    • getTocVolumeGroupFieldForTemplate

      public String getTocVolumeGroupFieldForTemplate(String template)
      Returns the grouping Solr field for the given anchor TOC sort configuration.
      Parameters:
      template - a String object.
      Returns:
      a String object.

    • getDisplayTitleBreadcrumbs

      public boolean getDisplayTitleBreadcrumbs()

      getDisplayTitleBreadcrumbs.

      Returns:
      a boolean.

    • isDisplayTitlePURL

      public boolean isDisplayTitlePURL()

      isDisplayTitlePURL.

      Returns:
      a boolean.

    • getTitleBreadcrumbsMaxTitleLength

      public int getTitleBreadcrumbsMaxTitleLength()

      getTitleBreadcrumbsMaxTitleLength.

      Returns:
      a int.

    • getIncludeAnchorInTitleBreadcrumbs

      public boolean getIncludeAnchorInTitleBreadcrumbs()

      getIncludeAnchorInTitleBreadcrumbs.

      Returns:
      a boolean.

    • isDisplaySearchRssLinks

      public boolean isDisplaySearchRssLinks()

      isDisplaySearchRssLinks.

      Returns:
      a boolean.

    • getStartYearForTimeline

      public String getStartYearForTimeline()

      getStartYearForTimeline.

      Returns:
      a String object.

    • getEndYearForTimeline

      public String getEndYearForTimeline()

      getEndYearForTimeline.

      Returns:
      a String object.

    • getTimelineHits

      public String getTimelineHits()

      getTimelineHits.

      Returns:
      a String object.

    • isPiwikTrackingEnabled

      public boolean isPiwikTrackingEnabled()

      isPiwikTrackingEnabled.

      Returns:
      a boolean.

    • getPiwikBaseURL

      public String getPiwikBaseURL()

      getPiwikBaseURL.

      Returns:
      a String object.

    • getPiwikSiteID

      public String getPiwikSiteID()

      getPiwikSiteID.

      Returns:
      a String object.

    • isSearchSavingEnabled

      public boolean isSearchSavingEnabled()

      isSearchSavingEnabled.

      Returns:
      a boolean.

    • getRecordGroupIdentifierFields

      public List<String> getRecordGroupIdentifierFields()

      getRecordGroupIdentifierFields.

      Returns:
      a List object.

    • getAncestorIdentifierFields

      public List<String> getAncestorIdentifierFields()

      getAncestorIdentifierFields.

      Returns:
      a List object.

    • isTocListSiblingRecords

      public boolean isTocListSiblingRecords()

      isTocListSiblingRecords.

      Returns:
      a boolean.

    • getAncestorIdentifierFieldFilterQuery

      public String getAncestorIdentifierFieldFilterQuery(String field)

      getAncestorIdentifierFieldFilterQuery(String).

      Parameters:
      field -
      Returns:
      Configured filter query for the given field; empty string is none found

    • getSearchFilters

      public List<SearchFilter> getSearchFilters()

      getSearchFilters.

      Returns:
      a List object.

    • getDefaultSearchFilter

      public SearchFilter getDefaultSearchFilter()
      Returns:
      Configured value

    • getWebApiFields

      public JsonMetadataConfiguration getWebApiFields(String template)

      getWebApiFields.

      Parameters:
      template -
      Returns:
      JsonMetadataConfiguration

    • getDbPersistenceUnit

      public String getDbPersistenceUnit()

      getDbPersistenceUnit.

      Returns:
      a String object.

    • getTempMediaFolder

      public String getTempMediaFolder()
      A folder for temporary storage of media files. Used by DC record creation to store uploaded files
      Returns:
      "temp_media" unless otherwise configured in "tempMediaFolder"

    • getUserAvatarFolder

      public String getUserAvatarFolder()

    • getCmsMediaDisplayWidth

      public int getCmsMediaDisplayWidth()

      getCmsMediaDisplayWidth.

      Returns:
      a int.

    • getCmsMediaDisplayHeight

      public int getCmsMediaDisplayHeight()

      getCmsMediaDisplayHeight. If not configured, return 100.000. In this case the actual image size always depends on the requested width

      Returns:
      a int.

    • isTranskribusEnabled

      public boolean isTranskribusEnabled()

      isTranskribusEnabled.

      Returns:
      a boolean.

    • getTranskribusUserName

      public String getTranskribusUserName()

      getTranskribusUserName.

      Returns:
      a String object.

    • getTranskribusPassword

      public String getTranskribusPassword()

      getTranskribusPassword.

      Returns:
      a String object.

    • getTranskribusDefaultCollection

      public String getTranskribusDefaultCollection()

      getTranskribusDefaultCollection.

      Returns:
      a String object.

    • getTranskribusRestApiUrl

      public String getTranskribusRestApiUrl()

      getTranskribusRestApiUrl.

      Returns:
      a String object.

    • getTranskribusAllowedDocumentTypes

      public List<String> getTranskribusAllowedDocumentTypes()

      getTranskribusAllowedDocumentTypes.

      Returns:
      a List object.

    • getTocIndentation

      public int getTocIndentation()

      getTocIndentation.

      Returns:
      a int.

    • isPageBrowseEnabled

      public boolean isPageBrowseEnabled()

      isPageBrowseEnabled.

      Returns:
      a boolean.

    • getPageBrowseSteps

      public List<Integer> getPageBrowseSteps()

      getPageBrowseSteps.

      Returns:
      a List object.

    • getPageSelectDropdownDisplayMinPages

      public int getPageSelectDropdownDisplayMinPages()
      Returns:
      Configured value

    • getWorkflowRestUrl

      public String getWorkflowRestUrl()

      getWorkflowRestUrl.

      Returns:
      The url to the Goobi workflow REST API as configured in the config_viewer. The url always ends with "/"

    • getTaskManagerServiceUrl

      @Deprecated(since="24.10") public String getTaskManagerServiceUrl()
      Deprecated.
      currently unused since download jobs are handled via message queues

      getTaskManagerServiceUrl.

      Returns:
      a String object.

    • getTaskManagerRestUrl

      @Deprecated(since="24.10") public String getTaskManagerRestUrl()
      Deprecated.
      jobs are no longs handled via TaskManager but via queues

      getTaskManagerRestUrl.

      Returns:
      a String object.

    • getReCaptchaSiteKey

      public String getReCaptchaSiteKey()

      getReCaptchaSiteKey.

      Returns:
      a String object.

    • isUseReCaptcha

      public boolean isUseReCaptcha()

      isUseReCaptcha.

      Returns:
      a boolean.

    • isSearchRisExportEnabled

      public boolean isSearchRisExportEnabled()

      isSearchRisExportEnabled.

      Returns:
      a boolean.

    • isSearchExcelExportEnabled

      public boolean isSearchExcelExportEnabled()

      isSearchExcelExportEnabled.

      Returns:
      a boolean.

    • getSearchExcelExportFields

      public List<ExportFieldConfiguration> getSearchExcelExportFields()

      getSearchExcelExportFields.

      Returns:
      a List object.

    • getExcelDownloadTimeout

      public int getExcelDownloadTimeout()

      getExcelDownloadTimeout.

      Returns:
      a int.

    • isDoublePageNavigationEnabled

      public boolean isDoublePageNavigationEnabled(PageType pageType, String imageMimeType) throws ViewerConfigurationException
      Return true if double page navigation is enabled for the given PageType and ImageType. Default is false
      Parameters:
      pageType - The type of viewer page to which the configuration should apply
      imageMimeType - the mimetype to which the configuration should apply.
      Returns:
      a boolean.
      Throws:
      ViewerConfigurationException

    • isDoublePageNavigationDefault

      public boolean isDoublePageNavigationDefault(PageType pageType, String imageMimeType) throws ViewerConfigurationException
      Return true if double page navigation should be used per default for the given PageType and ImageType. Default is false
      Parameters:
      pageType - The type of viewer page to which the configuration should apply
      imageMimeType - the mimetype to which the configuration should apply.
      Returns:
      a boolean.
      Throws:
      ViewerConfigurationException

    • isSequencePageNavigationEnabled

      public boolean isSequencePageNavigationEnabled(PageType pageType, String imageMimeType) throws ViewerConfigurationException
      Return true if sequence page navigation is enabled for the given PageType and ImageType. Default is false
      Parameters:
      pageType - The type of viewer page to which the configuration should apply
      imageMimeType - the mimetype to which the configuration should apply.
      Returns:
      a boolean.
      Throws:
      ViewerConfigurationException

    • getRestrictedImageUrls

      public List<String> getRestrictedImageUrls()

      getRestrictedImageUrls.

      Returns:
      a List object.

    • getIIIFLicenses

      public List<String> getIIIFLicenses()

    • useExternalManifestUrls

      public boolean useExternalManifestUrls()

    • getExternalManifestSolrField

      public String getExternalManifestSolrField()

    • getIIIFMetadataFields

      public List<String> getIIIFMetadataFields()

      getIIIFMetadataFields.

      Returns:
      a List object.

    • getIIIFEventFields

      public List<String> getIIIFEventFields()

      getIIIFEventFields.

      Returns:
      the list of all configured event fields for IIIF manifests All fields must contain a "/" to separate the event type and the actual field name If no "/" is present in the configured field it is prepended to the entry to indicate that this field should be taken from all events

    • getIIIFMetadataLabel

      public String getIIIFMetadataLabel(String field)

      getIIIFMetadataLabel.

      Parameters:
      field - the value of the field
      Returns:
      The attribute "label" of any children of webapi.iiif.metadataFields

    • getIIIFDiscoveryAvtivitiesPerPage

      public int getIIIFDiscoveryAvtivitiesPerPage()
      Configured in webapi.iiif.discovery.activitiesPerPage. Default value is 100
      Returns:
      The number of activities to display per collection page in the IIIF discovery api

    • getIIIFLogo

      public List<String> getIIIFLogo()

      getIIIFLogo.

      Returns:
      a String object.

    • getIIIFNavDateField

      public String getIIIFNavDateField()

      getIIIFNavDateField.

      Returns:
      a String object.

    • getIIIFAttribution

      public List<String> getIIIFAttribution()

      getIIIFAttribution.

      Returns:
      a String object.

    • getIIIFDescriptionFields

      public List<String> getIIIFDescriptionFields()

      getIIIFDescriptionFields.

      Returns:
      a List object.

    • getIIIFLabelFields

      public List<String> getIIIFLabelFields()

    • getIIIFTranslationLocales

      public List<Locale> getIIIFTranslationLocales()

    • getIIIFRightsField

      public String getIIIFRightsField()
      Returns:
      The SOLR field containing a rights url for a IIIF3 manifest if one is configured

    • getIIIFRequiredValue

      public String getIIIFRequiredValue()
      Uses getIIIFAttribution() as fallback;
      Returns:
      the message key to use for the IIIF3 requiredStatement value if the statement should be added to manifests.

    • getIIIFRequiredLabel

      public String getIIIFRequiredLabel()
      Returns:
      the message key to use for the IIIF3 requiredStatement label. Default is "Attribution"

    • getIIIFProvider

      public List<ProviderConfiguration> getIIIFProvider() throws PresentationException
      Returns:
      The list of configurations for IIIF3 providers
      Throws:
      PresentationException - if a provider or a homepage configuration misses the url or label element

    • getIIIFProvider

      public List<ProviderConfiguration> getIIIFProvider(VariableReplacer vr) throws PresentationException
      Parameters:
      vr - VariableReplacer
      Returns:
      The list of configurations for IIIF3 providers
      Throws:
      PresentationException - if a provider or a homepage configuration misses the url or label element

    • isVisibleIIIFRenderingPDF

      public boolean isVisibleIIIFRenderingPDF()
      Returns:
      Configured value

    • isVisibleIIIFRenderingViewer

      public boolean isVisibleIIIFRenderingViewer()
      Returns:
      Configured value

    • getLabelIIIFRenderingPDF

      public String getLabelIIIFRenderingPDF()

    • getLabelIIIFRenderingViewer

      public String getLabelIIIFRenderingViewer()

    • isVisibleIIIFRenderingPlaintext

      public boolean isVisibleIIIFRenderingPlaintext()
      Returns:
      Configured value

    • isVisibleIIIFRenderingAlto

      public boolean isVisibleIIIFRenderingAlto()
      Returns:
      Configured value

    • getLabelIIIFRenderingPlaintext

      public String getLabelIIIFRenderingPlaintext()

    • getLabelIIIFRenderingAlto

      public String getLabelIIIFRenderingAlto()

    • isVisibleIIIFSeeAlsoMets

      public boolean isVisibleIIIFSeeAlsoMets()

    • getLabelIIIFSeeAlsoMets

      public String getLabelIIIFSeeAlsoMets()

    • isVisibleIIIFSeeAlsoLido

      public boolean isVisibleIIIFSeeAlsoLido()

    • getLabelIIIFSeeAlsoLido

      public String getLabelIIIFSeeAlsoLido()

    • getIIIFSeeAlsoMetadataConfigurations

      public List<ManifestLinkConfiguration> getIIIFSeeAlsoMetadataConfigurations()

    • getSitelinksField

      public String getSitelinksField()

      getSitelinksField.

      Returns:
      a String object.

    • isSitelinksEnabled

      public boolean isSitelinksEnabled()
      Returns:
      Configured value

    • getSitelinksFilterQuery

      public String getSitelinksFilterQuery()

      getSitelinksFilterQuery.

      Returns:
      a String object.

    • getConfiguredCollections

      public List<String> getConfiguredCollections()

      getConfiguredCollections.

      Returns:
      a List object.

    • getWebApiToken

      public String getWebApiToken()

      getWebApiToken.

      Returns:
      a String object.

    • isAllowRedirectCollectionToWork

      public boolean isAllowRedirectCollectionToWork()

      isAllowRedirectCollectionToWork.

      Returns:
      true if opening a collection containing only a single work should redirect to that work

    • getTwitterUserName

      public String getTwitterUserName()

      getTwitterUserName.

      Returns:
      Configured value; null if none configured

    • getLimitImageHeightUpperRatioThreshold

      public float getLimitImageHeightUpperRatioThreshold()

      getLimitImageHeightUpperRatioThreshold.

      Returns:
      a float.

    • getLimitImageHeightLowerRatioThreshold

      public float getLimitImageHeightLowerRatioThreshold()

      getLimitImageHeightLowerRatioThreshold.

      Returns:
      a float.

    • isLimitImageHeight

      public boolean isLimitImageHeight()

      isLimitImageHeight.

      Returns:
      a boolean.

    • isAddCORSHeader

      public boolean isAddCORSHeader()

      isAddCORSHeader.

      Returns:
      a boolean.

    • getCORSHeaderValue

      public String getCORSHeaderValue()

      Gets the value configured in webapi.cors. Default is "*"

      Returns:
      a String object.

    • isDiscloseImageContentLocation

      public boolean isDiscloseImageContentLocation()
      Returns:
      Configured value

    • getCopyrightIndicatorStyle

      public String getCopyrightIndicatorStyle()
      Returns:
      Configured value

    • getCopyrightIndicatorStatusField

      public String getCopyrightIndicatorStatusField()
      Returns:
      Configured value

    • getCopyrightIndicatorStatusForValue

      public CopyrightIndicatorStatus getCopyrightIndicatorStatusForValue(String value)
      Parameters:
      value -
      Returns:
      Configured value

    • getCopyrightIndicatorLicenseForValue

      public CopyrightIndicatorLicense getCopyrightIndicatorLicenseForValue(String value)
      Parameters:
      value -
      Returns:
      Configured value

    • getCopyrightIndicatorLicenseField

      public String getCopyrightIndicatorLicenseField()
      Returns:
      Configured value

    • isDisplaySocialMediaShareLinks

      public boolean isDisplaySocialMediaShareLinks()

    • isDisplayAnchorLabelInTitleBar

      public boolean isDisplayAnchorLabelInTitleBar(String template)

    • getAnchorLabelInTitleBarPrefix

      public String getAnchorLabelInTitleBarPrefix(String template)

    • getAnchorLabelInTitleBarSuffix

      public String getAnchorLabelInTitleBarSuffix(String template)

    • getMapBoxToken

      public String getMapBoxToken()

    • getMapBoxUser

      public String getMapBoxUser()

    • getMapBoxStyleId

      public String getMapBoxStyleId()

    • isDisplayAddressSearchInMap

      public boolean isDisplayAddressSearchInMap()

    • getGeoMapMarker

      public GeoMapMarker getGeoMapMarker(String name)
      Parameters:
      name -
      Returns:
      Configured value

    • getGeoMapMarkerFields

      public List<String> getGeoMapMarkerFields()
      Returns:
      a list of solr field names containing GeoJson data used to create markers in maps

    • useHeatmapForCMSMaps

      public boolean useHeatmapForCMSMaps()

    • useHeatmapForMapSearch

      public boolean useHeatmapForMapSearch()

    • useHeatmapForFacetting

      public boolean useHeatmapForFacetting()

    • getMarkerForMapSearch

      public GeoMapMarker getMarkerForMapSearch()

    • getMarkerForFacetting

      public GeoMapMarker getMarkerForFacetting()

    • getSelectionColorForMapSearch

      public String getSelectionColorForMapSearch()

    • getSelectionColorForFacetting

      public String getSelectionColorForFacetting()

    • includeCoordinateFieldsFromMetadataDocs

      public boolean includeCoordinateFieldsFromMetadataDocs()

    • getGeoMapMarkers

      public List<GeoMapMarker> getGeoMapMarkers()

    • getRecordGeomapMarker

      public String getRecordGeomapMarker(String templateName)

    • readGeoMapMarker

      public static GeoMapMarker readGeoMapMarker(org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> config)
      Parameters:
      config -
      Returns:
      Configured value

    • getLicenseDescriptions

      public List<LicenseDescription> getLicenseDescriptions()
      Returns:
      Configured values

    • getArchivesLazyLoadingThreshold

      public int getArchivesLazyLoadingThreshold()
      Returns:
      Configured value

    • isExpandArchiveEntryOnSelection

      public boolean isExpandArchiveEntryOnSelection()

    • getArchiveNodeTypes

      public Map<String,String> getArchiveNodeTypes()

    • getDefaultArchiveNodeType

      public org.apache.commons.lang3.tuple.Pair<String,String> getDefaultArchiveNodeType()

    • isDisplayUserGeneratedContentBelowImage

      public boolean isDisplayUserGeneratedContentBelowImage()
      Returns:
      a boolean

    • getIIIFVersionToUse

      public String getIIIFVersionToUse()
      config: <iiif use-version="3.0"></iiif>
      Returns:
      Configured value

    • getTranslationGroups

      public List<TranslationGroup> getTranslationGroups()
      Returns:
      Configured value

    • isDisplayAnnotationTextInImage

      public boolean isDisplayAnnotationTextInImage()
      Returns:
      Configured value

    • isUseFacetsAsExpandQuery

      public boolean isUseFacetsAsExpandQuery()
      Returns:
      Configured value

    • getAllowedFacetsForExpandQuery

      public List<String> getAllowedFacetsForExpandQuery()
      Returns:
      Configured values

    • isSearchResultGroupsEnabled

      public boolean isSearchResultGroupsEnabled()
      Returns:
      Configured value

    • getSearchResultGroups

      public List<SearchResultGroup> getSearchResultGroups()
      Returns:
      Configured values

    • isContentUploadEnabled

      public boolean isContentUploadEnabled()
      Returns:
      Configured value

    • getContentUploadToken

      public String getContentUploadToken()
      Returns:
      Configured value

    • getContentUploadDocstruct

      public String getContentUploadDocstruct()
      Returns:
      Configured value

    • getContentUploadTemplateName

      public String getContentUploadTemplateName()
      Returns:
      Configured value

    • getContentUploadRejectionPropertyName

      public String getContentUploadRejectionPropertyName()
      Returns:
      Configured value

    • getContentUploadRejectionReasonPropertyName

      public String getContentUploadRejectionReasonPropertyName()
      Returns:
      Configured value

    • getCrowdsourcingCampaignItemOrder

      public String getCrowdsourcingCampaignItemOrder()

    • getGeomapAnnotationZoom

      public int getGeomapAnnotationZoom()

    • getCrowdsourcingCampaignGeomapZoom

      public int getCrowdsourcingCampaignGeomapZoom()

    • getCrowdsourcingCampaignGeomapLngLat

      public String getCrowdsourcingCampaignGeomapLngLat()

    • getCrowdsourcingCampaignGeomapTilesource

      public String getCrowdsourcingCampaignGeomapTilesource()

    • isStatisticsEnabled

      public boolean isStatisticsEnabled()

    • getCrawlerDetectionRegex

      public String getCrawlerDetectionRegex()

    • isConfigEditorEnabled

      public boolean isConfigEditorEnabled()
      Returns:
      Configured value

    • getConfigEditorBackupFiles

      public int getConfigEditorBackupFiles()
      Returns:
      Configured value

    • getConfigEditorDirectories

      public List<String> getConfigEditorDirectories()
      Returns:
      Configured values

    • isProxyEnabled

      public boolean isProxyEnabled()
      Returns:
      true if enabled; false otherwise

    • getProxyUrl

      public String getProxyUrl()
      Returns:
      Configured value

    • getProxyPort

      public int getProxyPort()
      Returns:
      Configured port number; 0 if none found

    • isHostProxyWhitelisted

      public boolean isHostProxyWhitelisted(String url) throws MalformedURLException, URISyntaxException
      Parameters:
      url -
      Returns:
      Configured value
      Throws:
      MalformedURLException
      URISyntaxException

    • getProxyWhitelist

      public List<String> getProxyWhitelist()
      Returns:
      Configured values

    • isStartInternalMessageBroker

      public boolean isStartInternalMessageBroker()

    • getNumberOfParallelMessages

      public int getNumberOfParallelMessages()

    • getActiveMQMessagePurgeInterval

      public int getActiveMQMessagePurgeInterval()

    • getQuartzSchedulerCronExpression

      public String getQuartzSchedulerCronExpression(String taskName)

    • getQuartzSchedulerCronExpression

      public String getQuartzSchedulerCronExpression()

    • isDeveloperPageActive

      public boolean isDeveloperPageActive()

    • getDeveloperScriptPath

      public String getDeveloperScriptPath(String purpose)

    • isLanguageVersionOtherThan

      public static boolean isLanguageVersionOtherThan(String field, String language)
      Parameters:
      field -
      language -
      Returns:
      Configured value

    • getStringFormat

      public Optional<String> getStringFormat(String type, Locale locale)

    • getThemePullScriptPath

      public String getThemePullScriptPath()

    • isPullThemeEnabled

      public boolean isPullThemeEnabled()
      Returns:
      boolean

    • getCreateDeveloperPackageScriptPath

      public String getCreateDeveloperPackageScriptPath()

    • getMediaTypeHandling

      public String getMediaTypeHandling(String mimeType)

    • getMediaTypeRedirectUrl

      public String getMediaTypeRedirectUrl(String mimeType)

    • getSearchHitStyleClass

      public String getSearchHitStyleClass()

    • getRecordViewStyleClass

      public String getRecordViewStyleClass()