Package org.craftercms.studio.api.v1.service.configuration

Interface ServicesConfig

  • All Known Implementing Classes:
    ServicesConfigImpl
    public interface ServicesConfig
    This class provides the repository configuration information
    Author:
    hyanghee

    • Method Detail

      • getRootPrefix

        String getRootPrefix​(String site)
        get the root prefix of site. the root prefix represents the folder name pattern of the corporate and the geo site file locations e.g. if corporate files are under /site and the geo site files are under /site_geo then the root prefix should be "/site"
        Parameters:
        site -
        Returns:
        root prefix

      • getWemProject

        String getWemProject​(String site)
        get the name of the web project for the given site
        Parameters:
        site -
        Returns:
        web project name

      • getFolders

        List<DmFolderConfigTO> getFolders​(String site)
        get a list of folder configuration. The top folders are used to as the top categories when services return a collection of items such as get-go-live-items call
        Parameters:
        site -
        Returns:
        a list of folder configuration

      • getContentTypeConfig

        ContentTypeConfigTO getContentTypeConfig​(String site,
                                         String name)
        get DM content type configuration by the given site and name
        Parameters:
        site -
        name -
        Returns:
        content type

      • getComponentPatterns

        List<String> getComponentPatterns​(String site)
        get component item URI patterns
        Returns:
        component item URI patterns

      • getAssetPatterns

        List<String> getAssetPatterns​(String site)
        get asset item URI patterns
        Returns:
        asset item URI patterns

      • getPagePatterns

        List<String> getPagePatterns​(String site)
        get page item URI patterns
        Returns:
        page item URI patterns

      • getDocumentPatterns

        List<String> getDocumentPatterns​(String site)
        get document item URI patterns
        Returns:
        document item URI patterns

      • getRenderingTemplatePatterns

        List<String> getRenderingTemplatePatterns​(String site)
        get rendering template item URI patterns
        Returns:
        rendering template item URI patterns

      • getScriptsPatterns

        List<String> getScriptsPatterns​(String site)
        get scripts item URI patterns
        Returns:
        scripts item URI patterns

      • getLevelDescriptorPatterns

        List<String> getLevelDescriptorPatterns​(String site)
        get level descriptor item URI patterns
        Returns:
        level descriptor item URI patterns

      • getLevelDescriptorName

        String getLevelDescriptorName​(String site)
        get the name of level descriptor
        Parameters:
        site -
        Returns:
        level descriptor name

      • getDeleteDependencyPatterns

        List<DeleteDependencyConfigTO> getDeleteDependencyPatterns​(String site,
                                                           String contentType)
        get the delete dependencies related to a content type
        Parameters:
        site -
        Returns:
        delete dependencys patterns

      • getCopyDependencyPatterns

        List<CopyDependencyConfigTO> getCopyDependencyPatterns​(String site,
                                                       String contentType)
        get the copy dependencies pattern for a content type
        Parameters:
        site -
        contentType -
        Returns:
        copy dependencies patterns

      • getDisplayInWidgetPathPatterns

        List<String> getDisplayInWidgetPathPatterns​(String site)
        get a list of paths to display in widgets
        Parameters:
        site -
        Returns:
        a list of paths to display in widgets

      • getDefaultTimezone

        String getDefaultTimezone​(String site)
        get the default timezone value
        Parameters:
        site -
        Returns:
        default timezone

      • getPreviewableMimetypesPaterns

        List<String> getPreviewableMimetypesPaterns​(String site)

      • getPluginFolderPattern

        String getPluginFolderPattern​(String site)
        Get the pattern for the plugin folder in the given site

      • getSandboxBranchName

        String getSandboxBranchName​(String site)
        Get sandbox branch name for given site
        Parameters:
        site -
        Returns:
        Sandbox branch name

      • getStagingEnvironment

        String getStagingEnvironment​(String site)

      • getLiveEnvironment

        String getLiveEnvironment​(String site)

      • isStagingEnvironmentEnabled

        boolean isStagingEnvironmentEnabled​(String site)

      • getSearchFields

        Map<String,​Float> getSearchFields​(String site)
        Returns the search field configuration for the given site
        Parameters:
        site - the site
        Returns:
        the search fields

      • getFacets

        Map<String,​FacetTO> getFacets​(String site)
        Returns the search facets configuration for the given site
        Parameters:
        site - the site
        Returns:
        the facets

      • getAuthoringUrl

        String getAuthoringUrl​(String siteId)
        Get configured authoring url for given site
        Parameters:
        siteId - site identifier
        Returns:
        authoring url

      • getStagingUrl

        String getStagingUrl​(String siteId)
        Get configure staging url for given site
        Parameters:
        siteId - site identifier
        Returns:
        staging url

      • getLiveUrl

        String getLiveUrl​(String siteId)
        Get configured live url for given site
        Parameters:
        siteId - site identifier
        Returns:
        live url

      • getAdminEmailAddress

        String getAdminEmailAddress​(String siteId)
        Get configured admin email address for notification emails for given site
        Parameters:
        siteId - site identifier
        Returns:
        admin email address

      • isRequirePeerReview

        boolean isRequirePeerReview​(String siteId)
        Check if it is configured to require peer review
        Parameters:
        siteId - site identifier
        Returns:
        true if require peer review is configured for site

      • getProtectedFolderPatterns

        List<String> getProtectedFolderPatterns​(String siteId)
        Get configured protected folder patterns for site
        Parameters:
        siteId - site identifier
        Returns:
        list of configured protected folders patterns