Class ConnectorType

    • Constructor Detail

      • ConnectorType

        public ConnectorType()
    • Method Detail

      • getDisplayName

        public java.lang.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 java.lang.String getDescription()
        Returns the stored description property for the connector type. If no description is available then null is returned.
        Returns:
        description
      • getSupportedAssetTypeName

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

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

        public java.lang.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 java.lang.String getConnectorFrameworkName()
        Return name of the connector framework that the connector implements - default Open Connector Framework (OCF).
        Returns:
        string name
      • getConnectorInterfaceLanguage

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

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

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

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

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

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

        public java.util.List<java.lang.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 java.util.List<java.lang.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 java.util.List<java.lang.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​(java.lang.String displayName)
        Set up the display name for UIs and reports.
        Parameters:
        displayName - String name
      • setDescription

        public void setDescription​(java.lang.String description)
        Set up description of the element.
        Parameters:
        description - String
      • setSupportedAssetTypeName

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

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

        public void setConnectorProviderClassName​(java.lang.String connectorProviderClassName)
        The name of the connector provider class name.
        Parameters:
        connectorProviderClassName - String class name
      • setConnectorFrameworkName

        public void setConnectorFrameworkName​(java.lang.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​(java.lang.String connectorInterfaceLanguage)
        Set up the language that the connector is implemented in - default Java.
        Parameters:
        connectorInterfaceLanguage - string name
      • setConnectorInterfaces

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

        public void setTargetTechnologySource​(java.lang.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​(java.lang.String targetTechnologyName)
        Set up the name of the target technology that the connector implementation connects to.
        Parameters:
        targetTechnologyName - string name
      • setTargetTechnologyInterfaces

        public void setTargetTechnologyInterfaces​(java.util.List<java.lang.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​(java.util.List<java.lang.String> targetTechnologyVersions)
        Set up the versions of the target technology that the connector supports.
        Parameters:
        targetTechnologyVersions - list of version identifiers
      • setRecognizedAdditionalProperties

        public void setRecognizedAdditionalProperties​(java.util.List<java.lang.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​(java.util.List<java.lang.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​(java.util.List<java.lang.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​(java.lang.Object o)
        Description copied from class: Referenceable
        Compare the values of the supplied object with those stored in the current object.
        Overrides:
        equals in class Referenceable
        Parameters:
        o - supplied object
        Returns:
        boolean result of comparison
      • canEqual

        protected boolean canEqual​(java.lang.Object other)
      • hashCode

        public int hashCode()
        Description copied from class: Referenceable
        Return has code based on properties.
        Overrides:
        hashCode in class Referenceable
        Returns:
        int
      • toString

        public java.lang.String toString()
        Description copied from class: Referenceable
        Standard toString method.
        Overrides:
        toString in class Referenceable
        Returns:
        print out of variables in a JSON-style