atg.repository.loader

Interface FileSystemManager

public interface FileSystemManager

The FileSystemManager defines a very high level API for triggering content loading from the file system into an ATG Repository. Implementations of this interface will typically also implement FileSystemMonitor. Users requiring more precision than is offered by these methods they should use the LoaderManager API directly, possibly in conjunction with the FileSystemMonitor's methods.

See Also:

FileSystemMonitor

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Method Summary

Methods

Modifier and Type	Method and Description
atg.repository.loader.JobId	add(boolean pRecurse) Convenience method that adds all items specified by the current monitored paths to the Repository.
void	add(java.io.File[] pPaths, boolean[] pRecurse) Convenience method that adds all items specified by the provided array of paths to the Repository.
atg.repository.loader.JobId	add(java.io.File pAbsolutePath, boolean pRecurse) Convenience method that triggers an add of the given path to the repository
atg.repository.loader.JobId	delete(boolean pRecurse) Convenience method that removes all items specified by the current monitored paths from the Repository.
atg.repository.loader.JobId	delete(boolean pRecurse, long pLastDeleted) Convenience method that removes all items specified by the current monitored paths from the Repository.
void	delete(java.io.File[] pPaths, boolean[] pRecurse) Convenience method that removes all items specified by the provided array of paths from the Repository.
void	delete(java.io.File[] pPaths, boolean[] pRecurse, long pLastDeleted) Convenience method that removes all items specified by the provided array of paths from the Repository.
atg.repository.loader.JobId	delete(java.io.File pAbsolutePath, boolean pRecurse) Convenience method that removes all items specified by the provided path from the Repository.
atg.repository.loader.JobId	delete(java.io.File pAbsolutePath, boolean pRecurse, long pLastDeleted) Convenience method that removes all items specified by the provided path from the Repository.
atg.repository.loader.JobId	update(boolean pRecurse) Convenience method that triggers an execution using the current value of the lastUpdated and the current monitored path.
atg.repository.loader.JobId	update(boolean pRecurse, long pLastUpdated) Convenience method that triggers an execution using the current value of the monitoredPath property and the specifed lastUpdated value.
void	update(java.io.File[] pPaths, boolean[] pRecurse) Convenience method that triggers an execution using the current value of the lastUpdated and the specified list of paths.
void	update(java.io.File[] pPaths, boolean[] pRecurse, long pLastUpdated) Convenience method that triggers an execution using the specified list of paths and the specifed lastUpdated value.
atg.repository.loader.JobId	update(java.io.File pAbsolutePath, boolean pRecurse) Convenience method that triggers an execution using the current values of the lastUpdated and monitoredPath properties.
atg.repository.loader.JobId	update(java.io.File pAbsolutePath, boolean pRecurse, long pLastUpdated) Convenience method that triggers an execution using the current value of the monitoredPath property and the specifed lastUpdated value.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

update

atg.repository.loader.JobId update(java.io.File pAbsolutePath,
                                 boolean pRecurse,
                                 long pLastUpdated)
                                   throws atg.repository.loader.LoaderException

Convenience method that triggers an execution using the current value of the monitoredPath property and the specifed lastUpdated value. Modified files will be updated in the Repository.

Parameters:

pAbsolutePath - a File object specifying the path to be processed pAbsolutePath must be a child of monitoredPath.

pRecurse - boolean flag indicating if pPath should be processed recursively

pLastUpdated - long timestamp specifying the last update time

Returns:

job ID if successful; null otherwise

Throws:

atg.repository.loader.LoaderException

update

atg.repository.loader.JobId update(java.io.File pAbsolutePath,
                                 boolean pRecurse)
                                   throws atg.repository.loader.LoaderException

Convenience method that triggers an execution using the current values of the lastUpdated and monitoredPath properties. Modified files will be updated in the Repository.

Parameters:

pAbsolutePath - a File object specifying the path to be processed pAbsolutePath must be a child of monitoredPath.

pRecurse - boolean flag indicating if pPath should be processed recursively

Returns:

job ID if successful; null otherwise

Throws:

atg.repository.loader.LoaderException

add

atg.repository.loader.JobId add(java.io.File pAbsolutePath,
                              boolean pRecurse)
                                throws atg.repository.loader.LoaderException

Convenience method that triggers an add of the given path to the repository

Parameters:

pAbsolutePath - a File object specifying the path to be added pAbsolutePath must be a child of monitoredPath.

pRecurse - boolean flag indicating if pPath should be processed recursively

Returns:

job ID if successful; null otherwise

Throws:

atg.repository.loader.LoaderException

delete

atg.repository.loader.JobId delete(java.io.File pAbsolutePath,
                                 boolean pRecurse,
                                 long pLastDeleted)
                                   throws atg.repository.loader.LoaderException

Convenience method that removes all items specified by the provided path from the Repository.

Parameters:

pAbsolutePath - a File object specifying the path to be processed pAbsolutePath must be a child of monitoredPath.

pRecurse - boolean flag indicating if pPath should be processed recursively

pLastDeleted - long timestamp specifying the last delete time

Returns:

job ID if successful; null otherwise

Throws:

atg.repository.loader.LoaderException

delete

atg.repository.loader.JobId delete(java.io.File pAbsolutePath,
                                 boolean pRecurse)
                                   throws atg.repository.loader.LoaderException

Convenience method that removes all items specified by the provided path from the Repository.

Parameters:

pAbsolutePath - a File object specifying the path to be processed pAbsolutePath must be a child of monitoredPath.

pRecurse - boolean flag indicating if pPath should be processed recursively

Returns:

job ID if successful; null otherwise

Throws:

atg.repository.loader.LoaderException

update

void update(java.io.File[] pPaths,
          boolean[] pRecurse,
          long pLastUpdated)
            throws atg.repository.loader.LoaderException

Convenience method that triggers an execution using the specified list of paths and the specifed lastUpdated value. Modified files will be updated in the Repository.

Parameters:

pPaths - an array of File objects specifying the paths to be processed. pPaths must be children of monitoredPath.

pRecurse - corresponding array of boolean flags indicating if paths should be processed recursively

pLastUpdated - long timestamp specifying the last update time

Throws:

atg.repository.loader.LoaderException

update

void update(java.io.File[] pPaths,
          boolean[] pRecurse)
            throws atg.repository.loader.LoaderException

Convenience method that triggers an execution using the current value of the lastUpdated and the specified list of paths. Modified files will be updated in the Repository.

Parameters:

pPaths - an array of File objects specifying the paths to be processed. pPaths must be children of monitoredPath.

pRecurse - corresponding array of boolean flags indicating if paths should be processed recursively

Throws:

atg.repository.loader.LoaderException

add

void add(java.io.File[] pPaths,
       boolean[] pRecurse)
         throws atg.repository.loader.LoaderException

Convenience method that adds all items specified by the provided array of paths to the Repository.

Parameters:

pPaths - an array of File objects specifying the paths to be processed. pPaths must be children of monitoredPath.

pRecurse - corresponding array of boolean flags indicating if paths should be processed recursively

Throws:

atg.repository.loader.LoaderException

delete

void delete(java.io.File[] pPaths,
          boolean[] pRecurse,
          long pLastDeleted)
            throws atg.repository.loader.LoaderException

Convenience method that removes all items specified by the provided array of paths from the Repository.

Parameters:

pPaths - an array of File objects specifying the paths to be processed. pPaths must be children of monitoredPath.

pRecurse - corresponding array of boolean flags indicating if paths should be processed recursively

pLastDeleted - long timestamp specifying the last delete time

Throws:

atg.repository.loader.LoaderException

delete

void delete(java.io.File[] pPaths,
          boolean[] pRecurse)
            throws atg.repository.loader.LoaderException

Convenience method that removes all items specified by the provided array of paths from the Repository.

Parameters:

pPaths - an array of File objects specifying the paths to be processed. pPaths must be children of monitoredPath.

pRecurse - corresponding array of boolean flags indicating if paths should be processed recursively

Throws:

atg.repository.loader.LoaderException

update

atg.repository.loader.JobId update(boolean pRecurse,
                                 long pLastUpdated)
                                   throws atg.repository.loader.LoaderException

Convenience method that triggers an execution using the current value of the monitoredPath property and the specifed lastUpdated value. Modified files will be updated in the Repository.

Parameters:

pRecurse - boolean flag indicating if paths should be processed recursively

pLastUpdated - long timestamp specifying the last update time

Returns:

job ID if successful; null otherwise

Throws:

atg.repository.loader.LoaderException

update

atg.repository.loader.JobId update(boolean pRecurse)
                                   throws atg.repository.loader.LoaderException

Convenience method that triggers an execution using the current value of the lastUpdated and the current monitored path. Modified files will be updated in the Repository.

Parameters:

pRecurse - boolean flag indicating if paths should be processed recursively

Returns:

job ID if successful; null otherwise

Throws:

atg.repository.loader.LoaderException

add

atg.repository.loader.JobId add(boolean pRecurse)
                                throws atg.repository.loader.LoaderException

Convenience method that adds all items specified by the current monitored paths to the Repository.

Parameters:

pRecurse - boolean flag indicating if paths should be processed recursively

Returns:

job ID if successful; null otherwise

Throws:

atg.repository.loader.LoaderException

delete

atg.repository.loader.JobId delete(boolean pRecurse,
                                 long pLastDeleted)
                                   throws atg.repository.loader.LoaderException

Convenience method that removes all items specified by the current monitored paths from the Repository.

Parameters:

pRecurse - boolean flag indicating if paths should be processed recursively

pLastDeleted - long timestamp specifying the last delete time

Returns:

job ID if successful; null otherwise

Throws:

atg.repository.loader.LoaderException

delete

atg.repository.loader.JobId delete(boolean pRecurse)
                                   throws atg.repository.loader.LoaderException

Convenience method that removes all items specified by the current monitored paths from the Repository.

Parameters:

pRecurse - boolean flag indicating if paths should be processed recursively

Returns:

job ID if successful; null otherwise

Throws:

atg.repository.loader.LoaderException