Package org.odpi.openmetadata.accessservices.assetmanager.properties

Class ConnectorTypeProperties

  • All Implemented Interfaces:
    Serializable
    public class ConnectorTypeProperties
extends ReferenceableProperties
    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.
    • 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.
    • 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 consumer.
    See Also:
    Serialized Form

    • Field Detail

      • displayName

        protected String displayName

      • description

        protected String description

      • connectorProviderClassName

        protected String connectorProviderClassName

      • recognizedAdditionalProperties

        protected List<String> recognizedAdditionalProperties

      • recognizedConfigurationProperties

        protected List<String> recognizedConfigurationProperties

      • recognizedSecuredProperties

        protected List<String> recognizedSecuredProperties

    • Constructor Detail

      • 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 Detail

      • getConnectorTypeType

        public static ElementType getConnectorTypeType()
        Return the standard type for a connector type.
        Returns:
        ElementType object

      • 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

      • 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)

      • 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

      • 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