Package org.apache.sling.jcr.contentloader

Class PathEntry

  • public class PathEntry
extends ImportOptions
    A path entry from the manifest for initial content.

    • Field Detail

      • CONTENT_HEADER

        public static final String CONTENT_HEADER
        The manifest header to specify initial content to be loaded.
        See Also:
        Constant Field Values

      • OVERWRITE_DIRECTIVE

        public static final String OVERWRITE_DIRECTIVE
        The overwrite directive specifying if content should be overwritten or just initially added.
        See Also:
        Constant Field Values

      • OVERWRITE_PROPERTIES_DIRECTIVE

        public static final String OVERWRITE_PROPERTIES_DIRECTIVE
        The overwriteProperties directive specifying if content properties should be overwritten or just initially added.
        See Also:
        Constant Field Values

      • MERGE_PROPERTIES_DIRECTIVE

        public static final String MERGE_PROPERTIES_DIRECTIVE
        The overwriteProperties directive specifying if content properties should be overwritten or just initially added.
        See Also:
        Constant Field Values

      • MERGE_NODES_DIRECTIVE

        public static final String MERGE_NODES_DIRECTIVE
        The overwriteProperties directive specifying if content properties should be overwritten or just initially added.
        See Also:
        Constant Field Values

      • UNINSTALL_DIRECTIVE

        public static final String UNINSTALL_DIRECTIVE
        The uninstall directive specifying if content should be uninstalled.
        See Also:
        Constant Field Values

      • PATH_DIRECTIVE

        public static final String PATH_DIRECTIVE
        The path directive specifying the target node where initial content will be loaded.
        See Also:
        Constant Field Values

      • WORKSPACE_DIRECTIVE

        public static final String WORKSPACE_DIRECTIVE
        The workspace into which the content will be loaded.
        See Also:
        Constant Field Values

      • CHECKIN_DIRECTIVE

        public static final String CHECKIN_DIRECTIVE
        The checkin directive specifying whether versionable nodes should be checked in
        See Also:
        Constant Field Values

      • AUTOCHECKOUT_DIRECTIVE

        public static final String AUTOCHECKOUT_DIRECTIVE
        The autoCheckout directive specifying whether versionable nodes should be checked out when necessary
        See Also:
        Constant Field Values

      • IGNORE_CONTENT_READERS_DIRECTIVE

        public static final String IGNORE_CONTENT_READERS_DIRECTIVE
        The ignore content readers directive specifying whether the available ContentReaders should be used during content loading. This is a string value that defaults to the emptystring.
        Since:
        2.0.4
        See Also:
        Constant Field Values

    • Constructor Detail

      • PathEntry

        public PathEntry​(org.apache.sling.commons.osgi.ManifestHeader.Entry entry,
                 long bundleLastModified)

    • Method Detail

      • getContentPaths

        @Nullable
public static @Nullable Iterator<PathEntry> getContentPaths​(@NotNull
                                                            @NotNull Manifest manifest,
                                                            long bundleLastModified)
        Parses the "Sling-Initial-Content" header from the given manifest and returns the resolved PathEntries
        Parameters:
        manifest - the manifest
        bundleLastModified - the timestamp when the bundle has been last modified or -1 if not known
        Returns:
        an iterator over the parsed PathEntry items or null in case no "Sling-Initial-Content" header was found in the manifest

      • getContentPaths

        @Nullable
public static @Nullable Iterator<PathEntry> getContentPaths​(org.osgi.framework.Bundle bundle)
        Parses the "Sling-Initial-Content" header from the given bundle and returns the resolved PathEntries
        Parameters:
        bundle - the bundle
        Returns:
        an iterator over the parsed PathEntry items or null in case no "Sling-Initial-Content" header was found in the bundle's manifest

      • getContentPaths

        @Nullable
public static @Nullable Iterator<PathEntry> getContentPaths​(Map<String,​String> headers,
                                                            long bundleLastModified)
        Parses the "Sling-Initial-Content" header from the given headers and returns the resolved PathEntries
        Parameters:
        headers - the manifest headers
        bundleLastModified - the timestamp when the bundle has been last modified or -1 if not known
        Returns:
        an iterator over the parsed PathEntry items or null in case no "Sling-Initial-Content" header was found

      • getLastModified

        public long getLastModified()

      • getPath

        public String getPath()

      • isOverwrite

        public boolean isOverwrite()
        Description copied from class: ImportOptions
        Specifies whether imported nodes should overwrite existing nodes. NOTE: this means the existing node will be deleted and a new node will be created in the same location.
        Specified by:
        isOverwrite in class ImportOptions
        Returns:
        true to overwrite nodes, false otherwise

      • isPropertyOverwrite

        public boolean isPropertyOverwrite()
        Description copied from class: ImportOptions
        Specifies whether imported properties should overwrite existing properties.
        Specified by:
        isPropertyOverwrite in class ImportOptions
        Returns:
        true to overwrite node properties, false otherwise

      • isUninstall

        public boolean isUninstall()

      • isCheckin

        public boolean isCheckin()
        Description copied from class: ImportOptions
        Specifies whether versionable nodes is automatically checked in at the end of the import operation.
        Specified by:
        isCheckin in class ImportOptions
        Returns:
        true to checkin the versionable nodes, false otherwise

      • isAutoCheckout

        public boolean isAutoCheckout()
        Description copied from class: ImportOptions
        Specifies whether versionable nodes is automatically checked out when necessary.
        Overrides:
        isAutoCheckout in class ImportOptions
        Returns:
        true to checkout the versionable nodes, false otherwise

      • isIgnoredImportProvider

        public boolean isIgnoredImportProvider​(String extension)
        Description copied from class: ImportOptions
        Check if the content reader for the given file extension should be ignored.
        Specified by:
        isIgnoredImportProvider in class ImportOptions
        Parameters:
        extension - the extension to check
        Returns:
        true to ignore the reader, false otherwise

      • getTarget

        public String getTarget()

      • getWorkspace

        public String getWorkspace()

      • isPropertyMerge

        public boolean isPropertyMerge()
        Description copied from class: ImportOptions
        Specifies whether imported properties should merge with existing properties. NOTE: this means that properties that are not imported will be removed
        Overrides:
        isPropertyMerge in class ImportOptions
        Returns:
        true to overwrite nodes, false otherwise

      • isMerge

        public boolean isMerge()
        Description copied from class: ImportOptions
        Specifies whether imported nodes should merge with existing nodes. NOTE: this means the existing nodes that are not imported will be deleted.
        Overrides:
        isMerge in class ImportOptions
        Returns:
        true to overwrite nodes, false otherwise