Class FilesIntegratorContext


  • public class FilesIntegratorContext
    extends java.lang.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
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.List<java.lang.String> addDataFileToCatalog​(DataFileProperties dataFileProperties, java.lang.String connectorProviderName)
      Creates a new file asset and links it to the folder structure implied in the path name.
      java.util.List<java.lang.String> addDataFileToCatalogFromTemplate​(java.lang.String templateGUID, TemplateProperties templateProperties)
      Add an asset description a file based on the content of a template object.
      java.util.List<java.lang.String> addDataFolderToCatalog​(FileFolderProperties fileFolderProperties, java.lang.String connectorProviderName)
      Creates a new folder asset that is identified as a data asset.
      java.util.List<java.lang.String> addDataFolderToCatalogFromTemplate​(java.lang.String templateGUID, TemplateProperties templateProperties)
      Add an asset description a file based on the content of a template object.
      void archiveDataFileInCatalog​(java.lang.String dataFileGUID, ArchiveProperties archiveProperties)
      Mark the file asset description in the catalog as archived.
      void archiveDataFolderInCatalog​(java.lang.String dataFolderGUID, ArchiveProperties archiveProperties)
      Mark the data folder asset description in the catalog as archived.
      void attachDataFileAssetToFolder​(java.lang.String folderGUID, java.lang.String fileGUID)
      Link an existing file asset to a folder.
      void attachTopLevelFolder​(java.lang.String fileSystemGUID, java.lang.String folderGUID)
      Links a folder to a file system.
      void clearAssetConnection​(java.lang.String assetGUID, java.lang.String connectionGUID)
      Remove a relationship between an asset and its connection.
      void clearConnectorType​(java.lang.String connectionGUID, java.lang.String connectorTypeGUID)
      Remove a relationship between a connection and a connector type.
      void clearEmbeddedConnection​(java.lang.String connectionGUID, java.lang.String embeddedConnectionGUID)
      Remove a relationship between a virtual connection and an embedded connection.
      void clearEndpoint​(java.lang.String connectionGUID, java.lang.String endpointGUID)
      Remove a relationship between a connection and an endpoint.
      void clearSchemaTypes​(java.lang.String schemaAttributeGUID)
      Remove the linked schema types from a schema attribute.
      java.lang.String createConnection​(ConnectionProperties connectionProperties)
      Create a new metadata element to represent a connection.
      java.lang.String createConnectionFromTemplate​(java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a connection using an existing metadata element as a template.
      java.lang.String createEndpoint​(EndpointProperties endpointProperties)
      Create a new metadata element to represent an endpoint
      java.lang.String createEndpointFromTemplate​(java.lang.String networkAddress, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a endpoint using an existing metadata element as a template.
      java.lang.String createEnumSchemaType​(EnumSchemaTypeProperties schemaTypeProperties, java.lang.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.
      java.lang.String createLiteralSchemaType​(LiteralSchemaTypeProperties schemaTypeProperties)
      Create a new metadata element to represent a schema type that has a fixed value.
      java.lang.String createMapSchemaType​(MapSchemaTypeProperties schemaTypeProperties, java.lang.String mapFromSchemaTypeGUID, java.lang.String mapToSchemaTypeGUID)
      Create a new metadata element to represent a schema type.
      java.util.List<java.lang.String> createNestedFolders​(java.lang.String parentGUID, java.lang.String pathName)
      Creates a new folder asset for each element in the pathName.
      java.lang.String createPrimitiveSchemaType​(PrimitiveSchemaTypeProperties schemaTypeProperties)
      Create a new metadata element to represent a primitive schema type such as a string, integer or character.
      java.lang.String createSchemaAttribute​(java.lang.String schemaElementGUID, SchemaAttributeProperties schemaAttributeProperties)
      Create a new metadata element to represent a schema attribute.
      java.lang.String createSchemaAttributeFromTemplate​(java.lang.String schemaElementGUID, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a schema attribute using an existing metadata element as a template.
      java.lang.String createSchemaTypeChoice​(SchemaTypeChoiceProperties schemaTypeProperties, java.util.List<java.lang.String> schemaTypeOptionGUIDs)
      Create a new metadata element to represent a list of possible schema types that can be used for the attached schema attribute.
      java.lang.String createSchemaTypeFromTemplate​(java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a schema type using an existing metadata element as a template.
      java.lang.String createStructSchemaType​(StructSchemaTypeProperties schemaTypeProperties)
      Create a new metadata element to represent a schema type.
      void deleteDataFileFromCatalog​(java.lang.String dataFileGUID, java.lang.String fullPathname)
      Remove the file asset description from the catalog.
      void detachDataFileAssetFromFolder​(java.lang.String folderGUID, java.lang.String fileGUID)
      Remove a link between a file asset and a folder.
      void detachTopLevelFolder​(java.lang.String fileSystemGUID, java.lang.String folderGUID)
      Removed the link between a folder and a file system.
      java.util.List<ConnectionElement> findConnections​(java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of metadata elements that contain the search string.
      java.util.List<ConnectorTypeElement> findConnectorTypes​(java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of connector type metadata elements that contain the search string.
      java.util.List<EndpointElement> findEndpoints​(java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of endpoint metadata elements that contain the search string.
      java.util.List<SchemaAttributeElement> findSchemaAttributes​(java.lang.String searchString, java.lang.String typeName, int startFrom, int pageSize)
      Retrieve the list of schema attribute metadata elements that contain the search string.
      java.util.List<SchemaTypeElement> findSchemaType​(java.lang.String searchString, java.lang.String typeName, int startFrom, int pageSize)
      Retrieve the list of schema type metadata elements that contain the search string.
      java.util.List<ValidValueSetElement> findValidValueSet​(java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of valid value set metadata elements that contain the search string.
      ConnectionElement getConnectionByGUID​(java.lang.String connectionGUID)
      Retrieve the metadata element with the supplied unique identifier.
      java.util.List<ConnectionElement> getConnectionsByName​(java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of metadata elements with a matching qualified or display name.
      ConnectorTypeElement getConnectorTypeByGUID​(java.lang.String connectorTypeGUID)
      Retrieve the connector type metadata element with the supplied unique identifier.
      java.util.List<ConnectorTypeElement> getConnectorTypesByName​(java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of connector type metadata elements with a matching qualified or display name.
      EndpointElement getEndpointByGUID​(java.lang.String endpointGUID)
      Retrieve the endpoint metadata element with the supplied unique identifier.
      java.util.List<EndpointElement> getEndpointsByName​(java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of endpoint metadata elements with a matching qualified or display name.
      DataFileElement getFileByGUID​(java.lang.String fileGUID)
      Retrieve a FolderProperties asset by its unique identifier (GUID).
      DataFileElement getFileByPathName​(java.lang.String pathName)
      Retrieve a folder by its fully qualified path name.
      java.lang.String getFileServerName()
      Return the qualified name of the file server that is supplied in the configuration document.
      FileFolderElement getFolderByGUID​(java.lang.String folderGUID)
      Retrieve a FolderProperties asset by its unique identifier (GUID).
      FileFolderElement getFolderByPathName​(java.lang.String pathName)
      Retrieve a folder by its fully qualified path name.
      java.util.List<DataFileElement> getFolderFiles​(java.lang.String folderGUID, int startFrom, int pageSize)
      Get the data files inside a folder - both those that are nested and those that are linked.
      java.util.List<SchemaAttributeElement> getNestedAttributes​(java.lang.String parentSchemaElementGUID, int startFrom, int pageSize)
      Retrieve the list of schema attributes associated with a StructSchemaType or nested underneath a schema attribute.
      java.util.List<FileFolderElement> getNestedFolders​(java.lang.String parentFolderGUID, int startFrom, int pageSize)
      Return the list of folders nested inside a folder.
      SchemaAttributeElement getSchemaAttributeByGUID​(java.lang.String schemaAttributeGUID)
      Retrieve the schema attribute metadata element with the supplied unique identifier.
      java.util.List<SchemaAttributeElement> getSchemaAttributesByName​(java.lang.String name, java.lang.String typeName, int startFrom, int pageSize)
      Retrieve the list of schema attribute metadata elements with a matching qualified or display name.
      SchemaTypeElement getSchemaTypeByGUID​(java.lang.String schemaTypeGUID)
      Retrieve the schema type metadata element with the supplied unique identifier.
      java.util.List<SchemaTypeElement> getSchemaTypeByName​(java.lang.String name, java.lang.String typeName, int startFrom, int pageSize)
      Retrieve the list of schema type metadata elements with a matching qualified or display name.
      SchemaTypeElement getSchemaTypeForElement​(java.lang.String parentElementGUID, java.lang.String parentElementTypeName)
      Return the schema type associated with a specific open metadata element (data asset, process or port).
      ElementHeader getSchemaTypeParent​(java.lang.String schemaTypeGUID)
      Retrieve the header of the metadata element connected to a schema type.
      java.util.List<DataFileElement> getTopLevelDataFiles​(java.lang.String fileSystemGUID, int startFrom, int pageSize)
      Return the list of folders nested inside a folder.
      java.util.List<FileFolderElement> getTopLevelFolders​(java.lang.String fileSystemGUID, int startFrom, int pageSize)
      Return the list of folders linked to the file server capability.
      java.util.List<ValidValueSetElement> getValidValueSetByName​(java.lang.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​(java.lang.String connectionGUID)
      Remove the metadata element representing a connection.
      void removeEndpoint​(java.lang.String endpointGUID)
      Remove the metadata element representing a endpoint.
      void removeSchemaAttribute​(java.lang.String schemaAttributeGUID)
      Remove the metadata element representing a schema attribute.
      void removeSchemaType​(java.lang.String schemaTypeGUID)
      Remove the metadata element representing a schema type.
      void setupAssetConnection​(java.lang.String assetGUID, java.lang.String assetSummary, java.lang.String connectionGUID)
      Create a relationship between an asset and its connection.
      void setupConnectorType​(java.lang.String connectionGUID, java.lang.String connectorTypeGUID)
      Create a relationship between a connection and a connector type.
      void setupEmbeddedConnection​(java.lang.String connectionGUID, int position, java.lang.String displayName, java.util.Map<java.lang.String,​java.lang.Object> arguments, java.lang.String embeddedConnectionGUID)
      Create a relationship between a virtual connection and an embedded connection.
      void setupEndpoint​(java.lang.String connectionGUID, java.lang.String endpointGUID)
      Create a relationship between a connection and an endpoint.
      void setupSchemaType​(java.lang.String relationshipTypeName, java.lang.String schemaAttributeGUID, java.lang.String schemaTypeGUID)
      Connect a schema type to a schema attribute.
      void updateConnection​(java.lang.String connectionGUID, boolean isMergeUpdate, ConnectionProperties connectionProperties)
      Update the metadata element representing a connection.
      void updateDataFileInCatalog​(java.lang.String dataFileGUID, boolean isMergeUpdate, DataFileProperties dataFileProperties)
      Update the file asset description in the catalog.
      void updateDataFolderInCatalog​(java.lang.String dataFolderGUID, boolean isMergeUpdate, FileFolderProperties fileFolderProperties)
      Update the data folder asset description in the catalog.
      void updateEndpoint​(boolean isMergeUpdate, java.lang.String endpointGUID, EndpointProperties endpointProperties)
      Update the metadata element representing a endpoint.
      void updateSchemaAttribute​(java.lang.String schemaAttributeGUID, boolean isMergeUpdate, SchemaAttributeProperties schemaAttributeProperties)
      Update the properties of the metadata element representing a schema attribute.
      void updateSchemaType​(java.lang.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