Package org.odpi.openmetadata.frameworks.openmetadata.properties.connections

Class ConnectorTypeProperties

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataRootProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.connections.ConnectorTypeProperties
Direct Known Subclasses:
ConnectorTypeRequestBody
public class ConnectorTypeProperties extends ReferenceableProperties
The ConnectorTypeProperties describe the implementation details of a particular type of connector. The properties for a connector type are defined in model 0201. They include:
  • guid - Globally unique identifier for the 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.
The connectorTypeProperties class is simply used to cache the properties for an connector type. It is used by other classes to exchange this information between a metadata repository and a owner.

  • Constructor Details

    • ConnectorTypeProperties

      public ConnectorTypeProperties()
      Default constructor

    • ConnectorTypeProperties

      public ConnectorTypeProperties(ConnectorTypeProperties template)
      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

    • setDisplayName

      public void setDisplayName(String displayName)
      Set up the display name for UIs and reports.
      Parameters:
      displayName - String name

    • getDisplayName

      public String getDisplayName()
      Returns the stored display name property for the connector type. If no display name is available then null is returned.
      Returns:
      displayName

    • setDescription

      public void setDescription(String description)
      Set up description of the element.
      Parameters:
      description - String

    • getDescription

      public String getDescription()
      Returns the stored description property for the connector type. If no description is available then null is returned.
      Returns:
      description

    • getSupportedAssetTypeName

      public String getSupportedAssetTypeName()
      Return the type of asset that the connector implementation supports.
      Returns:
      string name

    • setSupportedAssetTypeName

      public void setSupportedAssetTypeName(String supportedAssetTypeName)
      Set up the type of asset that the connector implementation supports.
      Parameters:
      supportedAssetTypeName - string name

    • getExpectedDataFormat

      public String getExpectedDataFormat()
      Return the format of the data that the connector supports - null for "any".
      Returns:
      string name

    • setExpectedDataFormat

      public void setExpectedDataFormat(String expectedDataFormat)
      Set up the format of the data that the connector supports - null for "any".
      Parameters:
      expectedDataFormat - string name

    • setConnectorProviderClassName

      public void setConnectorProviderClassName(String connectorProviderClassName)
      The name of the connector provider class name.
      Parameters:
      connectorProviderClassName - String class name

    • getConnectorProviderClassName

      public String 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

      public String getConnectorFrameworkName()
      Return name of the connector framework that the connector implements - default Open Connector Framework (OCF).
      Returns:
      string name

    • setConnectorFrameworkName

      public void setConnectorFrameworkName(String connectorFrameworkName)
      Set up name of the connector framework that the connector implements - default Open Connector Framework (OCF).
      Parameters:
      connectorFrameworkName - string name

    • getConnectorInterfaceLanguage

      public String getConnectorInterfaceLanguage()
      Return the language that the connector is implemented in - default Java.
      Returns:
      string name

    • setConnectorInterfaceLanguage

      public void setConnectorInterfaceLanguage(String connectorInterfaceLanguage)
      Set up the language that the connector is implemented in - default Java.
      Parameters:
      connectorInterfaceLanguage - string name

    • getConnectorInterfaces

      public List<String> getConnectorInterfaces()
      Return list of interfaces that the connector supports.
      Returns:
      list of names

    • setConnectorInterfaces

      public void setConnectorInterfaces(List<String> connectorInterfaces)
      Set up list of interfaces that the connector supports.
      Parameters:
      connectorInterfaces - list of names

    • getTargetTechnologySource

      public String getTargetTechnologySource()
      Return the name of the organization that supplies the target technology that the connector implementation connects to.
      Returns:
      string name

    • setTargetTechnologySource

      public void setTargetTechnologySource(String targetTechnologySource)
      Set up the name of the organization that supplies the target technology that the connector implementation connects to.
      Parameters:
      targetTechnologySource - list of names

    • getTargetTechnologyName

      public String getTargetTechnologyName()
      Return the name of the target technology that the connector implementation connects to.
      Returns:
      string name

    • setTargetTechnologyName

      public void setTargetTechnologyName(String targetTechnologyName)
      Set up the name of the target technology that the connector implementation connects to.
      Parameters:
      targetTechnologyName - string name

    • getTargetTechnologyInterfaces

      public List<String> getTargetTechnologyInterfaces()
      Return the names of the interfaces in the target technology that the connector calls.
      Returns:
      list of interface names

    • setTargetTechnologyInterfaces

      public void setTargetTechnologyInterfaces(List<String> targetTechnologyInterfaces)
      Set up the names of the interfaces in the target technology that the connector calls.
      Parameters:
      targetTechnologyInterfaces - list of interface names

    • getTargetTechnologyVersions

      public List<String> getTargetTechnologyVersions()
      Return the versions of the target technology that the connector supports.
      Returns:
      list of version identifiers

    • setTargetTechnologyVersions

      public void setTargetTechnologyVersions(List<String> targetTechnologyVersions)
      Set up the versions of the target technology that the connector supports.
      Parameters:
      targetTechnologyVersions - list of version identifiers

    • setRecognizedAdditionalProperties

      public 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.
      Parameters:
      recognizedAdditionalProperties - list of property names

    • getRecognizedAdditionalProperties

      public List<String> 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

      public 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.
      Parameters:
      recognizedConfigurationProperties - list of property names

    • getRecognizedConfigurationProperties

      public List<String> 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

      public 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.
      Parameters:
      recognizedSecuredProperties - list of property names

    • getRecognizedSecuredProperties

      public List<String> 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

      public String toString()
      Standard toString method.
      Overrides:
      toString in class ReferenceableProperties
      Returns:
      print out of variables in a JSON-style

    • equals

      public boolean equals(Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      Overrides:
      equals in class ReferenceableProperties
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Hash of properties
      Overrides:
      hashCode in class ReferenceableProperties
      Returns:
      int