org.apache.sling.jcr.contentloader.internal
Class PathEntry

java.lang.Object
  org.apache.sling.jcr.contentloader.ImportOptions
      org.apache.sling.jcr.contentloader.internal.PathEntry

public class PathEntry
extends ImportOptions

A path entry from the manifest for initial content.

Field Summary

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_IMPORT_PROVIDERS_DIRECTIVE The ignore import providers directive specifying whether the available ImportProviders should be used during content loading.
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.
static java.lang.String	WORKSPACE_DIRECTIVE The workspace into which the content will be loaded.

Constructor Summary

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

Method Summary

static java.util.Iterator<PathEntry>	getContentPaths(org.osgi.framework.Bundle bundle)
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 import provider for the given file extension should be ignored.
boolean	isOverwrite() Specifies whether imported nodes should overwrite existing nodes.
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

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_IMPORT_PROVIDERS_DIRECTIVE

public static final java.lang.String IGNORE_IMPORT_PROVIDERS_DIRECTIVE

The ignore import providers directive specifying whether the available ImportProviders should be used during content loading. This is a string value that defaults to the empty string..

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

public static java.util.Iterator<PathEntry> getContentPaths(org.osgi.framework.Bundle bundle)

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 import provider 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 provider, false otherwise

getTarget

public java.lang.String getTarget()

getWorkspace

public java.lang.String getWorkspace()