org.apache.sling.jcr.contentloader

Class PathEntry

java.lang.Object

org.apache.sling.jcr.contentloader.ImportOptions

org.apache.sling.jcr.contentloader.PathEntry

public class PathEntry
extends ImportOptions

A path entry from the manifest for initial content.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTOCHECKOUT_DIRECTIVE The autoCheckout directive specifying whether versionable nodes should be checked out when necessary
static java.lang.String	CHECKIN_DIRECTIVE The checkin directive specifying whether versionable nodes should be checked in
static java.lang.String	CONTENT_HEADER The manifest header to specify initial content to be loaded.
static java.lang.String	IGNORE_CONTENT_READERS_DIRECTIVE The ignore content readers directive specifying whether the available ContentReaders should be used during content loading.
static java.lang.String	MERGE_NODES_DIRECTIVE The overwriteProperties directive specifying if content properties should be overwritten or just initially added.
static java.lang.String	MERGE_PROPERTIES_DIRECTIVE The overwriteProperties directive specifying if content properties should be overwritten or just initially added.
static java.lang.String	OVERWRITE_DIRECTIVE The overwrite directive specifying if content should be overwritten or just initially added.
static java.lang.String	OVERWRITE_PROPERTIES_DIRECTIVE The overwriteProperties directive specifying if content properties should be overwritten or just initially added.
static java.lang.String	PATH_DIRECTIVE The path directive specifying the target node where initial content will be loaded.
static java.lang.String	UNINSTALL_DIRECTIVE The uninstall directive specifying if content should be uninstalled.
java.util.Set<java.lang.String>	VALID_DIRECTIVES All directive names which are valid for header Sling-Initial-Content
static java.lang.String	WORKSPACE_DIRECTIVE The workspace into which the content will be loaded.

Constructor Summary

Constructors

Constructor and Description
PathEntry(ManifestHeader.Entry entry, long bundleLastModified)
PathEntry(ManifestHeader.Entry entry, long bundleLastModified, @Nullable java.lang.String bundleSymbolicName)

Method Summary

Modifier and Type	Method and Description
static @Nullable java.util.Iterator<PathEntry>	getContentPaths(org.osgi.framework.Bundle bundle) Parses the "Sling-Initial-Content" header from the given bundle and returns the resolved PathEntries
static @Nullable java.util.Iterator<PathEntry>	getContentPaths(@NotNull java.util.jar.Manifest manifest, long bundleLastModified) Parses the "Sling-Initial-Content" header from the given manifest and returns the resolved PathEntries
static @Nullable java.util.Iterator<PathEntry>	getContentPaths(java.util.Map<java.lang.String,java.lang.String> headers, long bundleLastModified) Parses the "Sling-Initial-Content" header from the given headers and returns the resolved PathEntries
java.util.Set<java.lang.String>	getIgnoredContentReaders()
long	getLastModified()
java.lang.String	getPath()
java.lang.String	getTarget()
java.lang.String	getWorkspace()
boolean	isAutoCheckout() Specifies whether versionable nodes is automatically checked out when necessary.
boolean	isCheckin() Specifies whether versionable nodes is automatically checked in at the end of the import operation.
boolean	isIgnoredImportProvider(java.lang.String extension) Check if the content reader for the given file extension should be ignored.
boolean	isMerge() Specifies whether imported nodes should merge with existing nodes.
boolean	isOverwrite() Specifies whether imported nodes should overwrite existing nodes.
boolean	isPropertyMerge() Specifies whether imported properties should merge with existing properties.
boolean	isPropertyOverwrite() Specifies whether imported properties should overwrite existing properties.
boolean	isUninstall()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONTENT_HEADER

public static final java.lang.String CONTENT_HEADER

The manifest header to specify initial content to be loaded.

See Also:

Constant Field Values

OVERWRITE_DIRECTIVE

public static final java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.String UNINSTALL_DIRECTIVE

The uninstall directive specifying if content should be uninstalled.

See Also:

Constant Field Values

PATH_DIRECTIVE

public static final java.lang.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 java.lang.String WORKSPACE_DIRECTIVE

The workspace into which the content will be loaded.

See Also:

Constant Field Values

CHECKIN_DIRECTIVE

public static final java.lang.String CHECKIN_DIRECTIVE

The checkin directive specifying whether versionable nodes should be checked in

See Also:

Constant Field Values

AUTOCHECKOUT_DIRECTIVE

public static final java.lang.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 java.lang.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

VALID_DIRECTIVES

public java.util.Set<java.lang.String> VALID_DIRECTIVES

All directive names which are valid for header Sling-Initial-Content

Constructor Detail

PathEntry

public PathEntry(ManifestHeader.Entry entry,
                 long bundleLastModified)

PathEntry

public PathEntry(ManifestHeader.Entry entry,
                 long bundleLastModified,
                 @Nullable
                 @Nullable java.lang.String bundleSymbolicName)

Method Detail

getContentPaths

@Nullable
public static @Nullable java.util.Iterator<PathEntry> getContentPaths(@NotNull
                                                                                @NotNull java.util.jar.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 java.util.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 java.util.Iterator<PathEntry> getContentPaths(java.util.Map<java.lang.String,java.lang.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 java.lang.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(java.lang.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

getIgnoredContentReaders

public java.util.Set<java.lang.String> getIgnoredContentReaders()

getTarget

public java.lang.String getTarget()

getWorkspace

public java.lang.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