org.odpi.openmetadata.frameworks.connectors.properties

Class ConnectorTypeProperties

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyElementBase

org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

org.odpi.openmetadata.frameworks.connectors.properties.AssetElementHeader

org.odpi.openmetadata.frameworks.connectors.properties.AssetReferenceable

org.odpi.openmetadata.frameworks.connectors.properties.ConnectorTypeProperties

All Implemented Interfaces:

Serializable

public class ConnectorTypeProperties
extends AssetReferenceable

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.

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 Summary

Fields

Modifier and Type	Field and Description
protected ConnectorType	connectorTypeBean

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetReferenceable

referenceableBean

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

parentAsset

Constructor Summary

Constructors

Constructor and Description
ConnectorTypeProperties(AssetDescriptor parentAsset, ConnectorType connectorTypeBean) Bean constructor with parent asset
ConnectorTypeProperties(AssetDescriptor parentAsset, ConnectorTypeProperties templateConnectorType) Copy/clone constructor for a connectorType that is connected to an asset (either directly or indirectly).
ConnectorTypeProperties(ConnectorType connectorTypeBean) Bean constructor
ConnectorTypeProperties(ConnectorTypeProperties templateConnectorType) Copy/clone constructor for a connectorType that is not connected to an asset (either directly or indirectly).

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Compare the values of the supplied object with those stored in the current object.
String	getConnectorProviderClassName() Returns the stored connectorProviderClassName property for the connector type.
protected ConnectorType	getConnectorTypeBean() Return the bean - used in cloning
String	getDescription() Returns the stored description property for the connector type.
String	getDisplayName() Returns the stored display name property for the connector type.
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	toString() Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetReferenceable

getAdditionalProperties, getMeanings, getQualifiedName, getReferenceableBean, getSecurityTags, setBean

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetElementHeader

getAssetClassifications, getElementHeaderBean, getExtendedProperties, getGUID, getType, getURL, hashCode, setBean

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

getParentAsset, getParentAssetName, getParentAssetTypeName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

connectorTypeBean

protected ConnectorType connectorTypeBean

Constructor Detail

ConnectorTypeProperties

public ConnectorTypeProperties(ConnectorType connectorTypeBean)

Bean constructor

Parameters:

connectorTypeBean - bean containing the properties

ConnectorTypeProperties

public ConnectorTypeProperties(AssetDescriptor parentAsset,
                               ConnectorType connectorTypeBean)

Bean constructor with parent asset

Parameters:

parentAsset - description of the asset that this connector type is attached to.

connectorTypeBean - bean containing the properties

ConnectorTypeProperties

public ConnectorTypeProperties(ConnectorTypeProperties templateConnectorType)

Copy/clone constructor for a connectorType that is not connected to an asset (either directly or indirectly).

Parameters:

templateConnectorType - template object to copy.

ConnectorTypeProperties

public ConnectorTypeProperties(AssetDescriptor parentAsset,
                               ConnectorTypeProperties templateConnectorType)

Copy/clone constructor for a connectorType that is connected to an asset (either directly or indirectly).

Parameters:

parentAsset - description of the asset that this connector type is attached to.

templateConnectorType - template object to copy.

Method Detail

getConnectorTypeBean

protected ConnectorType getConnectorTypeBean()

Return the bean - used in cloning

Returns:

ConnectorType bean

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

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)

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

toString

public String toString()

Standard toString method.

Overrides:

toString in class AssetReferenceable

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 AssetReferenceable

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison