org.odpi.openmetadata.accessservices.datamanager.client

Class FilesAndFoldersClient

java.lang.Object

org.odpi.openmetadata.accessservices.datamanager.client.FilesAndFoldersClient

All Implemented Interfaces:

FilesAndFoldersInterface

public class FilesAndFoldersClient
extends Object
implements FilesAndFoldersInterface

FilesAndFoldersClient is the client for managing the creation of files and folder assets.

Constructor Summary

Constructors

Constructor and Description
FilesAndFoldersClient(String serverName, String serverPlatformURLRoot) Create a new client with no authentication embedded in the HTTP request.
FilesAndFoldersClient(String serverName, String serverPlatformURLRoot, AuditLog auditLog) Create a new client with no authentication embedded in the HTTP request.
FilesAndFoldersClient(String serverName, String serverPlatformURLRoot, DataManagerRESTClient restClient, int maxPageSize, AuditLog auditLog) Create a new client that is to be used within an OMAG Server.
FilesAndFoldersClient(String serverName, String serverPlatformURLRoot, String userId, String password) Create a new client that passes userId and password in each HTTP request.
FilesAndFoldersClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog) Create a new client that passes userId and password in each HTTP request.

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 parentFolderGUID, 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilesAndFoldersClient

public FilesAndFoldersClient(String serverName,
                             String serverPlatformURLRoot,
                             AuditLog auditLog)
                      throws InvalidParameterException

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

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

FilesAndFoldersClient

public FilesAndFoldersClient(String serverName,
                             String serverPlatformURLRoot)
                      throws InvalidParameterException

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

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

FilesAndFoldersClient

public FilesAndFoldersClient(String serverName,
                             String serverPlatformURLRoot,
                             String userId,
                             String password,
                             AuditLog auditLog)
                      throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

FilesAndFoldersClient

public FilesAndFoldersClient(String serverName,
                             String serverPlatformURLRoot,
                             String userId,
                             String password)
                      throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

FilesAndFoldersClient

public FilesAndFoldersClient(String serverName,
                             String serverPlatformURLRoot,
                             DataManagerRESTClient restClient,
                             int maxPageSize,
                             AuditLog auditLog)
                      throws InvalidParameterException

Create a new client that is to be used within an OMAG Server.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

restClient - pre-initialized REST client

maxPageSize - pre-initialized parameter limit

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem with the information about the remote OMAS

Method Detail

createNestedFolders

public 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".

Specified by:

createNestedFolders in interface FilesAndFoldersInterface

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

public List<String> createNestedFolders(String userId,
                                        String fileServerCapabilityGUID,
                                        String fileServerCapabilityName,
                                        String parentFolderGUID,
                                        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".

Specified by:

createNestedFolders in interface FilesAndFoldersInterface

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

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

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

Specified by:

attachTopLevelFolder in interface FilesAndFoldersInterface

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

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

Removed the link between a folder and a file system.

Specified by:

detachTopLevelFolder in interface FilesAndFoldersInterface

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

public 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".

Specified by:

addDataFileToCatalog in interface FilesAndFoldersInterface

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

public 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".

Specified by:

addDataFolderToCatalog in interface FilesAndFoldersInterface

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

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

Specified by:

attachDataFileAssetToFolder in interface FilesAndFoldersInterface

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

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

Specified by:

detachDataFileAssetFromFolder in interface FilesAndFoldersInterface

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

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

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

Specified by:

getFolderByGUID in interface FilesAndFoldersInterface

Parameters:

userId - calling user

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 userId,
                                             String pathName)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException

Retrieve a folder by its fully qualified path name.

Specified by:

getFolderByPathName in interface FilesAndFoldersInterface

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

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

Specified by:

getTopLevelFolders in interface FilesAndFoldersInterface

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

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

Return the list of folders nested inside a folder.

Specified by:

getNestedFolders in interface FilesAndFoldersInterface

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

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

Specified by:

getTopLevelDataFiles in interface FilesAndFoldersInterface

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

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

Specified by:

getFolderFiles in interface FilesAndFoldersInterface

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

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

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

Specified by:

getFileByGUID in interface FilesAndFoldersInterface

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

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

Retrieve a folder by its fully qualified path name.

Specified by:

getFileByPathName in interface FilesAndFoldersInterface

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