org.odpi.openmetadata.accessservices.datamanager.api

Interface FilesAndFoldersInterface

public interface FilesAndFoldersInterface

FilesAndFoldersInterface is the interface used to record metadata about files and folders.

Method Summary

Modifier and Type	Method and Description
List<String>	addDataFileToCatalog(String userId, String fileServerCapabilityGUID, String fileServerCapabilityName, DataFileProperties dataFileProperties, String connectorProviderName) Creates a new file asset and links it to the folder structure implied in the path name.
List<String>	addDataFolderToCatalog(String userId, String fileServerCapabilityGUID, String fileServerCapabilityName, FileFolderProperties fileFolderProperties, String connectorProviderName) Creates a new folder asset that is identified as a data asset.
void	attachDataFileAssetToFolder(String userId, String fileServerCapabilityGUID, String fileServerCapabilityName, String folderGUID, String fileGUID) Link an existing file asset to a folder.
void	attachTopLevelFolder(String userId, String fileServerCapabilityGUID, String fileServerCapabilityName, String folderGUID) Links a folder to a file system.
List<String>	createNestedFolders(String userId, String fileServerCapabilityGUID, String fileServerCapabilityName, String pathName) Creates a new folder asset for each element in the pathName.
List<String>	createNestedFolders(String userId, String fileServerCapabilityGUID, String fileServerCapabilityName, String parentGUID, String pathName) Creates a new folder asset for each element in the pathName that is linked from the parent entity.
void	detachDataFileAssetFromFolder(String userId, String fileServerCapabilityGUID, String fileServerCapabilityName, String folderGUID, String fileGUID) Remove a link between a file asset and a folder.
void	detachTopLevelFolder(String userId, String fileServerCapabilityGUID, String fileServerCapabilityName, String folderGUID) Removed the link between a folder and a file system.
DataFileElement	getFileByGUID(String userId, String fileGUID) Retrieve a FolderProperties asset by its unique identifier (GUID).
DataFileElement	getFileByPathName(String userId, String pathName) Retrieve a folder by its fully qualified path name.
FileFolderElement	getFolderByGUID(String userId, String folderGUID) Retrieve a FolderProperties asset by its unique identifier (GUID).
FileFolderElement	getFolderByPathName(String userId, String pathName) Retrieve a folder by its fully qualified path name.
List<DataFileElement>	getFolderFiles(String userId, String folderGUID, int startFrom, int pageSize) Get the data files inside a folder - both those that are nested and those that are linked.
List<FileFolderElement>	getNestedFolders(String userId, String parentFolderGUID, int startFrom, int pageSize) Return the list of folders nested inside a folder.
List<DataFileElement>	getTopLevelDataFiles(String userId, String fileServerCapabilityGUID, String fileServerCapabilityName, int startFrom, int pageSize) Return the list of folders nested inside a folder.
List<FileFolderElement>	getTopLevelFolders(String userId, String fileServerCapabilityGUID, String fileServerCapabilityName, int startFrom, int pageSize) Return the list of folders linked to the file server capability.

Method Detail

createNestedFolders

List<String> createNestedFolders(String userId,
                                 String fileServerCapabilityGUID,
                                 String fileServerCapabilityName,
                                 String pathName)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Creates a new folder asset for each element in the pathName. For example, a pathName of "one/two/three" creates 3 new folder assets, one called "one", the next called "one/two" and the last one called "one/two/three".

Parameters:

userId - calling user

fileServerCapabilityGUID - unique identifier of the software server capability representing the file system or file manager

fileServerCapabilityName - unique name of the software server capability representing the file system or file manager

pathName - pathname of the folder (or folders)

Returns:

list of GUIDs from the top level to the leaf of the supplied pathname

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

createNestedFolders

List<String> createNestedFolders(String userId,
                                 String fileServerCapabilityGUID,
                                 String fileServerCapabilityName,
                                 String parentGUID,
                                 String pathName)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Creates a new folder asset for each element in the pathName that is linked from the parent entity. For example, a pathName of "one/two/three" creates 3 new folder assets, one called "one", the next called "one/two" and the last one called "one/two/three".

Parameters:

userId - calling user

fileServerCapabilityGUID - unique identifier of the software server capability representing the file system or file manager

fileServerCapabilityName - unique name of the software server capability representing the file system or file manager

parentGUID - root object to connect the folder to

pathName - pathname of the folder (or folders)

Returns:

list of GUIDs from the top level to the leaf of the supplied pathname

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

attachTopLevelFolder

void attachTopLevelFolder(String userId,
                          String fileServerCapabilityGUID,
                          String fileServerCapabilityName,
                          String folderGUID)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Links a folder to a file system. The folder is not changed.

Parameters:

userId - calling user

fileServerCapabilityGUID - unique identifier of the software server capability representing the file system or file manager

fileServerCapabilityName - unique name of the software server capability representing the file system or file manager

folderGUID - unique identifier of the folder in the catalog

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

detachTopLevelFolder

void detachTopLevelFolder(String userId,
                          String fileServerCapabilityGUID,
                          String fileServerCapabilityName,
                          String folderGUID)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Removed the link between a folder and a file system.

Parameters:

userId - calling user

fileServerCapabilityGUID - unique identifier of the software server capability representing the file system or file manager

fileServerCapabilityName - unique name of the software server capability representing the file system or file manager

folderGUID - unique identifier of the folder in the catalog

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addDataFileToCatalog

List<String> addDataFileToCatalog(String userId,
                                  String fileServerCapabilityGUID,
                                  String fileServerCapabilityName,
                                  DataFileProperties dataFileProperties,
                                  String connectorProviderName)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Creates a new file asset and links it to the folder structure implied in the path name. If the folder structure is not catalogued already, this is created automatically using the createFolderStructureInCatalog() method. For example, a pathName of "one/two/three/MyFile.txt" potentially creates 3 new folder assets, one called "one", the next called "one/two" and the last one called "one/two/three" plus a file asset called "one/two/three/MyFile.txt".

Parameters:

userId - calling user

fileServerCapabilityGUID - unique identifier of the software server capability representing the file system or file manager

fileServerCapabilityName - unique name of the software server capability representing the file system or file manager

dataFileProperties - details of the data file to add to the catalog as an asset

connectorProviderName - class name of connector provider for connector to access this asset

Returns:

list of asset GUIDs from the top level to the root of the pathname

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addDataFolderToCatalog

List<String> addDataFolderToCatalog(String userId,
                                    String fileServerCapabilityGUID,
                                    String fileServerCapabilityName,
                                    FileFolderProperties fileFolderProperties,
                                    String connectorProviderName)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Creates a new folder asset that is identified as a data asset. This means the files and sub-folders within it collectively make up the contents of the data asset. As with other types of file-based asset, links are made to the folder structure implied in the path name. If the folder structure is not catalogued already, this is created automatically using the createFolderStructureInCatalog() method. For example, a pathName of "one/two/three/MyDataFolder" potentially creates 3 new folder assets, one called "one", the next called "one/two" and the last one called "one/two/three" plus a DataFolder asset called "one/two/three/MyDataFolder".

Parameters:

userId - calling user

fileServerCapabilityGUID - unique identifier of the software server capability representing the file system or file manager

fileServerCapabilityName - unique name of the software server capability representing the file system or file manager

fileFolderProperties - properties to describe the folder properties

connectorProviderName - class name of connector provider for connector to access this asset

Returns:

list of GUIDs from the top level to the root of the pathname

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

attachDataFileAssetToFolder

void attachDataFileAssetToFolder(String userId,
                                 String fileServerCapabilityGUID,
                                 String fileServerCapabilityName,
                                 String folderGUID,
                                 String fileGUID)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Link an existing file asset to a folder. The file is not changed as this is used to create a logical link to the folder.

Parameters:

userId - calling user

fileServerCapabilityGUID - unique identifier of the software server capability representing the file system or file manager

fileServerCapabilityName - unique name of the software server capability representing the file system or file manager

folderGUID - unique identifier of the folder

fileGUID - unique identifier of the file

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

detachDataFileAssetFromFolder

void detachDataFileAssetFromFolder(String userId,
                                   String fileServerCapabilityGUID,
                                   String fileServerCapabilityName,
                                   String folderGUID,
                                   String fileGUID)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Remove a link between a file asset and a folder. The file is not changed. Use moveDataFileInCatalog to record the fact that the physical file has moved. Use attachDataFileAssetToFolder to create logical link to a new folder.

Parameters:

userId - calling user

fileServerCapabilityGUID - unique identifier of the software server capability representing the file system or file manager

fileServerCapabilityName - unique name of the software server capability representing the file system or file manager

folderGUID - unique identifier of the folder

fileGUID - unique identifier of the file

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getFolderByGUID

FileFolderElement getFolderByGUID(String userId,
                                  String folderGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Retrieve a FolderProperties asset by its unique identifier (GUID).

Parameters:

userId - calling user

folderGUID - unique identifier used to locate the folder

Returns:

FolderProperties properties

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getFolderByPathName

FileFolderElement getFolderByPathName(String userId,
                                      String pathName)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Retrieve a folder by its fully qualified path name.

Parameters:

userId - calling user

pathName - path name

Returns:

FolderProperties properties

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getTopLevelFolders

List<FileFolderElement> getTopLevelFolders(String userId,
                                           String fileServerCapabilityGUID,
                                           String fileServerCapabilityName,
                                           int startFrom,
                                           int pageSize)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Return the list of folders linked to the file server capability.

Parameters:

userId - calling user

fileServerCapabilityGUID - unique identifier of the software server capability representing the file system or file manager

fileServerCapabilityName - unique name of the software server capability representing the file system or file manager

startFrom - starting point in the list

pageSize - maximum number of results

Returns:

list of folder properties (null means no nested folders)

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getNestedFolders

List<FileFolderElement> getNestedFolders(String userId,
                                         String parentFolderGUID,
                                         int startFrom,
                                         int pageSize)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException

Return the list of folders nested inside a folder.

Parameters:

userId - calling user

parentFolderGUID - unique identifier of the parent folder or file system

startFrom - starting point in the list

pageSize - maximum number of results

Returns:

list of folder properties (null means no nested folders)

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getTopLevelDataFiles

List<DataFileElement> getTopLevelDataFiles(String userId,
                                           String fileServerCapabilityGUID,
                                           String fileServerCapabilityName,
                                           int startFrom,
                                           int pageSize)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Return the list of folders nested inside a folder.

Parameters:

userId - calling user

fileServerCapabilityGUID - unique identifier of the software server capability representing the file system or file manager

fileServerCapabilityName - unique name of the software server capability representing the file system or file manager

startFrom - starting point in the list

pageSize - maximum number of results

Returns:

list of file properties (null means no top-level files)

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getFolderFiles

List<DataFileElement> getFolderFiles(String userId,
                                     String folderGUID,
                                     int startFrom,
                                     int pageSize)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Get the data files inside a folder - both those that are nested and those that are linked.

Parameters:

userId - calling user

folderGUID - unique identifier of the parent folder

startFrom - starting point in the list

pageSize - maximum number of results

Returns:

list of file properties (null means no files)

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getFileByGUID

DataFileElement getFileByGUID(String userId,
                              String fileGUID)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException

Retrieve a FolderProperties asset by its unique identifier (GUID).

Parameters:

userId - calling user

fileGUID - unique identifier used to locate the folder

Returns:

File properties

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getFileByPathName

DataFileElement getFileByPathName(String userId,
                                  String pathName)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Retrieve a folder by its fully qualified path name.

Parameters:

userId - calling user

pathName - path name

Returns:

File properties

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem