Package org.odpi.openmetadata.accessservices.dataengine.model

Class ConnectorType

java.lang.Object
org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementControlHeader
org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader
org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementBase
org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
org.odpi.openmetadata.accessservices.dataengine.model.ConnectorType
All Implemented Interfaces:
Serializable
public class ConnectorType extends org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
See Also:

  • Field Summary

    Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

    CURRENT_AUDIT_HEADER_VERSION

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConnectorType()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
     
    String
    getConnectorFrameworkName()
    Return name of the connector framework that the connector implements - default Open Connector Framework (OCF).
    String
    getConnectorInterfaceLanguage()
    Return the language that the connector is implemented in - default Java.
    List<String>
    getConnectorInterfaces()
    Return list of interfaces that the connector supports.
    String
    getConnectorProviderClassName()
    Returns the stored connectorProviderClassName property for the connector type.
    String
    getDescription()
    Returns the stored description property for the connector type.
    String
    getDisplayName()
    Returns the stored display name property for the connector type.
    String
    getExpectedDataFormat()
    Return the format of the data that the connector supports - null for "any".
    List<String>
    getRecognizedAdditionalProperties()
    Return the list of property names that this connector/connector provider implementation looks for in the Connection object's additionalProperties.
    List<String>
    getRecognizedConfigurationProperties()
    Return the list of property names that this connector/connector provider implementation looks for in the Connection object's configurationProperties.
    List<String>
    getRecognizedSecuredProperties()
    Return the list of property names that this connector/connector provider implementation looks for in the Connection object's securedProperties.
    String
    getSupportedAssetTypeName()
    Return the type of asset that the connector implementation supports.
    List<String>
    getTargetTechnologyInterfaces()
    Return the names of the interfaces in the target technology that the connector calls.
    String
    getTargetTechnologyName()
    Return the name of the target technology that the connector implementation connects to.
    String
    getTargetTechnologySource()
    Return the name of the organization that supplies the target technology that the connector implementation connects to.
    List<String>
    getTargetTechnologyVersions()
    Return the versions of the target technology that the connector supports.
    int
    hashCode()
     
    void
    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
    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.
    String
    toString()
     

    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, getURL, setExtendedProperties, setURL

    Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader

    getClassifications, getGUID, setClassifications, setGUID

    Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementControlHeader

    getOrigin, getStatus, getType, getVersions, setOrigin, setStatus, setType, setVersions

    Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

    getHeaderVersion, setHeaderVersion

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ConnectorType

      public ConnectorType()

  • Method Details

    • 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

    • 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

    • getExpectedDataFormat

      public String getExpectedDataFormat()
      Return the format of the data that the connector supports - null for "any".
      Returns:
      string 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

    • getConnectorInterfaceLanguage

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

    • getConnectorInterfaces

      public List<String> getConnectorInterfaces()
      Return list of interfaces that the connector supports.
      Returns:
      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

    • getTargetTechnologyName

      public String getTargetTechnologyName()
      Return the name of the target technology that the connector implementation connects to.
      Returns:
      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

    • getTargetTechnologyVersions

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

    • 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

    • 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

    • 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

    • setDisplayName

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

    • setDescription

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

    • setSupportedAssetTypeName

      public void setSupportedAssetTypeName(String supportedAssetTypeName)
      Set up the type of asset that the connector implementation supports.
      Parameters:
      supportedAssetTypeName - 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

    • 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

    • setConnectorInterfaceLanguage

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

    • setConnectorInterfaces

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

    • 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

    • setTargetTechnologyName

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

    • 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

    • 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

    • 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

    • 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

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

    • toString

      public String toString()
      Overrides:
      toString in class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable