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	Description
`FilesIntegratorContext(FilesAndFoldersClient filesAndFoldersClient, ConnectionManagerClient connectionManagerClient, DataManagerEventClient eventClient, String userId, String fileServerCapabilityGUID, String fileServerCapabilityName)`	Create a new client with no authentication embedded in the HTTP request.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	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.
`void`	`clearAssetConnection(String assetGUID, String connectionGUID)`	Remove a relationship between an asset and its connection.
`void`	`clearConnectorType(String connectionGUID, String connectorTypeGUID)`	Remove a relationship between a connection and a connector type.
`void`	`clearEmbeddedConnection(String connectionGUID, String embeddedConnectionGUID)`	Remove a relationship between a virtual connection and an embedded connection.
`void`	`clearEndpoint(String connectionGUID, String endpointGUID)`	Remove a relationship between a connection and an endpoint.
`void`	`clearSchemaTypes(String schemaAttributeGUID)`	Remove the linked schema types from a schema attribute.
`String`	`createConnection(ConnectionProperties connectionProperties)`	Create a new metadata element to represent a connection.
`String`	`createConnectionFromTemplate(String templateGUID, TemplateProperties templateProperties)`	Create a new metadata element to represent a connection using an existing metadata element as a template.
`String`	`createEndpoint(EndpointProperties endpointProperties)`	Create a new metadata element to represent an endpoint
`String`	`createEndpointFromTemplate(String networkAddress, String templateGUID, TemplateProperties templateProperties)`	Create a new metadata element to represent a endpoint using an existing metadata element as a template.
`String`	`createEnumSchemaType(EnumSchemaTypeProperties schemaTypeProperties, String validValuesSetGUID)`	Create a new metadata element to represent a schema type that has a fixed set of values that are described by a valid value set.
`String`	`createLiteralSchemaType(LiteralSchemaTypeProperties schemaTypeProperties)`	Create a new metadata element to represent a schema type that has a fixed value.
`String`	`createMapSchemaType(MapSchemaTypeProperties schemaTypeProperties, String mapFromSchemaTypeGUID, String mapToSchemaTypeGUID)`	Create a new metadata element to represent a schema type.
`List<String>`	`createNestedFolders(String parentGUID, String pathName)`	Creates a new folder asset for each element in the pathName.
`String`	`createPrimitiveSchemaType(PrimitiveSchemaTypeProperties schemaTypeProperties)`	Create a new metadata element to represent a primitive schema type such as a string, integer or character.
`String`	`createSchemaAttribute(String schemaElementGUID, SchemaAttributeProperties schemaAttributeProperties)`	Create a new metadata element to represent a schema attribute.
`String`	`createSchemaAttributeFromTemplate(String schemaElementGUID, String templateGUID, TemplateProperties templateProperties)`	Create a new metadata element to represent a schema attribute using an existing metadata element as a template.
`String`	`createSchemaTypeChoice(SchemaTypeChoiceProperties schemaTypeProperties, List<String> schemaTypeOptionGUIDs)`	Create a new metadata element to represent a list of possible schema types that can be used for the attached schema attribute.
`String`	`createSchemaTypeFromTemplate(String templateGUID, TemplateProperties templateProperties)`	Create a new metadata element to represent a schema type using an existing metadata element as a template.
`String`	`createStructSchemaType(StructSchemaTypeProperties schemaTypeProperties)`	Create a new metadata element to represent a schema type.
`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.
`List<ConnectionElement>`	`findConnections(String searchString, int startFrom, int pageSize)`	Retrieve the list of metadata elements that contain the search string.
`List<ConnectorTypeElement>`	`findConnectorTypes(String searchString, int startFrom, int pageSize)`	Retrieve the list of connector type metadata elements that contain the search string.
`List<EndpointElement>`	`findEndpoints(String searchString, int startFrom, int pageSize)`	Retrieve the list of endpoint metadata elements that contain the search string.
`List<SchemaAttributeElement>`	`findSchemaAttributes(String searchString, String typeName, int startFrom, int pageSize)`	Retrieve the list of schema attribute metadata elements that contain the search string.
`List<SchemaTypeElement>`	`findSchemaType(String searchString, String typeName, int startFrom, int pageSize)`	Retrieve the list of schema type metadata elements that contain the search string.
`List<ValidValueSetElement>`	`findValidValueSet(String searchString, int startFrom, int pageSize)`	Retrieve the list of valid value set metadata elements that contain the search string.
`ConnectionElement`	`getConnectionByGUID(String connectionGUID)`	Retrieve the metadata element with the supplied unique identifier.
`List<ConnectionElement>`	`getConnectionsByName(String name, int startFrom, int pageSize)`	Retrieve the list of metadata elements with a matching qualified or display name.
`ConnectorTypeElement`	`getConnectorTypeByGUID(String connectorTypeGUID)`	Retrieve the connector type metadata element with the supplied unique identifier.
`List<ConnectorTypeElement>`	`getConnectorTypesByName(String name, int startFrom, int pageSize)`	Retrieve the list of connector type metadata elements with a matching qualified or display name.
`EndpointElement`	`getEndpointByGUID(String endpointGUID)`	Retrieve the endpoint metadata element with the supplied unique identifier.
`List<EndpointElement>`	`getEndpointsByName(String name, int startFrom, int pageSize)`	Retrieve the list of endpoint metadata elements with a matching qualified or display name.
`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<SchemaAttributeElement>`	`getNestedAttributes(String parentSchemaElementGUID, int startFrom, int pageSize)`	Retrieve the list of schema attributes associated with a StructSchemaType or nested underneath a schema attribute.
`List<FileFolderElement>`	`getNestedFolders(String parentFolderGUID, int startFrom, int pageSize)`	Return the list of folders nested inside a folder.
`SchemaAttributeElement`	`getSchemaAttributeByGUID(String schemaAttributeGUID)`	Retrieve the schema attribute metadata element with the supplied unique identifier.
`List<SchemaAttributeElement>`	`getSchemaAttributesByName(String name, String typeName, int startFrom, int pageSize)`	Retrieve the list of schema attribute metadata elements with a matching qualified or display name.
`SchemaTypeElement`	`getSchemaTypeByGUID(String schemaTypeGUID)`	Retrieve the schema type metadata element with the supplied unique identifier.
`List<SchemaTypeElement>`	`getSchemaTypeByName(String name, String typeName, int startFrom, int pageSize)`	Retrieve the list of schema type metadata elements with a matching qualified or display name.
`SchemaTypeElement`	`getSchemaTypeForElement(String parentElementGUID, String parentElementTypeName)`	Return the schema type associated with a specific open metadata element (data asset, process or port).
`ElementHeader`	`getSchemaTypeParent(String schemaTypeGUID)`	Retrieve the header of the metadata element connected to a schema type.
`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.
`List<ValidValueSetElement>`	`getValidValueSetByName(String name, int startFrom, int pageSize)`	Retrieve the list of valid value set metadata elements with a matching qualified or display name.
`void`	`registerListener(DataManagerEventListener listener)`	Register a listener object that will be passed each of the events published by the Data Manager OMAS.
`void`	`removeConnection(String connectionGUID)`	Remove the metadata element representing a connection.
`void`	`removeEndpoint(String endpointGUID)`	Remove the metadata element representing a endpoint.
`void`	`removeSchemaAttribute(String schemaAttributeGUID)`	Remove the metadata element representing a schema attribute.
`void`	`removeSchemaType(String schemaTypeGUID)`	Remove the metadata element representing a schema type.
`void`	`setupAssetConnection(String assetGUID, String assetSummary, String connectionGUID)`	Create a relationship between an asset and its connection.
`void`	`setupConnectorType(String connectionGUID, String connectorTypeGUID)`	Create a relationship between a connection and a connector type.
`void`	`setupEmbeddedConnection(String connectionGUID, int position, String displayName, Map<String,Object> arguments, String embeddedConnectionGUID)`	Create a relationship between a virtual connection and an embedded connection.
`void`	`setupEndpoint(String connectionGUID, String endpointGUID)`	Create a relationship between a connection and an endpoint.
`void`	`setupSchemaType(String relationshipTypeName, String schemaAttributeGUID, String schemaTypeGUID)`	Connect a schema type to a schema attribute.
`void`	`updateConnection(String connectionGUID, boolean isMergeUpdate, ConnectionProperties connectionProperties)`	Update the metadata element representing a connection.
`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.
`void`	`updateEndpoint(boolean isMergeUpdate, String endpointGUID, EndpointProperties endpointProperties)`	Update the metadata element representing a endpoint.
`void`	`updateSchemaAttribute(String schemaAttributeGUID, boolean isMergeUpdate, SchemaAttributeProperties schemaAttributeProperties)`	Update the properties of the metadata element representing a schema attribute.
`void`	`updateSchemaType(String schemaTypeGUID, boolean isMergeUpdate, SchemaTypeProperties schemaTypeProperties)`	Update the metadata element representing a schema type.

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

- Constructor Detail
  - FilesIntegratorContext
```
public FilesIntegratorContext(FilesAndFoldersClient filesAndFoldersClient,
                              ConnectionManagerClient connectionManagerClient,
                              DataManagerEventClient eventClient,
                              String userId,
                              String fileServerCapabilityGUID,
                              String fileServerCapabilityName)
```
    Create a new client with no authentication embedded in the HTTP request.
    
    Parameters:
    
    filesAndFoldersClient - client to map request to
    
    connectionManagerClient - client for managing connections
    
    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
  - createPrimitiveSchemaType
```
public String createPrimitiveSchemaType(PrimitiveSchemaTypeProperties schemaTypeProperties)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException
```
    Create a new metadata element to represent a primitive schema type such as a string, integer or character.
    
    Parameters:
    
    schemaTypeProperties - properties about the schema type to store
    
    Returns:
    
    unique identifier of the new schema type
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createLiteralSchemaType
```
public String createLiteralSchemaType(LiteralSchemaTypeProperties schemaTypeProperties)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException
```
    Create a new metadata element to represent a schema type that has a fixed value.
    
    Parameters:
    
    schemaTypeProperties - properties about the schema type to store
    
    Returns:
    
    unique identifier of the new schema type
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createEnumSchemaType
```
public String createEnumSchemaType(EnumSchemaTypeProperties schemaTypeProperties,
                                   String validValuesSetGUID)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException
```
    Create a new metadata element to represent a schema type that has a fixed set of values that are described by a valid value set.
    
    Parameters:
    
    schemaTypeProperties - properties about the schema type to store
    
    validValuesSetGUID - unique identifier of the valid values set to used
    
    Returns:
    
    unique identifier of the new schema type
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getValidValueSetByName
```
public List<ValidValueSetElement> getValidValueSetByName(String name,
                                                         int startFrom,
                                                         int pageSize)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         PropertyServerException
```
    Retrieve the list of valid value set metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
    
    Parameters:
    
    name - name to search for
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - findValidValueSet
```
public List<ValidValueSetElement> findValidValueSet(String searchString,
                                                    int startFrom,
                                                    int pageSize)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException
```
    Retrieve the list of valid value set metadata elements that contain the search string. The search string is treated as a regular expression.
    
    Parameters:
    
    searchString - string to find in the properties
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createStructSchemaType
```
public String createStructSchemaType(StructSchemaTypeProperties schemaTypeProperties)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException
```
    Create a new metadata element to represent a schema type.
    
    Parameters:
    
    schemaTypeProperties - properties about the schema type to store
    
    Returns:
    
    unique identifier of the new schema type
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createSchemaTypeChoice
```
public String createSchemaTypeChoice(SchemaTypeChoiceProperties schemaTypeProperties,
                                     List<String> schemaTypeOptionGUIDs)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException
```
    Create a new metadata element to represent a list of possible schema types that can be used for the attached schema attribute.
    
    Parameters:
    
    schemaTypeProperties - properties about the schema type to store
    
    schemaTypeOptionGUIDs - list of unique identifiers of schema types that represent the options to link to
    
    Returns:
    
    unique identifier of the new schema type
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createMapSchemaType
```
public String createMapSchemaType(MapSchemaTypeProperties schemaTypeProperties,
                                  String mapFromSchemaTypeGUID,
                                  String mapToSchemaTypeGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
```
    Create a new metadata element to represent a schema type.
    
    Parameters:
    
    schemaTypeProperties - properties about the schema type to store
    
    mapFromSchemaTypeGUID - unique identifier of the the domain of the map
    
    mapToSchemaTypeGUID - unique identifier of the the range of the map
    
    Returns:
    
    unique identifier of the new schema type
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createSchemaTypeFromTemplate
```
public String createSchemaTypeFromTemplate(String templateGUID,
                                           TemplateProperties templateProperties)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
```
    Create a new metadata element to represent a schema type using an existing metadata element as a template.
    
    Parameters:
    
    templateGUID - unique identifier of the metadata element to copy
    
    templateProperties - properties that override the template
    
    Returns:
    
    unique identifier of the new schema type
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - updateSchemaType
```
public void updateSchemaType(String schemaTypeGUID,
                             boolean isMergeUpdate,
                             SchemaTypeProperties schemaTypeProperties)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
```
    Update the metadata element representing a schema type. It is possible to use the subtype property classes or set up specialized properties in extended properties.
    
    Parameters:
    
    schemaTypeGUID - unique identifier of the metadata element to update
    
    isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
    
    schemaTypeProperties - new properties for the metadata element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - removeSchemaType
```
public void removeSchemaType(String schemaTypeGUID)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
```
    Remove the metadata element representing a schema type.
    
    Parameters:
    
    schemaTypeGUID - unique identifier of the metadata element to remove
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - findSchemaType
```
public List<SchemaTypeElement> findSchemaType(String searchString,
                                              String typeName,
                                              int startFrom,
                                              int pageSize)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException
```
    Retrieve the list of schema type metadata elements that contain the search string. The search string is treated as a regular expression.
    
    Parameters:
    
    searchString - string to find in the properties
    
    typeName - optional type name for the schema type - used to restrict the search results
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getSchemaTypeForElement
```
public SchemaTypeElement getSchemaTypeForElement(String parentElementGUID,
                                                 String parentElementTypeName)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException
```
    Return the schema type associated with a specific open metadata element (data asset, process or port).
    
    Parameters:
    
    parentElementGUID - unique identifier of the open metadata element that this schema type is connected to
    
    parentElementTypeName - unique type name of the open metadata element that this schema type is connected to
    
    Returns:
    
    metadata element describing the schema type associated with the requested parent element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getSchemaTypeByName
```
public List<SchemaTypeElement> getSchemaTypeByName(String name,
                                                   String typeName,
                                                   int startFrom,
                                                   int pageSize)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException
```
    Retrieve the list of schema type metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
    
    Parameters:
    
    name - name to search for
    
    typeName - optional type name for the schema type - used to restrict the search results
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getSchemaTypeByGUID
```
public SchemaTypeElement getSchemaTypeByGUID(String schemaTypeGUID)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException
```
    Retrieve the schema type metadata element with the supplied unique identifier.
    
    Parameters:
    
    schemaTypeGUID - unique identifier of the requested metadata element
    
    Returns:
    
    requested metadata element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getSchemaTypeParent
```
public ElementHeader getSchemaTypeParent(String schemaTypeGUID)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException
```
    Retrieve the header of the metadata element connected to a schema type.
    
    Parameters:
    
    schemaTypeGUID - unique identifier of the requested metadata element
    
    Returns:
    
    header for parent element (data asset, process, port)
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createSchemaAttribute
```
public String createSchemaAttribute(String schemaElementGUID,
                                    SchemaAttributeProperties schemaAttributeProperties)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException
```
    Create a new metadata element to represent a schema attribute.
    
    Parameters:
    
    schemaElementGUID - unique identifier of the schemaType or Schema Attribute where the schema attribute is nested underneath
    
    schemaAttributeProperties - properties for the schema attribute
    
    Returns:
    
    unique identifier of the new metadata element for the schema attribute
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createSchemaAttributeFromTemplate
```
public String createSchemaAttributeFromTemplate(String schemaElementGUID,
                                                String templateGUID,
                                                TemplateProperties templateProperties)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException
```
    Create a new metadata element to represent a schema attribute using an existing metadata element as a template.
    
    Parameters:
    
    schemaElementGUID - unique identifier of the schemaType or Schema Attribute where the schema attribute is connected to
    
    templateGUID - unique identifier of the metadata element to copy
    
    templateProperties - properties that override the template
    
    Returns:
    
    unique identifier of the new metadata element for the schema attribute
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - setupSchemaType
```
public void setupSchemaType(String relationshipTypeName,
                            String schemaAttributeGUID,
                            String schemaTypeGUID)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException
```
    Connect a schema type to a schema attribute.
    
    Parameters:
    
    relationshipTypeName - name of relationship to create
    
    schemaAttributeGUID - unique identifier of the schema attribute
    
    schemaTypeGUID - unique identifier of the schema type to connect
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - clearSchemaTypes
```
public void clearSchemaTypes(String schemaAttributeGUID)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
```
    Remove the linked schema types from a schema attribute.
    
    Parameters:
    
    schemaAttributeGUID - unique identifier of the schema attribute
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - updateSchemaAttribute
```
public void updateSchemaAttribute(String schemaAttributeGUID,
                                  boolean isMergeUpdate,
                                  SchemaAttributeProperties schemaAttributeProperties)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
```
    Update the properties of the metadata element representing a schema attribute.
    
    Parameters:
    
    schemaAttributeGUID - unique identifier of the schema attribute to update
    
    isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
    
    schemaAttributeProperties - new properties for the schema attribute
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - removeSchemaAttribute
```
public void removeSchemaAttribute(String schemaAttributeGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
```
    Remove the metadata element representing a schema attribute.
    
    Parameters:
    
    schemaAttributeGUID - unique identifier of the metadata element to remove
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - findSchemaAttributes
```
public List<SchemaAttributeElement> findSchemaAttributes(String searchString,
                                                         String typeName,
                                                         int startFrom,
                                                         int pageSize)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         PropertyServerException
```
    Retrieve the list of schema attribute metadata elements that contain the search string. The search string is treated as a regular expression.
    
    Parameters:
    
    searchString - string to find in the properties
    
    typeName - optional type name for the schema type - used to restrict the search results
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getNestedAttributes
```
public List<SchemaAttributeElement> getNestedAttributes(String parentSchemaElementGUID,
                                                        int startFrom,
                                                        int pageSize)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        PropertyServerException
```
    Retrieve the list of schema attributes associated with a StructSchemaType or nested underneath a schema attribute.
    
    Parameters:
    
    parentSchemaElementGUID - unique identifier of the schemaType of interest
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of associated metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getSchemaAttributesByName
```
public List<SchemaAttributeElement> getSchemaAttributesByName(String name,
                                                              String typeName,
                                                              int startFrom,
                                                              int pageSize)
                                                       throws InvalidParameterException,
                                                              UserNotAuthorizedException,
                                                              PropertyServerException
```
    Retrieve the list of schema attribute metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
    
    Parameters:
    
    name - name to search for
    
    typeName - optional type name for the schema type - used to restrict the search results
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getSchemaAttributeByGUID
```
public SchemaAttributeElement getSchemaAttributeByGUID(String schemaAttributeGUID)
                                                throws InvalidParameterException,
                                                       UserNotAuthorizedException,
                                                       PropertyServerException
```
    Retrieve the schema attribute metadata element with the supplied unique identifier.
    
    Parameters:
    
    schemaAttributeGUID - unique identifier of the requested metadata element
    
    Returns:
    
    matching metadata element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createConnection
```
public String createConnection(ConnectionProperties connectionProperties)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException
```
    Create a new metadata element to represent a connection.
    
    Parameters:
    
    connectionProperties - properties about the connection to store
    
    Returns:
    
    unique identifier of the new connection
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createConnectionFromTemplate
```
public String createConnectionFromTemplate(String templateGUID,
                                           TemplateProperties templateProperties)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
```
    Create a new metadata element to represent a connection using an existing metadata element as a template.
    
    Parameters:
    
    templateGUID - unique identifier of the metadata element to copy
    
    templateProperties - properties that override the template
    
    Returns:
    
    unique identifier of the new connection
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - updateConnection
```
public void updateConnection(String connectionGUID,
                             boolean isMergeUpdate,
                             ConnectionProperties connectionProperties)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
```
    Update the metadata element representing a connection. It is possible to use the subtype property classes or set up specialized properties in extended properties.
    
    Parameters:
    
    connectionGUID - unique identifier of the metadata element to update
    
    isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
    
    connectionProperties - new properties for the metadata element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - setupConnectorType
```
public void setupConnectorType(String connectionGUID,
                               String connectorTypeGUID)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException
```
    Create a relationship between a connection and a connector type.
    
    Parameters:
    
    connectionGUID - unique identifier of the connection
    
    connectorTypeGUID - unique identifier of the connector type
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - clearConnectorType
```
public void clearConnectorType(String connectionGUID,
                               String connectorTypeGUID)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException
```
    Remove a relationship between a connection and a connector type.
    
    Parameters:
    
    connectionGUID - unique identifier of the connection
    
    connectorTypeGUID - unique identifier of the connector type
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - setupEndpoint
```
public void setupEndpoint(String connectionGUID,
                          String endpointGUID)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException
```
    Create a relationship between a connection and an endpoint.
    
    Parameters:
    
    connectionGUID - unique identifier of the connection
    
    endpointGUID - unique identifier of the endpoint
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - clearEndpoint
```
public void clearEndpoint(String connectionGUID,
                          String endpointGUID)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException
```
    Remove a relationship between a connection and an endpoint.
    
    Parameters:
    
    connectionGUID - unique identifier of the connection
    
    endpointGUID - unique identifier of the endpoint
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - setupEmbeddedConnection
```
public void setupEmbeddedConnection(String connectionGUID,
                                    int position,
                                    String displayName,
                                    Map<String,Object> arguments,
                                    String embeddedConnectionGUID)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException
```
    Create a relationship between a virtual connection and an embedded connection.
    
    Parameters:
    
    connectionGUID - unique identifier of the virtual connection
    
    position - which order should this connection be processed
    
    arguments - What additional properties should be passed to the embedded connector via the configuration properties
    
    displayName - what does this connector signify?
    
    embeddedConnectionGUID - unique identifier of the embedded connection
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - clearEmbeddedConnection
```
public void clearEmbeddedConnection(String connectionGUID,
                                    String embeddedConnectionGUID)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException
```
    Remove a relationship between a virtual connection and an embedded connection.
    
    Parameters:
    
    connectionGUID - unique identifier of the virtual connection
    
    embeddedConnectionGUID - unique identifier of the embedded connection
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - setupAssetConnection
```
public void setupAssetConnection(String assetGUID,
                                 String assetSummary,
                                 String connectionGUID)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException
```
    Create a relationship between an asset and its connection.
    
    Parameters:
    
    assetGUID - unique identifier of the asset
    
    assetSummary - summary of the asset that is stored in the relationship between the asset and the connection.
    
    connectionGUID - unique identifier of the connection
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - clearAssetConnection
```
public void clearAssetConnection(String assetGUID,
                                 String connectionGUID)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException
```
    Remove a relationship between an asset and its connection.
    
    Parameters:
    
    assetGUID - unique identifier of the asset
    
    connectionGUID - unique identifier of the connection
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - removeConnection
```
public void removeConnection(String connectionGUID)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
```
    Remove the metadata element representing a connection.
    
    Parameters:
    
    connectionGUID - unique identifier of the metadata element to remove
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - findConnections
```
public List<ConnectionElement> findConnections(String searchString,
                                               int startFrom,
                                               int pageSize)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException
```
    Retrieve the list of metadata elements that contain the search string. The search string is treated as a regular expression.
    
    Parameters:
    
    searchString - string to find in the properties
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getConnectionsByName
```
public List<ConnectionElement> getConnectionsByName(String name,
                                                    int startFrom,
                                                    int pageSize)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException
```
    Retrieve the list of metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
    
    Parameters:
    
    name - name of the connection to retrieve
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getConnectionByGUID
```
public ConnectionElement getConnectionByGUID(String connectionGUID)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException
```
    Retrieve the metadata element with the supplied unique identifier.
    
    Parameters:
    
    connectionGUID - unique identifier of the requested metadata element
    
    Returns:
    
    requested metadata element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createEndpoint
```
public String createEndpoint(EndpointProperties endpointProperties)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
```
    Create a new metadata element to represent an endpoint
    
    Parameters:
    
    endpointProperties - properties about the endpoint to store
    
    Returns:
    
    unique identifier of the new endpoint
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createEndpointFromTemplate
```
public String createEndpointFromTemplate(String networkAddress,
                                         String templateGUID,
                                         TemplateProperties templateProperties)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException
```
    Create a new metadata element to represent a endpoint using an existing metadata element as a template.
    
    Parameters:
    
    networkAddress - location of the endpoint
    
    templateGUID - unique identifier of the metadata element to copy
    
    templateProperties - descriptive properties that override the template
    
    Returns:
    
    unique identifier of the new endpoint
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - updateEndpoint
```
public void updateEndpoint(boolean isMergeUpdate,
                           String endpointGUID,
                           EndpointProperties endpointProperties)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException
```
    Update the metadata element representing a endpoint. It is possible to use the subtype property classes or set up specialized properties in extended properties.
    
    Parameters:
    
    endpointGUID - unique identifier of the metadata element to update
    
    isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
    
    endpointProperties - new properties for the metadata element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - removeEndpoint
```
public void removeEndpoint(String endpointGUID)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException
```
    Remove the metadata element representing a endpoint.
    
    Parameters:
    
    endpointGUID - unique identifier of the metadata element to remove
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - findEndpoints
```
public List<EndpointElement> findEndpoints(String searchString,
                                           int startFrom,
                                           int pageSize)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
```
    Retrieve the list of endpoint metadata elements that contain the search string. The search string is treated as a regular expression.
    
    Parameters:
    
    searchString - string to find in the properties
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getEndpointsByName
```
public List<EndpointElement> getEndpointsByName(String name,
                                                int startFrom,
                                                int pageSize)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException
```
    Retrieve the list of endpoint metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
    
    Parameters:
    
    name - name to search for
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getEndpointByGUID
```
public EndpointElement getEndpointByGUID(String endpointGUID)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException
```
    Retrieve the endpoint metadata element with the supplied unique identifier.
    
    Parameters:
    
    endpointGUID - unique identifier of the requested metadata element
    
    Returns:
    
    requested metadata element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - findConnectorTypes
```
public List<ConnectorTypeElement> findConnectorTypes(String searchString,
                                                     int startFrom,
                                                     int pageSize)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException
```
    Retrieve the list of connector type metadata elements that contain the search string. The search string is treated as a regular expression.
    
    Parameters:
    
    searchString - string to find in the properties
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getConnectorTypesByName
```
public List<ConnectorTypeElement> getConnectorTypesByName(String name,
                                                          int startFrom,
                                                          int pageSize)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          PropertyServerException
```
    Retrieve the list of connector type metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
    
    Parameters:
    
    name - name to search for
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getConnectorTypeByGUID
```
public ConnectorTypeElement getConnectorTypeByGUID(String connectorTypeGUID)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException
```
    Retrieve the connector type metadata element with the supplied unique identifier.
    
    Parameters:
    
    connectorTypeGUID - unique identifier of the requested metadata element
    
    Returns:
    
    requested metadata element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)

Class FilesIntegratorContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FilesIntegratorContext

Method Detail

registerListener

createNestedFolders

attachTopLevelFolder

detachTopLevelFolder

addDataFileToCatalog

addDataFileToCatalogFromTemplate

updateDataFileInCatalog

archiveDataFileInCatalog

deleteDataFileFromCatalog

addDataFolderToCatalog

addDataFolderToCatalogFromTemplate

updateDataFolderInCatalog

archiveDataFolderInCatalog

attachDataFileAssetToFolder

detachDataFileAssetFromFolder

getFolderByGUID

getFolderByPathName

getTopLevelFolders

getNestedFolders

getTopLevelDataFiles

getFolderFiles

getFileByGUID

getFileByPathName

createPrimitiveSchemaType

createLiteralSchemaType

createEnumSchemaType

getValidValueSetByName

findValidValueSet

createStructSchemaType

createSchemaTypeChoice

createMapSchemaType

createSchemaTypeFromTemplate

updateSchemaType

removeSchemaType

findSchemaType

getSchemaTypeForElement

getSchemaTypeByName

getSchemaTypeByGUID

getSchemaTypeParent

createSchemaAttribute

createSchemaAttributeFromTemplate

setupSchemaType

clearSchemaTypes

updateSchemaAttribute

removeSchemaAttribute

findSchemaAttributes

getNestedAttributes

getSchemaAttributesByName

getSchemaAttributeByGUID

createConnection

createConnectionFromTemplate

updateConnection

setupConnectorType

clearConnectorType

setupEndpoint

clearEndpoint

setupEmbeddedConnection

clearEmbeddedConnection

setupAssetConnection

clearAssetConnection

removeConnection

findConnections

getConnectionsByName

getConnectionByGUID

createEndpoint

createEndpointFromTemplate

updateEndpoint

removeEndpoint

findEndpoints

getEndpointsByName

getEndpointByGUID

findConnectorTypes

getConnectorTypesByName