Index (files-integrator-api 4.1 API)

A C D F G I N O R S T U V
All Classes and Interfaces|All Packages

A

addDataFileToCatalog(DataFileProperties, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Creates a new file asset and links it to the folder structure implied in the path name.
addDataFileToCatalogFromTemplate(String, TemplateProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Add an asset description a file based on the content of a template object.
addDataFolderToCatalog(FileFolderProperties, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Creates a new folder asset that is identified as a data asset.
addDataFolderToCatalogFromTemplate(String, TemplateProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Add an asset description a file based on the content of a template object.
archiveDataFileInCatalog(String, ArchiveProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Mark the file asset description in the catalog as archived.
archiveDataFolderInCatalog(String, ArchiveProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Mark the data folder asset description in the catalog as archived.
attachDataFileAssetToFolder(String, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Link an existing file asset to a folder.
attachTopLevelFolder(String, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Links a folder to a file system.

C

clearAssetConnection(String, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Remove a relationship between an asset and its connection.
clearConnectorType(String, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Remove a relationship between a connection and a connector type.
clearEmbeddedConnection(String, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Remove a relationship between a virtual connection and an embedded connection.
clearEndpoint(String, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Remove a relationship between a connection and an endpoint.
clearReferenceValueTag(String, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Remove a reference value assignment relationship between an element and a valid value.
clearSchemaElementRelationship(String, String, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Remove a relationship between two schema elements.
clearSchemaTypes(String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Remove the linked schema types from a schema attribute.
clearValidValueMember(String, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Remove a membership relationship between a validValue and a validValueSet that it belongs to.
clearValidValues(String, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Remove a valid value assignment relationship between an element and a valid value.
CONNECTOR_CONTEXT_INITIALIZING - Enum constant in enum class org.odpi.openmetadata.integrationservices.files.ffdc.FilesIntegratorAuditCode
CONTEXT_INITIALIZING - Enum constant in enum class org.odpi.openmetadata.integrationservices.files.ffdc.FilesIntegratorAuditCode
createConnection(ConnectionProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Create a new metadata element to represent a connection.
createConnectionFromTemplate(String, TemplateProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Create a new metadata element to represent a connection using an existing metadata element as a template.
createEndpoint(EndpointProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Create a new metadata element to represent an endpoint
createEndpointFromTemplate(String, String, TemplateProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Create a new metadata element to represent a endpoint using an existing metadata element as a template.
createEnumSchemaType(EnumSchemaTypeProperties, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: 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.
createLiteralSchemaType(LiteralSchemaTypeProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Create a new metadata element to represent a schema type that has a fixed value.
createMapSchemaType(MapSchemaTypeProperties, String, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Create a new metadata element to represent a schema type.
createNestedFolders(String, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Creates a new folder asset for each element in the pathName.
createPrimitiveSchemaType(PrimitiveSchemaTypeProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Create a new metadata element to represent a primitive schema type such as a string, integer or character.
createSchemaAttribute(String, SchemaAttributeProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Create a new metadata element to represent a schema attribute.
createSchemaAttributeFromTemplate(String, String, TemplateProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Create a new metadata element to represent a schema attribute using an existing metadata element as a template.
createSchemaTypeChoice(SchemaTypeChoiceProperties, List<String>) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Create a new metadata element to represent a list of possible schema types that can be used for the attached API parameter.
createSchemaTypeFromTemplate(String, TemplateProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Create a new metadata element to represent a schema type using an existing metadata element as a template.
createStructSchemaType(StructSchemaTypeProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Create a new metadata element to represent a schema type.
createValidValue(ValidValueProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Create a new metadata element to represent a valid value.

D

deleteDataFileFromCatalog(String, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Remove the file asset description from the catalog.
detachDataFileAssetFromFolder(String, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Remove a link between a file asset and a folder.
detachTopLevelFolder(String, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Removed the link between a folder and a file system.

F

FilesIntegratorAPI - Interface in org.odpi.openmetadata.integrationservices.files.api: FilesIntegratorAPI is the interface to validate that a connector is suitable to run in the Files Integrator OMIS.
FilesIntegratorAuditCode - Enum Class in org.odpi.openmetadata.integrationservices.files.ffdc: The FilesIntegratorAuditCode is used to define the message content for the OMRS Audit Log.
FilesIntegratorConnector - Class in org.odpi.openmetadata.integrationservices.files.connector: FilesIntegratorConnector is the base class for an integration connector that is managed by the Files Integrator OMIS.
FilesIntegratorConnector() - Constructor for class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorConnector
FilesIntegratorContext - Class in org.odpi.openmetadata.integrationservices.files.connector: FilesIntegratorContext provides a wrapper around the Data Manager OMAS clients.
FilesIntegratorContext(String, String, String, String, OpenIntegrationClient, OpenMetadataClient, FilesAndFoldersClient, ConnectionManagerClient, ValidValueManagement, DataManagerEventClient, boolean, PermittedSynchronization, String, String, String) - Constructor for class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Create a new client with no authentication embedded in the HTTP request.
FilesIntegratorErrorCode - Enum Class in org.odpi.openmetadata.integrationservices.files.ffdc: The FilesIntegratorErrorCode error code is used to define first failure data capture (FFDC) for errors that occur when working with the Integration Services.
FilesIntegratorOMISConnector - Interface in org.odpi.openmetadata.integrationservices.files.connector: A marker interface to identify the OMIS that this connector works with.
findConnections(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve the list of metadata elements that contain the search string.
findConnectorTypes(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve the list of connector type metadata elements that contain the search string.
findEndpoints(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve the list of endpoint metadata elements that contain the search string.
findSchemaAttributes(String, String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve the list of schema attribute metadata elements that contain the search string.
findSchemaType(String, String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve the list of schema type metadata elements that contain the search string.
findValidValues(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve the list of metadata elements that contain the search string.
findValidValueSet(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve the list of valid value set metadata elements that contain the search string.

G

getAllValidValues(int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve the list of valid values.
getAssigneesOfReferenceValue(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Return information about the person roles linked to a validValue.
getConnectionByGUID(String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve the metadata element with the supplied unique identifier.
getConnectionsByName(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve the list of metadata elements with a matching qualified or display name.
getConnectorTypeByGUID(String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve the connector type metadata element with the supplied unique identifier.
getConnectorTypesByName(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve the list of connector type metadata elements with a matching qualified or display name.
getConsumersOfValidValue(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Return information about the consumers linked to a validValue.
getContext() - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorConnector: Return the context for this connector.
getEndpointByGUID(String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve the endpoint metadata element with the supplied unique identifier.
getEndpointsByName(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve the list of endpoint metadata elements with a matching qualified or display name.
getFileByGUID(String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve a FolderProperties asset by its unique identifier (GUID).
getFileByPathName(String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve a folder by its fully qualified path name.
getFolderByGUID(String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve a FolderProperties asset by its unique identifier (GUID).
getFolderByPathName(String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve a folder by its fully qualified path name.
getFolderFiles(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Get the data files inside a folder - both those that are nested and those that are linked.
getMessageDefinition() - Method in enum class org.odpi.openmetadata.integrationservices.files.ffdc.FilesIntegratorAuditCode: Retrieve a message definition object for logging.
getMessageDefinition() - Method in enum class org.odpi.openmetadata.integrationservices.files.ffdc.FilesIntegratorErrorCode: Retrieve a message definition object for an exception.
getMessageDefinition(String...) - Method in enum class org.odpi.openmetadata.integrationservices.files.ffdc.FilesIntegratorAuditCode: Retrieve a message definition object for logging.
getMessageDefinition(String...) - Method in enum class org.odpi.openmetadata.integrationservices.files.ffdc.FilesIntegratorErrorCode: Retrieve a message definition object for an exception.
getNestedAttributes(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve the list of schema attributes associated with a StructSchemaType or nested underneath a schema attribute.
getNestedFolders(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Return the list of folders nested inside a folder.
getReferenceValues(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Return information about the valid values linked as reference value tags to an element.
getSchemaAttributeByGUID(String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve the schema attribute metadata element with the supplied unique identifier.
getSchemaAttributesByName(String, String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve the list of schema attribute metadata elements with a matching qualified or display name.
getSchemaTypeByGUID(String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve the schema type metadata element with the supplied unique identifier.
getSchemaTypeByName(String, String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve the list of schema type metadata elements with a matching qualified or display name.
getSchemaTypeForElement(String, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Return the schema type associated with a specific open metadata element (data asset, process or port).
getSchemaTypeParent(String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve the header of the metadata element connected to a schema type.
getSetsForValidValue(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Page through the list of valid value sets that a valid value definition/set belongs to.
getTopLevelDataFiles(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Return the list of folders nested inside a folder.
getTopLevelFolders(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Return the list of folders linked to the file server capability.
getValidValueByGUID(String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve the metadata element with the supplied unique identifier.
getValidValuesByName(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve the list of metadata elements with a matching qualified or display name.
getValidValueSetByName(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Retrieve the list of valid value set metadata elements with a matching qualified or display name.
getValidValueSetMembers(String, int, int) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Page through the members of a valid value set.
getValidValuesForConsumer(String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Return information about the valid value set linked to an element as its set of valid values.

I

INVALID_CONNECTOR - Enum constant in enum class org.odpi.openmetadata.integrationservices.files.ffdc.FilesIntegratorErrorCode

N

NULL_CONTEXT - Enum constant in enum class org.odpi.openmetadata.integrationservices.files.ffdc.FilesIntegratorAuditCode
NULL_CONTEXT - Enum constant in enum class org.odpi.openmetadata.integrationservices.files.ffdc.FilesIntegratorErrorCode

O

org.odpi.openmetadata.integrationservices.files.api - package org.odpi.openmetadata.integrationservices.files.api
org.odpi.openmetadata.integrationservices.files.connector - package org.odpi.openmetadata.integrationservices.files.connector
org.odpi.openmetadata.integrationservices.files.ffdc - package org.odpi.openmetadata.integrationservices.files.ffdc

R

registerListener(DataManagerEventListener) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Register a listener object that will be passed each of the events published by the Data Manager OMAS.
removeConnection(String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Remove the metadata element representing a connection.
removeEndpoint(String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Remove the metadata element representing a endpoint.
removeSchemaAttribute(String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Remove the metadata element representing a schema attribute.
removeSchemaType(String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Remove the metadata element representing a schema type.
removeValidValue(String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Remove the metadata element representing a valid value.

S

setContext(FilesIntegratorContext) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorConnector: Set up the context for this connector.
setupAssetConnection(String, String, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Create a relationship between an asset and its connection.
setupConnectorType(String, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Create a relationship between a connection and a connector type.
setupEmbeddedConnection(String, int, String, Map<String, Object>, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Create a relationship between a virtual connection and an embedded connection.
setupEndpoint(String, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Create a relationship between a connection and an endpoint.
setupReferenceValueTag(String, ReferenceValueAssignmentProperties, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Create a reference value assignment relationship between an element and a valid value to show that the valid value is a semiformal tag/classification.
setupSchemaElementRelationship(String, String, String, RelationshipProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Create a relationship between two schema elements.
setupSchemaType(String, String, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Connect a schema type to a schema attribute.
setupValidValueMember(String, ValidValueMembershipProperties, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Create a membership relationship between a validValue and a validValueSet that it belongs to.
setupValidValues(String, ValidValueAssignmentProperties, String) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Create a valid value assignment relationship between an element and a valid value (typically, a valid value set) to show that the valid value defines the values that can be stored in the data item that the element represents.

T

toString() - Method in enum class org.odpi.openmetadata.integrationservices.files.ffdc.FilesIntegratorAuditCode: toString() JSON-style
toString() - Method in enum class org.odpi.openmetadata.integrationservices.files.ffdc.FilesIntegratorErrorCode: JSON-style toString

U

updateConnection(String, boolean, ConnectionProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Update the metadata element representing a connection.
updateDataFileInCatalog(String, boolean, DataFileProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Update the file asset description in the catalog.
updateDataFolderInCatalog(String, boolean, FileFolderProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Update the data folder asset description in the catalog.
updateEndpoint(boolean, String, EndpointProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Update the metadata element representing an endpoint.
updateSchemaAttribute(String, boolean, SchemaAttributeProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Update the properties of the metadata element representing a schema attribute.
updateSchemaType(String, boolean, SchemaTypeProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Update the metadata element representing a schema type.
updateValidValue(String, boolean, ValidValueProperties) - Method in class org.odpi.openmetadata.integrationservices.files.connector.FilesIntegratorContext: Update the metadata element representing a valid value.

V

validateConnector(String, String) - Method in interface org.odpi.openmetadata.integrationservices.files.api.FilesIntegratorAPI: Validate the connector and return its connector type.
valueOf(String) - Static method in enum class org.odpi.openmetadata.integrationservices.files.ffdc.FilesIntegratorAuditCode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.odpi.openmetadata.integrationservices.files.ffdc.FilesIntegratorErrorCode: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.odpi.openmetadata.integrationservices.files.ffdc.FilesIntegratorAuditCode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.odpi.openmetadata.integrationservices.files.ffdc.FilesIntegratorErrorCode: Returns an array containing the constants of this enum class, in the order they are declared.

A C D F G I N O R S T U V
All Classes and Interfaces|All Packages