Class ConnectorTypeProperties
java.lang.Object
org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyElementBase
org.odpi.openmetadata.frameworks.connectors.properties.AssetElementHeader
org.odpi.openmetadata.frameworks.connectors.properties.AssetReferenceable
org.odpi.openmetadata.frameworks.connectors.properties.ConnectorTypeProperties
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.
- additionalProperties - Any additional properties that the connector provider needs to know in order to create connector instances.
- recognizedAdditionalProperties - List of property names recognised by this connector.
- recognizedConfigurationProperties - List of property names recognised by this connector.
- recognizedSecuredProperties - List of property names recognised by this connector.
-
Field Summary
FieldsFields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetReferenceable
referenceableBean
-
Constructor Summary
ConstructorsConstructorDescriptionConnectorTypeProperties
(ConnectorType connectorTypeBean) Bean constructorConnectorTypeProperties
(ConnectorTypeProperties templateConnectorType) Copy/clone constructor for a connectorType that is 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.Returns the stored connectorProviderClassName property for the connector type.protected ConnectorType
Return the bean - used in cloningReturns the stored description property for the connector type.Returns the stored display name property for the connector type.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.int
hashCode()
Hash of propertiestoString()
Standard toString method.Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetReferenceable
getAdditionalProperties, getQualifiedName, getReferenceableBean, setBean
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetElementHeader
getClassifications, getElementHeaderBean, getExtendedProperties, getGUID, getOrigin, getStatus, getType, getURL, getVersions, setBean
-
Field Details
-
connectorTypeBean
-
-
Constructor Details
-
ConnectorTypeProperties
Bean constructor- Parameters:
connectorTypeBean
- bean containing the properties
-
ConnectorTypeProperties
Copy/clone constructor for a connectorType that is connected to an asset (either directly or indirectly).- Parameters:
templateConnectorType
- template object to copy.
-
-
Method Details
-
getConnectorTypeBean
Return the bean - used in cloning- Returns:
- ConnectorType bean
-
getDisplayName
Returns the stored display name property for the connector type. If no display name is available then null is returned.- Returns:
- displayName
-
getDescription
Returns the stored description property for the connector type. If no description is available then null is returned.- Returns:
- description
-
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)
-
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
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
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 classAssetReferenceable
- 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 classAssetReferenceable
- Parameters:
objectToCompare
- supplied object- Returns:
- boolean result of comparison
-
hashCode
public int hashCode()Hash of properties- Overrides:
hashCode
in classAssetReferenceable
- Returns:
- int
-