FilesAndFoldersHandler (OCF Metadata Management Server-side Handlers 1.8 API)

java.lang.Object
- org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.FilesAndFoldersHandler

```
public class FilesAndFoldersHandler
extends Object
```
FilesAndFoldersHandler provides the support for managing catalog entries about files and folders.

Constructor Summary

Constructors
Constructor and Description
`FilesAndFoldersHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, List<String> supportedZones, AssetHandler assetHandler, SchemaTypeHandler schemaTypeHandler, SoftwareServerCapabilityHandler softwareServerCapabilityHandler)` Construct the handler information needed to interact with the repository services

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`addAvroFileToCatalog(String userId, String displayName, String description, String fullPath, String methodName)` Add a simple asset description linked to a connection object for an Avro file.
`List<String>`	`addCSVFileToCatalog(String userId, String displayName, String description, String fullPath, List<String> columnHeaders, Character delimiterCharacter, Character quoteCharacter, String methodName)` Add a simple asset description linked to a connection object for a CSV file.
`List<String>`	`addDataFileAssetToCatalog(String userId, String displayName, String description, String pathName, String methodName)` Creates a new file asset and links it to the folder structure implied in the path name.
`List<String>`	`addDataFolderAssetToCatalog(String userId, String displayName, String description, String pathName, String methodName)` Creates a new folder asset that is identified as a data asset.
`List<String>`	`addFileToCatalog(String userId, String fullPath, String displayName, String description, Map<String,String> additionalProperties, String connectorClassName, String typeName, Map<String,Object> extendedProperties, String methodName)` Add a simple asset description linked to a connection object for a file.
`void`	`attachDataFileAssetToFolder(String userId, String folderGUID, String fileGUID, String methodName)` Link an existing file asset to a folder.
`void`	`attachFolderToFileSystem(String userId, String fileSystemGUID, String folderGUID, String methodName)` Links a folder to a file system.
`List<String>`	`createFolderStructureInCatalog(String userId, String pathName, String methodName)` Creates a new folder asset for each element in the pathName.
`List<String>`	`createFolderStructureInCatalog(String userId, String anchorGUID, String pathName, String methodName)` Creates a new folder asset for each element in the pathName that is linked from the anchor entity.
`void`	`detachDataFileAssetFromFolder(String userId, String folderGUID, String fileGUID, String methodName)` Remove a link between a file asset and a folder.
`void`	`detachFolderFromFileSystem(String userId, String fileSystemGUID, String folderGUID, String methodName)` Removed the link between a folder and a file system.
`List<Asset>`	`findDataFileByName(String userId, String name, String methodName)` Retrieve data files by the supplied wildcard name.
`List<Asset>`	`findDataFileByPathName(String userId, String pathName, String methodName)` Retrieve a data file by its fully qualified path name.
`List<Asset>`	`findFolderByName(String userId, String name, String methodName)` Retrieve folder by the supplied wildcard name.
`List<Asset>`	`findFolderByPathName(String userId, String pathName, String methodName)` Retrieve a folder by its fully qualified path name.
`Connection`	`getAvroFileConnection(String fileName)` This method creates a connection for an Avro File.
`Connection`	`getCSVFileConnection(String fileName, List<String> columnHeaders, Character delimiterCharacter, Character quoteCharacter)` This method creates a connection for a CSV File.
`Asset`	`getDataFileByGUID(String userId, String dataFileGUID, String methodName)` Retrieve a Folder asset by its unique identifier (GUID).
`Asset`	`getDataFileByPathName(String userId, String pathName, String methodName)` Retrieve a data file by its fully qualified path name.
`Connection`	`getDataFileConnection(String fileName)` This method creates a connection for a File.
`Connection`	`getDataFolderConnection(String folderName)` This method creates a connection for a data folder.
`Asset`	`getFolderByGUID(String userId, String folderGUID, String methodName)` Retrieve a Folder asset by its unique identifier (GUID).
`Asset`	`getFolderByPathName(String userId, String pathName, String methodName)` Retrieve a folder by its fully qualified path name.
`List<String>`	`getFolderFiles(String userId, String folderGUID, int startingFrom, int maxPageSize, String methodName)` Get the files inside a folder - both those that are nested and those that are linked.
`List<String>`	`getNestedFolders(String userId, String anchorGUID, int startingFrom, int maxPageSize, String methodName)` Return the list of folders nested inside a folder.
`void`	`moveDataFileInCatalog(String userId, String folderGUID, String fileGUID, String methodName)` Move a file from its current parent folder to a new parent folder - this changes the file's qualified name but not its unique identifier (guid).
`void`	`moveDataFolderInCatalog(String userId, String folderGUID, String dataFolderGUID, String methodName)` Move a file from its current parent folder to a new parent folder - this changes the file's qualified name but not its unique identifier (guid).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FilesAndFoldersHandler

public FilesAndFoldersHandler(String serviceName,
                              String serverName,
                              InvalidParameterHandler invalidParameterHandler,
                              RepositoryHandler repositoryHandler,
                              OMRSRepositoryHelper repositoryHelper,
                              List<String> supportedZones,
                              AssetHandler assetHandler,
                              SchemaTypeHandler schemaTypeHandler,
                              SoftwareServerCapabilityHandler softwareServerCapabilityHandler)

Construct the handler information needed to interact with the repository services

Parameters:: serviceName - name of this service; serverName - name of the local server; supportedZones - list of supported zones; assetHandler - handler for assets; schemaTypeHandler - handler for schema elements; softwareServerCapabilityHandler - handler for file systems; invalidParameterHandler - handler for managing parameter errors; repositoryHandler - manages calls to the repository services; repositoryHelper - provides utilities for manipulating the repository services objects

Method Detail

createFolderStructureInCatalog

public List<String> createFolderStructureInCatalog(String userId,
                                                   String anchorGUID,
                                                   String pathName,
                                                   String methodName)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException

Creates a new folder asset for each element in the pathName that is linked from the anchor 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; anchorGUID - root object to connect the folder to; pathName - pathname of the folder (or folders); methodName - calling method
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

createFolderStructureInCatalog

public List<String> createFolderStructureInCatalog(String userId,
                                                   String pathName,
                                                   String methodName)
                                            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; pathName - pathname of the folder (or folders); methodName - calling method
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

attachFolderToFileSystem

public void attachFolderToFileSystem(String userId,
                                     String fileSystemGUID,
                                     String folderGUID,
                                     String methodName)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

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

Parameters:: userId - calling user; fileSystemGUID - unique identifier of the file system in the catalog; folderGUID - unique identifier of the folder in the catalog; methodName - calling method
Throws:: InvalidParameterException - one of the parameters is null or invalid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

detachFolderFromFileSystem

public void detachFolderFromFileSystem(String userId,
                                       String fileSystemGUID,
                                       String folderGUID,
                                       String methodName)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

Removed the link between a folder and a file system.

Parameters:: userId - calling user; fileSystemGUID - unique identifier of the file system in the catalog; folderGUID - unique identifier of the folder in the catalog; methodName - calling method
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 folderGUID,
                                        String fileGUID,
                                        String methodName)
                                 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; folderGUID - unique identifier of the folder; fileGUID - unique identifier of the file; methodName - calling method
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 folderGUID,
                                          String fileGUID,
                                          String methodName)
                                   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; folderGUID - unique identifier of the folder; fileGUID - unique identifier of the file; methodName - calling method
Throws:: InvalidParameterException - one of the parameters is null or invalid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

moveDataFileInCatalog

public void moveDataFileInCatalog(String userId,
                                  String folderGUID,
                                  String fileGUID,
                                  String methodName)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Move a file from its current parent folder to a new parent folder - this changes the file's qualified name but not its unique identifier (guid). Also the the endpoint in the connection object.

Parameters:: userId - calling user; folderGUID - new parent folder; fileGUID - unique identifier of the file to move; methodName - calling method
Throws:: InvalidParameterException - one of the parameters is null or invalid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

moveDataFolderInCatalog

public void moveDataFolderInCatalog(String userId,
                                    String folderGUID,
                                    String dataFolderGUID,
                                    String methodName)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Move a file from its current parent folder to a new parent folder - this changes the file's qualified name but not its unique identifier (guid). Also the the endpoint in the connection object.

Parameters:: userId - calling user; folderGUID - new parent folder; dataFolderGUID - unique identifier of the data folder to move; methodName - calling method
Throws:: InvalidParameterException - one of the parameters is null or invalid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

addDataFileAssetToCatalog
```
public List<String> addDataFileAssetToCatalog(String userId,
                                              String displayName,
                                              String description,
                                              String pathName,
                                              String methodName)
                                       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

displayName - display name for the folder in the catalog

description - description of the folder in the catalog

pathName - pathname of the file

methodName - calling method

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

addDataFolderAssetToCatalog
```
public List<String> addDataFolderAssetToCatalog(String userId,
                                                String displayName,
                                                String description,
                                                String pathName,
                                                String methodName)
                                         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

displayName - display name for the folder in the catalog

description - description of the folder in the catalog

pathName - pathname of the file

methodName - calling method

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

addFileToCatalog

public List<String> addFileToCatalog(String userId,
                                     String fullPath,
                                     String displayName,
                                     String description,
                                     Map<String,String> additionalProperties,
                                     String connectorClassName,
                                     String typeName,
                                     Map<String,Object> extendedProperties,
                                     String methodName)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Add a simple asset description linked to a connection object for a file.

Parameters:: userId - calling user (assumed to be the owner); fullPath - unique path and file name for file; displayName - short display name for file (defaults to the file name without the path); description - description of the file; additionalProperties - additional properties from the user; connectorClassName - qualified class name for the connector provider for this type of file; typeName - name of the type (default is File); extendedProperties - any additional properties for the file type; methodName - calling method
Returns:: list of GUIDs from the top level to the root of the pathname
Throws:: InvalidParameterException - full path or userId is null; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

addAvroFileToCatalog

public List<String> addAvroFileToCatalog(String userId,
                                         String displayName,
                                         String description,
                                         String fullPath,
                                         String methodName)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException

Add a simple asset description linked to a connection object for an Avro file.

Parameters:: userId - calling user (assumed to be the owner); displayName - display name for the file in the catalog; description - description of the file in the catalog; fullPath - full path of the file - used to access the file through the connector; methodName - calling method
Returns:: list of GUIDs from the top level to the root of the pathname
Throws:: InvalidParameterException - full path or userId is null; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

addCSVFileToCatalog

public List<String> addCSVFileToCatalog(String userId,
                                        String displayName,
                                        String description,
                                        String fullPath,
                                        List<String> columnHeaders,
                                        Character delimiterCharacter,
                                        Character quoteCharacter,
                                        String methodName)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Add a simple asset description linked to a connection object for a CSV file.

Parameters:: userId - calling user (assumed to be the owner); displayName - display name for the file in the catalog; description - description of the file in the catalog; fullPath - full path of the file - used to access the file through the connector; columnHeaders - does the first line of the file contain the column names. If not pass the list of column headers.; delimiterCharacter - what is the delimiter character - null for default of comma; quoteCharacter - what is the character to group a field that contains delimiter characters; methodName - calling method
Returns:: list of GUIDs from the top level to the root of the pathname
Throws:: InvalidParameterException - full path or userId is null; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

getDataFileConnection
```
public Connection getDataFileConnection(String fileName)
```
This method creates a connection for a File. The connection object provides the OCF with the properties to create an appropriate connector and the properties needed by the connector to access the asset. The Connection object includes a Connector Type object. This defines the type of connector to create. The Connection object also includes an Endpoint object. This is used by the connector to locate and connect to the Asset.

Parameters:

fileName - name of the file to connect to

Returns:

connection object

getCSVFileConnection
```
public Connection getCSVFileConnection(String fileName,
                                       List<String> columnHeaders,
                                       Character delimiterCharacter,
                                       Character quoteCharacter)
```
This method creates a connection for a CSV File. The connection object provides the OCF with the properties to create an appropriate connector and the properties needed by the connector to access the asset. The Connection object includes a Connector Type object. This defines the type of connector to create. The Connection object also includes an Endpoint object. This is used by the connector to locate and connect to the Asset.

Parameters:

fileName - name of the file to connect to

columnHeaders - boolean parameter defining if the column headers are included in the file

delimiterCharacter - character used between the columns

quoteCharacter - character used to group text that includes the delimiter character

Returns:

connection object

getAvroFileConnection
```
public Connection getAvroFileConnection(String fileName)
```
This method creates a connection for an Avro File. The connection object provides the OCF with the properties to create an appropriate connector and the properties needed by the connector to access the asset. The Connection object includes a Connector Type object. This defines the type of connector to create. The Connection object also includes an Endpoint object. This is used by the connector to locate and connect to the Asset.

Parameters:

fileName - name of the file to connect to

Returns:

connection object

getDataFolderConnection
```
public Connection getDataFolderConnection(String folderName)
```
This method creates a connection for a data folder. The connection object provides the OCF with the properties to create an appropriate connector and the properties needed by the connector to access the asset. The Connection object includes a Connector Type object. This defines the type of connector to create. The Connection object also includes an Endpoint object. This is used by the connector to locate and connect to the Asset.

Parameters:

folderName - name of the file to connect to

Returns:

connection object

getFolderByGUID

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

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

Parameters:: userId - calling user; folderGUID - unique identifier used to locate the folder; methodName - calling method
Returns:: Folder properties
Throws:: InvalidParameterException - one of the parameters is null or invalid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

getFolderByPathName

public Asset getFolderByPathName(String userId,
                                 String pathName,
                                 String methodName)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Retrieve a folder by its fully qualified path name.

Parameters:: userId - calling user; pathName - path name; methodName - calling method
Returns:: Folder properties
Throws:: InvalidParameterException - one of the parameters is null or invalid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

findFolderByPathName

public List<Asset> findFolderByPathName(String userId,
                                        String pathName,
                                        String methodName)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Retrieve a folder by its fully qualified path name. In theory there should be none or one asset returned. However in complex environments, duplicates are possible.

Parameters:: userId - calling user; pathName - path name; methodName - calling method
Returns:: list of matching folder properties
Throws:: InvalidParameterException - one of the parameters is null or invalid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

findFolderByName

public List<Asset> findFolderByName(String userId,
                                    String name,
                                    String methodName)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Retrieve folder by the supplied wildcard name. The wildcard is specified using regular expressions (RegEx).

Parameters:: userId - calling user; name - wildcard name; methodName - calling method
Returns:: list of matching folder properties
Throws:: InvalidParameterException - one of the parameters is null or invalid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

getNestedFolders

public List<String> getNestedFolders(String userId,
                                     String anchorGUID,
                                     int startingFrom,
                                     int maxPageSize,
                                     String methodName)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Return the list of folders nested inside a folder.

Parameters:: userId - calling user; anchorGUID - unique identifier of the anchor folder or file system; startingFrom - starting point in the list; maxPageSize - maximum number of results; methodName - calling method
Returns:: list of folder unique identifiers (null means no nested folders)
Throws:: InvalidParameterException - one of the parameters is null or invalid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

getFolderFiles

public List<String> getFolderFiles(String userId,
                                   String folderGUID,
                                   int startingFrom,
                                   int maxPageSize,
                                   String methodName)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

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

Parameters:: userId - calling user; folderGUID - unique identifier of the anchor folder; startingFrom - starting point in the list; maxPageSize - maximum number of results; methodName - calling method
Returns:: list of file asset unique identifiers
Throws:: InvalidParameterException - one of the parameters is null or invalid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

getDataFileByGUID

public Asset getDataFileByGUID(String userId,
                               String dataFileGUID,
                               String methodName)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

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

Parameters:: userId - calling user; dataFileGUID - unique identifier used to locate the folder; methodName - calling method
Returns:: file properties
Throws:: InvalidParameterException - one of the parameters is null or invalid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

getDataFileByPathName

public Asset getDataFileByPathName(String userId,
                                   String pathName,
                                   String methodName)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Retrieve a data file by its fully qualified path name.

Parameters:: userId - calling user; pathName - path name; methodName - calling method
Returns:: file properties
Throws:: InvalidParameterException - one of the parameters is null or invalid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

findDataFileByPathName

public List<Asset> findDataFileByPathName(String userId,
                                          String pathName,
                                          String methodName)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException

Retrieve a data file by its fully qualified path name. In theory there should be none or one asset returned. However in complex environments, duplicates are possible

Parameters:: userId - calling user; pathName - path name; methodName - calling method
Returns:: list of matching file properties
Throws:: InvalidParameterException - one of the parameters is null or invalid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

findDataFileByName

public List<Asset> findDataFileByName(String userId,
                                      String name,
                                      String methodName)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Retrieve data files by the supplied wildcard name. The wildcard is specified using regular expressions (RegEx).

Parameters:: userId - calling user; name - wildcard name; methodName - calling method
Returns:: list of matching file properties
Throws:: InvalidParameterException - one of the parameters is null or invalid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

Class FilesAndFoldersHandler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FilesAndFoldersHandler

Method Detail

createFolderStructureInCatalog

createFolderStructureInCatalog

attachFolderToFileSystem

detachFolderFromFileSystem

attachDataFileAssetToFolder

detachDataFileAssetFromFolder

moveDataFileInCatalog

moveDataFolderInCatalog

addDataFileAssetToCatalog

addDataFolderAssetToCatalog

addFileToCatalog

addAvroFileToCatalog

addCSVFileToCatalog

getDataFileConnection

getCSVFileConnection

getAvroFileConnection

getDataFolderConnection

getFolderByGUID

getFolderByPathName

findFolderByPathName

findFolderByName

getNestedFolders

getFolderFiles

getDataFileByGUID

getDataFileByPathName

findDataFileByPathName

findDataFileByName