Package org.apache.jackrabbit.vault.fs.io

Class ImportOptions

java.lang.Object
org.apache.jackrabbit.vault.fs.io.ImportOptions
public class ImportOptions extends Object
Option that control the package import.

  • Constructor Details

    • ImportOptions

      public ImportOptions()
      Default constructor.

    • ImportOptions

      @Deprecated public ImportOptions(ImportOptions base)
      Deprecated.
      use copy() instead.
      Parameters:
      base - base options

  • Method Details

    • copy

      public ImportOptions copy()
      Creates a copy of this import options.
      Returns:
      a copy of this.

    • setOverwritePrimaryTypesOfFolders

      public void setOverwritePrimaryTypesOfFolders(boolean overwritePrimaryTypesOfFolders)

    • overwritePrimaryTypesOfFolders

      public boolean overwritePrimaryTypesOfFolders()

    • overwritePrimaryTypesOfFolders

      public boolean overwritePrimaryTypesOfFolders(boolean overwritePrimaryTypesOfFoldersByDefault)

    • isStrict

      public boolean isStrict(boolean isStrictByDefault)

    • isStrict

      @Deprecated public boolean isStrict()
      Deprecated.
      Use isStrict(boolean) instead.
      Returns the 'strict' flag.
      Returns:
      the 'strict' flag or null in case this is not set

    • setStrict

      public void setStrict(boolean strict)
      Sets the 'strict' flag.
      Parameters:
      strict - the flag

    • getListener

      public ProgressTrackerListener getListener()
      Returns the progress tracker listener.
      Returns:
      the progress tracker listener.

    • setListener

      public void setListener(ProgressTrackerListener listener)
      Sets the progress tracker listener that receives messages during package installation.
      Parameters:
      listener - The listener

    • getPatchParentPath

      public String getPatchParentPath()
      Returns the patch parent path
      Returns:
      the patch parent path

    • setPatchParentPath

      public void setPatchParentPath(String patchParentPath)
      Sets the parent path of the patch node.
      Parameters:
      patchParentPath - the path

    • getPatchDirectory

      public File getPatchDirectory()
      Returns the patch directory
      Returns:
      the patch directory

    • setPatchDirectory

      public void setPatchDirectory(File patchDirectory) throws IOException
      Sets the patch directory. The nt:file nodes that are placed below the getPatchParentPath() will be copied into this directory during extraction.
      Parameters:
      patchDirectory - The directory
      Throws:
      IOException - if an i/o error occurrs during obtaining the canonical file of this directory.

    • isPatchKeepInRepo

      public boolean isPatchKeepInRepo()
      Returns the 'patch-keep-in-repo' flag.
      Returns:
      the 'patch-keep-in-repo' flag.

    • setPatchKeepInRepo

      public void setPatchKeepInRepo(boolean patchKeepInRepo)
      Sets the flag if patches should be kept in the repository after there were copied to the disk.
      Parameters:
      patchKeepInRepo - the flag

    • getAccessControlHandling

      public AccessControlHandling getAccessControlHandling()
      Returns the default access control handling.
      Returns:
      the default access control handling.

    • setAccessControlHandling

      public void setAccessControlHandling(AccessControlHandling acHandling)
      Sets the access control handling.
      Parameters:
      acHandling - the ACL handling.

    • getCugHandling

      public AccessControlHandling getCugHandling()
      Returns closed user group handling.
      Returns:
      CUG handling value. null value indicates that CUG handling is controlled by acHandling value which maintains backwards compatibility.

    • setCugHandling

      public void setCugHandling(AccessControlHandling cugHandling)
      Sets closed user group handling. For backwards compatibility, when cugHandling is set to null null then acHandling is used is used to control handling of CUG nodes.
      Parameters:
      cugHandling - the CUG handling.

    • isNonRecursive

      public boolean isNonRecursive()
      Defines the package installation should recursively install sub packages. Note that if this flag is enabled, the SubPackageHandling configuration has no effect, as sub packages are not evaluated at all.
      Returns:
      true if package installation should not install sub packages.

    • setNonRecursive

      public void setNonRecursive(boolean nonRecursive)
      Sets the flag to ignore sub packages.
      Parameters:
      nonRecursive - true to set non recursive
      See Also:

    • getCndPattern

      public Pattern getCndPattern()
      Returns the CND pattern
      Returns:
      the CND pattern

    • setCndPattern

      public void setCndPattern(String cndPattern) throws PatternSyntaxException
      Sets the CND file pattern.
      Parameters:
      cndPattern - the cnd pattern
      Throws:
      PatternSyntaxException - If the pattern is not valid

    • isDryRun

      public boolean isDryRun()
      Returns the dry run flag.
      Returns:
      the dry run flag.
      Since:
      2.2.14

    • setDryRun

      public void setDryRun(boolean dryRun)
      Sets the dry run flag.
      Parameters:
      dryRun - the dry run flag.
      Since:
      2.2.14

    • setAutoSaveThreshold

      public void setAutoSaveThreshold(int autoSaveThreshold)
      Sets the auto-save threshold. See AutoSave
      Parameters:
      autoSaveThreshold - the threshold in number of nodes.
      Since:
      2.2.16

    • getAutoSaveThreshold

      public int getAutoSaveThreshold()
      Returns the auto-save threshold. If Integer.MAX_VALUE both Session.save() and Session.refresh(boolean) must not be executed during Importer.run(Archive, Session, String).
      Returns:
      the auto-save threshold.
      Since:
      2.2.16

    • getImportMode

      public ImportMode getImportMode()
      Returns the import mode.
      Returns:
      the import mode.
      Since:
      2.3

    • setImportMode

      public void setImportMode(ImportMode importMode)
      Sets the default import mode.
      Parameters:
      importMode - The import mode.
      Since:
      2.3

    • getFilter

      public WorkspaceFilter getFilter()
      Returns the default workspace filter.
      Returns:
      the default workspace filter.
      Since:
      2.3.20

    • setFilter

      public void setFilter(WorkspaceFilter filter)
      Sets the default workspace filter.
      Parameters:
      filter - the filter
      Since:
      2.3.20

    • getHookClassLoader

      public ClassLoader getHookClassLoader()
      Returns the hook class loader.
      Returns:
      the hook class loader.
      Since:
      2.3.22

    • setHookClassLoader

      public void setHookClassLoader(ClassLoader hookClassLoader)
      Sets the hook class loader.
      Parameters:
      hookClassLoader - the class loader
      Since:
      2.3.22

    • getPathMapping

      public PathMapping getPathMapping()
      Defines a path mapping that is applied to the incoming package paths and filter when installing the package.
      Returns:
      null if no path mapping is defined.
      Since:
      3.1.14

    • setPathMapping

      public void setPathMapping(PathMapping pathMapping)
      Sets the path mapping
      Parameters:
      pathMapping - The path mapping
      Since:
      3.1.14
      See Also:

    • getDependencyHandling

      public DependencyHandling getDependencyHandling()
      Defines how package dependencies affect package installation and un-installation.
      Returns:
      the dependency handling.

    • setDependencyHandling

      public void setDependencyHandling(DependencyHandling dependencyHandling)
      Sets the dependency handling.
      Parameters:
      dependencyHandling - the dependency handling.
      Since:
      3.1.32
      See Also:

    • getIdConflictPolicy

      @NotNull public @NotNull IdConflictPolicy getIdConflictPolicy()
      Returns:
      the id conflict policy if one is set, otherwise IdConflictPolicy.FAIL
      Since:
      3.5.1

    • hasIdConflictPolicyBeenSet

      public boolean hasIdConflictPolicyBeenSet()
      Returns:
      true if setIdConflictPolicy(IdConflictPolicy) has been called otherwise false
      Since:
      3.6.0

    • setIdConflictPolicy

      public void setIdConflictPolicy(@NotNull @NotNull IdConflictPolicy idConflictPolicy)
      Sets the id conflict policy (in case of unresolveable conflicts).
      Parameters:
      idConflictPolicy - the conflict policy
      Since:
      3.5.2

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object