org.odpi.openmetadata.accessservices.assetowner.client

Class FileSystemAssetOwner

java.lang.Object

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.client.ConnectedAssetClientBase

org.odpi.openmetadata.accessservices.assetowner.client.AssetOwner

org.odpi.openmetadata.accessservices.assetowner.client.FileSystemAssetOwner

All Implemented Interfaces:

AssetClassificationInterface, AssetDecommissioningInterface, AssetKnowledgeInterface, AssetOnboardingFileSystem, AssetOnboardingInterface, AssetReviewInterface

public class FileSystemAssetOwner
extends AssetOwner
implements AssetOnboardingFileSystem

FileSystemAssetOwner provides specialist methods for onboarding details of a file system and the files within it. At the top level is a file system. It can have nested Folders attached and inside the folders are the files.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.client.ConnectedAssetClientBase

auditLog, invalidParameterHandler, nullRequestBody, serverName, serverPlatformRootURL

Constructor Summary

Constructors

Constructor and Description
FileSystemAssetOwner(String serverName, String serverPlatformRootURL) Create a new client with no authentication embedded in the HTTP request.
FileSystemAssetOwner(String serverName, String serverPlatformRootURL, AuditLog auditLog) Create a new client with no authentication embedded in the HTTP request and an audit log.
FileSystemAssetOwner(String serverName, String serverPlatformRootURL, String userId, String password) Create a new client that passes userId and password in each HTTP request.
FileSystemAssetOwner(String serverName, String serverPlatformRootURL, 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>	addDataFileAssetToCatalog(String userId, String displayName, String description, String pathName) Creates a new data 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) Creates a new folder asset that is identified as a data asset.
void	attachDataFileAssetToFolder(String userId, String folderGUID, String fileGUID) Link an existing file asset to a folder.
void	attachFolderToFileSystem(String userId, String fileSystemGUID, String folderGUID) Links a folder to a file system.
String	createFileSystemInCatalog(String userId, String uniqueName, String displayName, String description, String type, String version, String patchLevel, String source, String format, String encryption, Map<String,String> additionalProperties) Files live on a file system.
List<String>	createFolderStructureInCatalog(String userId, String pathName) Creates a new folder asset for each element in the pathName.
List<String>	createFolderStructureInCatalog(String userId, String anchorGUID, String pathName) 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) Remove a link between a file asset and a folder.
void	detachFolderFromFileSystem(String userId, String fileSystemGUID, String folderGUID) Removed the link between a folder and a file system.
FileSystem	getFileSystemByGUID(String userId, String fileSystemGUID) Retrieve a FileSystem asset by its unique identifier (GUID).
FileSystem	getFileSystemByUniqueName(String userId, String uniqueName) Retrieve a FileSystem asset by its unique name.
List<String>	getFileSystems(String userId, int startingFrom, int maxPageSize) Retrieve a list of defined FileSystems assets.
Folder	getFolderByGUID(String userId, String folderGUID) Retrieve a Folder asset by its unique identifier (GUID).
Folder	getFolderByPathName(String userId, String pathName) Retrieve a folder by its fully qualified path name.
List<String>	getFolderFiles(String userId, String folderGUID, int startingFrom, int maxPageSize) 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) Return the list of folders nested inside a folder.
void	moveDataFileInCatalog(String userId, String folderGUID, String fileGUID) 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) Move a data folder from its current parent folder to a new parent folder - this changes the folder's qualified name but not its unique identifier (guid).

Methods inherited from class org.odpi.openmetadata.accessservices.assetowner.client.AssetOwner

addAssetOrigin, addAssetToCatalog, addCombinedSchemaToAsset, addConnectionToAsset, addSchemaAttribute, addSchemaAttributes, addSchemaAttributesToSchema, addSchemaToAsset, addSchemaTypeToAsset, addSecurityTags, addSemanticAssignment, attachSchemaTypeToAsset, deleteAsset, deleteAssetSchemaType, detachSchemaTypeFromAsset, findAssets, getAssetProperties, getAssetsByName, getAssetSummary, getConnectorToAsset, getDiscoveryAnalysisReports, getDiscoveryReportAnnotations, getExtendedAnnotations, getTypesOfAnnotation, getTypesOfAnnotationWithDescriptions, getTypesOfAsset, getTypesOfAssetWithDescriptions, removeAssetOrigin, removeSecurityTags, removeSemanticAssignment, updateAssetOwner, updateAssetZones

Methods inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.client.ConnectedAssetClientBase

getAssetForConnection, getAssetProperties, getAssetSummary, getConnectionByGUID, getConnectionForAsset, getConnectorForConnection

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSystemAssetOwner

public FileSystemAssetOwner(String serverName,
                            String serverPlatformRootURL,
                            AuditLog auditLog)
                     throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request and an audit log.

Parameters:

serverName - name of the server to connect to

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

FileSystemAssetOwner

public FileSystemAssetOwner(String serverName,
                            String serverPlatformRootURL)
                     throws InvalidParameterException

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

Parameters:

serverName - name of the server to connect to

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

FileSystemAssetOwner

public FileSystemAssetOwner(String serverName,
                            String serverPlatformRootURL,
                            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. There is also an audit log destination.

Parameters:

serverName - name of the server to connect to

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

FileSystemAssetOwner

public FileSystemAssetOwner(String serverName,
                            String serverPlatformRootURL,
                            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

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

Method Detail

createFileSystemInCatalog

public String createFileSystemInCatalog(String userId,
                                        String uniqueName,
                                        String displayName,
                                        String description,
                                        String type,
                                        String version,
                                        String patchLevel,
                                        String source,
                                        String format,
                                        String encryption,
                                        Map<String,String> additionalProperties)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Files live on a file system. This method creates a top level anchor for a file system.

Specified by:

createFileSystemInCatalog in interface AssetOnboardingFileSystem

Parameters:

userId - calling user

uniqueName - qualified name for the file system

displayName - short display name

description - description of the file system

type - type of file system

version - version of file system

patchLevel - patchLevel of software supporting the file system

source - supplier of the software for this file system

format - format of files on this file system

encryption - encryption type - null for unencrypted

additionalProperties - additional properties

Returns:

unique identifier for the file system

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 anchorGUID,
                                                   String pathName)
                                            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".

Specified by:

createFolderStructureInCatalog in interface AssetOnboardingFileSystem

Parameters:

userId - calling user

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

createFolderStructureInCatalog

public List<String> createFolderStructureInCatalog(String userId,
                                                   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:

createFolderStructureInCatalog in interface AssetOnboardingFileSystem

Parameters:

userId - calling user

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

attachFolderToFileSystem

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

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

Specified by:

attachFolderToFileSystem in interface AssetOnboardingFileSystem

Parameters:

userId - calling user

fileSystemGUID - unique identifier of the file system in the catalog

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

detachFolderFromFileSystem

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

Removed the link between a folder and a file system.

Specified by:

detachFolderFromFileSystem in interface AssetOnboardingFileSystem

Parameters:

userId - calling user

fileSystemGUID - unique identifier of the file system in the catalog

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

addDataFileAssetToCatalog

public List<String> addDataFileAssetToCatalog(String userId,
                                              String displayName,
                                              String description,
                                              String pathName)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException

Creates a new data 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:

addDataFileAssetToCatalog in interface AssetOnboardingFileSystem

Parameters:

userId - calling user

displayName - display name for the file in the catalog

description - description of the file in the catalog

pathName - pathname of the data file

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

addDataFolderAssetToCatalog in interface AssetOnboardingFileSystem

Parameters:

userId - calling user

displayName - display name for the file in the catalog

description - description of the file in the catalog

pathName - pathname of the data folder

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

Parameters:

userId - calling user

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

Parameters:

userId - calling user

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

moveDataFileInCatalog

public void moveDataFileInCatalog(String userId,
                                  String folderGUID,
                                  String fileGUID)
                           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.

Specified by:

moveDataFileInCatalog in interface AssetOnboardingFileSystem

Parameters:

userId - calling user

folderGUID - new parent folder

fileGUID - unique identifier of the file to move

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

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

Specified by:

moveDataFolderInCatalog in interface AssetOnboardingFileSystem

Parameters:

userId - calling user

folderGUID - new parent folder

dataFolderGUID - unique identifier of the file to move

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getFileSystemByGUID

public FileSystem getFileSystemByGUID(String userId,
                                      String fileSystemGUID)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

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

Specified by:

getFileSystemByGUID in interface AssetOnboardingFileSystem

Parameters:

userId - calling user

fileSystemGUID - unique identifier used to locate the file system

Returns:

FileSystem properties

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getFileSystemByUniqueName

public FileSystem getFileSystemByUniqueName(String userId,
                                            String uniqueName)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException

Retrieve a FileSystem asset by its unique name.

Specified by:

getFileSystemByUniqueName in interface AssetOnboardingFileSystem

Parameters:

userId - calling user

uniqueName - unique identifier used to locate the folder

Returns:

Filesystem properties

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getFileSystems

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

Retrieve a list of defined FileSystems assets.

Specified by:

getFileSystems in interface AssetOnboardingFileSystem

Parameters:

userId - calling user

startingFrom - starting point in the list

maxPageSize - maximum number of results

Returns:

List of Filesystem unique identifiers

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getFolderByGUID

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

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

Specified by:

getFolderByGUID in interface AssetOnboardingFileSystem

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

Retrieve a folder by its fully qualified path name.

Specified by:

getFolderByPathName in interface AssetOnboardingFileSystem

Parameters:

userId - calling user

pathName - path name

Returns:

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

Return the list of folders nested inside a folder.

Specified by:

getNestedFolders in interface AssetOnboardingFileSystem

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

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

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

Specified by:

getFolderFiles in interface AssetOnboardingFileSystem

Parameters:

userId - calling user

folderGUID - unique identifier of the anchor folder

startingFrom - starting point in the list

maxPageSize - maximum number of results

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