Class ConnectorType
java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader
org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader
org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase
org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
org.odpi.openmetadata.frameworks.connectors.properties.beans.ConnectorType
The ConnectorType describe the implementation details of a particular type of OCF connector.
The properties for a connector type are defined in model 0201.
They include:
- guid - Globally unique identifier for the connector type.
- url - External link address for the connector type properties in the metadata repository. This URL can be stored as a property in another entity to create an explicit link to this connector type.
- qualifiedName - The official (unique) name for the connector type. This is often defined by the IT systems management organization and should be used (when available) on audit logs and error messages.
- displayName - A consumable name for the connector type. Often a shortened form of the qualifiedName for use on user interfaces and messages. The displayName should be only be used for audit logs and error messages if the qualifiedName is not set.
- description - A full description of the connector type covering details of the assets it connects to along with usage and versioning information.
- supportedAssetTypeName - the type of asset that the connector implementation supports.
- expectedDataFormat - the format of the data that the connector supports - null for "any".
- connectorProviderClassName - The connector provider is the factory for a particular type of connector. This property defines the class name for the connector provider that the Connector Broker should use to request new connector instances.
- connectorFrameworkName - name of the connector framework that the connector implements - default Open Connector Framework (OCF).
- connectorInterfaceLanguage - the language that the connector is implemented in - default Java.
- connectorInterfaces - list of interfaces that the connector supports.
- targetTechnologySource - the organization that supplies the target technology that the connector implementation connects to.
- targetTechnologyName - the name of the target technology that the connector implementation connects to.
- targetTechnologyInterfaces - the names of the interfaces in the target technology that the connector calls.
- targetTechnologyVersions - the versions of the target technology that the connector supports.
- recognizedAdditionalProperties - these are the Connection additional properties recognized by the connector implementation
- recognizedConfigurationProperties - these are the Connection configuration properties recognized by the connector implementation
- recognizedSecuredProperties - these are the Connection secured properties recognized by the connector implementation
- additionalProperties - Any additional properties that the connector provider needs to know in order to create connector instances.
-
Field Summary
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
additionalProperties, qualifiedName
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase
extendedProperties
Fields inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader
CURRENT_AUDIT_HEADER_VERSION
-
Constructor Summary
ConstructorDescriptionDefault constructorConnectorType
(ConnectorType template) Copy/clone constructor for a connectorType that is not connected to an asset (either directly or indirectly). -
Method Summary
Modifier and TypeMethodDescriptionboolean
Compare the values of the supplied object with those stored in the current object.Return name of the connector framework that the connector implements - default Open Connector Framework (OCF).Return the language that the connector is implemented in - default Java.Return list of interfaces that the connector supports.Returns the stored connectorProviderClassName property for the connector type.static ElementType
Return the standard type for a connector type.Returns the stored description property for the connector type.Returns the stored display name property for the connector type.Return the format of the data that the connector supports - null for "any".Return the list of property names that this connector/connector provider implementation looks for in the Connection object's additionalProperties.Return the list of property names that this connector/connector provider implementation looks for in the Connection object's configurationProperties.Return the list of property names that this connector/connector provider implementation looks for in the Connection object's securedProperties.Return the type of asset that the connector implementation supports.Return the name of the type of technology this connector works with.Return the names of the interfaces in the target technology that the connector calls.Return the name of the target technology that the connector implementation connects to.Return the name of the organization that supplies the target technology that the connector implementation connects to.Return the versions of the target technology that the connector supports.int
hashCode()
Hash of propertiesvoid
setConnectorFrameworkName
(String connectorFrameworkName) Set up name of the connector framework that the connector implements - default Open Connector Framework (OCF).void
setConnectorInterfaceLanguage
(String connectorInterfaceLanguage) Set up the language that the connector is implemented in - default Java.void
setConnectorInterfaces
(List<String> connectorInterfaces) Set up list of interfaces that the connector supports.void
setConnectorProviderClassName
(String connectorProviderClassName) The name of the connector provider class name.void
setDescription
(String description) Set up description of the element.void
setDisplayName
(String displayName) Set up the display name for UIs and reports.void
setExpectedDataFormat
(String expectedDataFormat) Set up the format of the data that the connector supports - null for "any".void
setRecognizedAdditionalProperties
(List<String> recognizedAdditionalProperties) Set up the list of property names that this connector/connector provider implementation looks for in the Connection object's additionalProperties.void
setRecognizedConfigurationProperties
(List<String> recognizedConfigurationProperties) Set up the list of property names that this connector/connector provider implementation looks for in the Connection object's configurationProperties.void
setRecognizedSecuredProperties
(List<String> recognizedSecuredProperties) Set up the list of property names that this connector/connector provider implementation looks for in the Connection object's securedProperties.void
setSupportedAssetTypeName
(String supportedAssetTypeName) Set up the type of asset that the connector implementation supports.void
setSupportedDeployedImplementationType
(String supportedDeployedImplementationType) Set up the name of the type of technology this connector works with.void
setTargetTechnologyInterfaces
(List<String> targetTechnologyInterfaces) Set up the names of the interfaces in the target technology that the connector calls.void
setTargetTechnologyName
(String targetTechnologyName) Set up the name of the target technology that the connector implementation connects to.void
setTargetTechnologySource
(String targetTechnologySource) Set up the name of the organization that supplies the target technology that the connector implementation connects to.void
setTargetTechnologyVersions
(List<String> targetTechnologyVersions) Set up the versions of the target technology that the connector supports.toString()
Standard toString method.Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
getAdditionalProperties, getQualifiedName, setAdditionalProperties, setQualifiedName
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase
getExtendedProperties, setExtendedProperties
Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader
getClassifications, getGUID, setClassifications, setGUID
Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementControlHeader
getHeaderVersion, getOrigin, getStatus, getType, getVersions, setHeaderVersion, setOrigin, setStatus, setType, setVersions
-
Constructor Details
-
ConnectorType
public ConnectorType()Default constructor -
ConnectorType
Copy/clone constructor for a connectorType that is not connected to an asset (either directly or indirectly).- Parameters:
template
- template object to copy.
-
-
Method Details
-
getConnectorTypeType
Return the standard type for a connector type.- Returns:
- ElementType object
-
setDisplayName
Set up the display name for UIs and reports.- Parameters:
displayName
- String name
-
getDisplayName
Returns the stored display name property for the connector type. If no display name is available then null is returned.- Returns:
- displayName
-
setDescription
Set up description of the element.- Parameters:
description
- String
-
getDescription
Returns the stored description property for the connector type. If no description is available then null is returned.- Returns:
- description
-
getSupportedAssetTypeName
Return the type of asset that the connector implementation supports.- Returns:
- string name
-
setSupportedAssetTypeName
Set up the type of asset that the connector implementation supports. The expectation is that a connection with this connector type is attached to assets of this type.- Parameters:
supportedAssetTypeName
- string name
-
getSupportedDeployedImplementationType
Return the name of the type of technology this connector works with. This allows the connector to be targeted to the right resource more accurately.- Returns:
- string name
-
setSupportedDeployedImplementationType
Set up the name of the type of technology this connector works with. This allows the connector to be targeted to the right resource more accurately.- Parameters:
supportedDeployedImplementationType
- string name
-
getExpectedDataFormat
Return the format of the data that the connector supports - null for "any".- Returns:
- string name
-
setExpectedDataFormat
Set up the format of the data that the connector supports - null for "any".- Parameters:
expectedDataFormat
- string name
-
setConnectorProviderClassName
The name of the connector provider class name.- Parameters:
connectorProviderClassName
- String class name
-
getConnectorProviderClassName
Returns the stored connectorProviderClassName property for the connector type. If no connectorProviderClassName is available then null is returned.- Returns:
- connectorProviderClassName class name (including package name)
-
getConnectorFrameworkName
Return name of the connector framework that the connector implements - default Open Connector Framework (OCF).- Returns:
- string name
-
setConnectorFrameworkName
Set up name of the connector framework that the connector implements - default Open Connector Framework (OCF).- Parameters:
connectorFrameworkName
- string name
-
getConnectorInterfaceLanguage
Return the language that the connector is implemented in - default Java.- Returns:
- string name
-
setConnectorInterfaceLanguage
Set up the language that the connector is implemented in - default Java.- Parameters:
connectorInterfaceLanguage
- string name
-
getConnectorInterfaces
Return list of interfaces that the connector supports.- Returns:
- list of names
-
setConnectorInterfaces
Set up list of interfaces that the connector supports.- Parameters:
connectorInterfaces
- list of names
-
getTargetTechnologySource
Return the name of the organization that supplies the target technology that the connector implementation connects to.- Returns:
- string name
-
setTargetTechnologySource
Set up the name of the organization that supplies the target technology that the connector implementation connects to.- Parameters:
targetTechnologySource
- list of names
-
getTargetTechnologyName
Return the name of the target technology that the connector implementation connects to.- Returns:
- string name
-
setTargetTechnologyName
Set up the name of the target technology that the connector implementation connects to.- Parameters:
targetTechnologyName
- string name
-
getTargetTechnologyInterfaces
Return the names of the interfaces in the target technology that the connector calls.- Returns:
- list of interface names
-
setTargetTechnologyInterfaces
Set up the names of the interfaces in the target technology that the connector calls.- Parameters:
targetTechnologyInterfaces
- list of interface names
-
getTargetTechnologyVersions
Return the versions of the target technology that the connector supports.- Returns:
- list of version identifiers
-
setTargetTechnologyVersions
Set up the versions of the target technology that the connector supports.- Parameters:
targetTechnologyVersions
- list of version identifiers
-
setRecognizedAdditionalProperties
Set up the list of property names that this connector/connector provider implementation looks for in the Connection object's additionalProperties.- Parameters:
recognizedAdditionalProperties
- list of property names
-
getRecognizedAdditionalProperties
Return the list of property names that this connector/connector provider implementation looks for in the Connection object's additionalProperties.- Returns:
- list of property names
-
setRecognizedConfigurationProperties
Set up the list of property names that this connector/connector provider implementation looks for in the Connection object's configurationProperties.- Parameters:
recognizedConfigurationProperties
- list of property names
-
getRecognizedConfigurationProperties
Return the list of property names that this connector/connector provider implementation looks for in the Connection object's configurationProperties.- Returns:
- list of property names
-
setRecognizedSecuredProperties
Set up the list of property names that this connector/connector provider implementation looks for in the Connection object's securedProperties.- Parameters:
recognizedSecuredProperties
- list of property names
-
getRecognizedSecuredProperties
Return the list of property names that this connector/connector provider implementation looks for in the Connection object's securedProperties.- Returns:
- list of property names
-
toString
Standard toString method.- Overrides:
toString
in classReferenceable
- Returns:
- print out of variables in a JSON-style
-
equals
Compare the values of the supplied object with those stored in the current object.- Overrides:
equals
in classReferenceable
- Parameters:
objectToCompare
- supplied object- Returns:
- boolean result of comparison
-
hashCode
public int hashCode()Hash of properties- Overrides:
hashCode
in classReferenceable
- Returns:
- int
-