org.odpi.openmetadata.integrationservices.files.connector

Class FilesIntegratorContext

java.lang.Object

org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext

public class FilesIntegratorContext
extends Object

FilesIntegratorContext provides a wrapper around the Data Manager OMAS clients. It provides the simplified interface to open metadata needed by the FilesIntegratorConnector. It is designed to be used either for cataloguing folders and files

Constructor Summary

Constructors

Constructor and Description
FilesIntegratorContext(FilesAndFoldersClient client, DataManagerEventClient eventClient, String userId, String fileServerCapabilityGUID, String fileServerCapabilityName) Create a new client with no authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method and Description
List<String>	addDataFileToCatalog(DataFileProperties dataFileProperties, String connectorProviderName) Creates a new file asset and links it to the folder structure implied in the path name.
List<String>	addDataFileToCatalogFromTemplate(String templateGUID, TemplateProperties templateProperties) Add an asset description a file based on the content of a template object.
List<String>	addDataFolderToCatalog(FileFolderProperties fileFolderProperties, String connectorProviderName) Creates a new folder asset that is identified as a data asset.
List<String>	addDataFolderToCatalogFromTemplate(String templateGUID, TemplateProperties templateProperties) Add an asset description a file based on the content of a template object.
void	archiveDataFileInCatalog(String dataFileGUID, ArchiveProperties archiveProperties) Mark the file asset description in the catalog as archived.
void	archiveDataFolderInCatalog(String dataFolderGUID, ArchiveProperties archiveProperties) Mark the data folder asset description in the catalog as archived.
void	attachDataFileAssetToFolder(String folderGUID, String fileGUID) Link an existing file asset to a folder.
void	attachTopLevelFolder(String fileSystemGUID, String folderGUID) Links a folder to a file system.
List<String>	createNestedFolders(String parentGUID, String pathName) Creates a new folder asset for each element in the pathName.
void	deleteDataFileFromCatalog(String dataFileGUID, String fullPathname) Remove the file asset description from the catalog.
void	detachDataFileAssetFromFolder(String folderGUID, String fileGUID) Remove a link between a file asset and a folder.
void	detachTopLevelFolder(String fileSystemGUID, String folderGUID) Removed the link between a folder and a file system.
DataFileElement	getFileByGUID(String fileGUID) Retrieve a FolderProperties asset by its unique identifier (GUID).
DataFileElement	getFileByPathName(String pathName) Retrieve a folder by its fully qualified path name.
FileFolderElement	getFolderByGUID(String folderGUID) Retrieve a FolderProperties asset by its unique identifier (GUID).
FileFolderElement	getFolderByPathName(String pathName) Retrieve a folder by its fully qualified path name.
List<DataFileElement>	getFolderFiles(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 parentFolderGUID, int startFrom, int pageSize) Return the list of folders nested inside a folder.
List<DataFileElement>	getTopLevelDataFiles(String fileSystemGUID, int startFrom, int pageSize) Return the list of folders nested inside a folder.
List<FileFolderElement>	getTopLevelFolders(String fileSystemGUID, int startFrom, int pageSize) Return the list of folders linked to the file server capability.
void	registerListener(DataManagerEventListener listener) Register a listener object that will be passed each of the events published by the Data Manager OMAS.
void	updateDataFileInCatalog(String dataFileGUID, boolean isMergeUpdate, DataFileProperties dataFileProperties) Update the file asset description in the catalog.
void	updateDataFolderInCatalog(String dataFolderGUID, boolean isMergeUpdate, FileFolderProperties fileFolderProperties) Update the data folder asset description in the catalog.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilesIntegratorContext

public FilesIntegratorContext(FilesAndFoldersClient client,
                              DataManagerEventClient eventClient,
                              String userId,
                              String fileServerCapabilityGUID,
                              String fileServerCapabilityName)

Create a new client with no authentication embedded in the HTTP request.

Parameters:

client - client to map request to

eventClient - client to register for events

userId - integration daemon's userId

fileServerCapabilityGUID - unique identifier of the software server capability for the file manager (or null)

fileServerCapabilityName - unique name of the software server capability for the file manager (or null)

Method Detail

registerListener

public void registerListener(DataManagerEventListener listener)
                      throws InvalidParameterException,
                             ConnectionCheckedException,
                             ConnectorCheckedException,
                             PropertyServerException,
                             UserNotAuthorizedException

Register a listener object that will be passed each of the events published by the Data Manager OMAS.

Parameters:

listener - listener object

Throws:

InvalidParameterException - one of the parameters is null or invalid.

ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.

ConnectorCheckedException - there are errors in the initialization of the connector.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

createNestedFolders

public List<String> createNestedFolders(String parentGUID,
                                        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:

parentGUID - unique identifier of root object to connect the folder to (fileSystemGUID or folderGUID)

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

public void attachTopLevelFolder(String fileSystemGUID,
                                 String folderGUID)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

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

Parameters:

fileSystemGUID - unique identifier of the file system

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

public void detachTopLevelFolder(String fileSystemGUID,
                                 String folderGUID)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Removed the link between a folder and a file system.

Parameters:

fileSystemGUID - unique identifier of the file system

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

public List<String> addDataFileToCatalog(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:

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 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

addDataFileToCatalogFromTemplate

public List<String> addDataFileToCatalogFromTemplate(String templateGUID,
                                                     TemplateProperties templateProperties)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException

Add an asset description a file based on the content of a template object. Link this new asset 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:

templateGUID - unique identifier of the file asset to copy

templateProperties - override properties for the 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

updateDataFileInCatalog

public void updateDataFileInCatalog(String dataFileGUID,
                                    boolean isMergeUpdate,
                                    DataFileProperties dataFileProperties)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Update the file asset description in the catalog.

Parameters:

dataFileGUID - unique identifier of the data file asset

isMergeUpdate - should the supplied properties completely override the existing properties or augment them?

dataFileProperties - properties for the asset

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

archiveDataFileInCatalog

public void archiveDataFileInCatalog(String dataFileGUID,
                                     ArchiveProperties archiveProperties)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Mark the file asset description in the catalog as archived.

Parameters:

dataFileGUID - unique identifier of the data file asset

archiveProperties - properties to help locate the archive copy

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

deleteDataFileFromCatalog

public void deleteDataFileFromCatalog(String dataFileGUID,
                                      String fullPathname)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Remove the file asset description from the catalog.

Parameters:

dataFileGUID - unique identifier of the data file asset

fullPathname - unique path and file name for file

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addDataFolderToCatalog

public List<String> addDataFolderToCatalog(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:

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

addDataFolderToCatalogFromTemplate

public List<String> addDataFolderToCatalogFromTemplate(String templateGUID,
                                                       TemplateProperties templateProperties)
                                                throws InvalidParameterException,
                                                       UserNotAuthorizedException,
                                                       PropertyServerException

Add an asset description a file based on the content of a template object. Link this new asset 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:

templateGUID - unique identifier of the file asset to copy

templateProperties - override properties for the 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

updateDataFolderInCatalog

public void updateDataFolderInCatalog(String dataFolderGUID,
                                      boolean isMergeUpdate,
                                      FileFolderProperties fileFolderProperties)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Update the data folder asset description in the catalog.

Parameters:

dataFolderGUID - unique identifier of the data folder asset

isMergeUpdate - should the supplied properties completely override the existing properties or augment them?

fileFolderProperties - properties for the asset

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

archiveDataFolderInCatalog

public void archiveDataFolderInCatalog(String dataFolderGUID,
                                       ArchiveProperties archiveProperties)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

Mark the data folder asset description in the catalog as archived.

Parameters:

dataFolderGUID - unique identifier of the data folder asset

archiveProperties - properties to help locate the archive copy

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

attachDataFileAssetToFolder

public void attachDataFileAssetToFolder(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:

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

public void detachDataFileAssetFromFolder(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:

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

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

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

Parameters:

folderGUID - unique identifier used to locate the folder

Returns:

Folder properties

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getFolderByPathName

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

Retrieve a folder by its fully qualified path name.

Parameters:

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

public List<FileFolderElement> getTopLevelFolders(String fileSystemGUID,
                                                  int startFrom,
                                                  int pageSize)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException

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

Parameters:

fileSystemGUID - unique identifier of the software server capability representing the 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

getNestedFolders

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

Return the list of folders nested inside a folder.

Parameters:

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

public List<DataFileElement> getTopLevelDataFiles(String fileSystemGUID,
                                                  int startFrom,
                                                  int pageSize)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException

Return the list of folders nested inside a folder.

Parameters:

fileSystemGUID - unique identifier of the software server capability representing the file system

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

public List<DataFileElement> getFolderFiles(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:

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

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

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

Parameters:

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

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

Retrieve a folder by its fully qualified path name.

Parameters:

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