org.odpi.openmetadata.frameworks.connectors.properties.beans

Class Connection

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader

org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

VirtualConnection

public class Connection
extends Referenceable

The connection is an object that contains the properties needed to create and initialise a connector to access a specific data assets. The properties for a connection are defined in model 0201. They include the following options for connector name:

• guid - Globally unique identifier for the connection.
• url - URL of the connection definition in the metadata repository. This URL can be stored as a property in another entity to create an explicit link to this connection.
• qualifiedName - The official (unique) name for the connection. This is often defined by the IT systems management organization and should be used (when available) on audit logs and error messages. The qualifiedName is defined in the 0010 model as part of Referenceable.
• displayName - A consumable name for the connection. 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.

Either the guid, qualifiedName or displayName can be used to specify the name for a connection. Other properties for the connection include:

• type - information about the TypeDef for Connection
• description - A full description of the connection covering details of the assets it connects to along with usage and version information.
• additionalProperties - Any additional properties associated with the connection.
• configurationProperties - properties for configuring the connector.
• securedProperties - Protected properties for secure log on by connector to back end server. These are protected properties that can only be retrieved by privileged connector code.
• userId - name or URI or connecting user.
• encryptedPassword - password for the userId - needs decrypting by connector before use.
• clearPassword - password for userId - ready to use.
• connectorType - Properties that describe the connector type for the connector.
• endpoint - Properties that describe the server endpoint where the connector will retrieve the assets.
• assetSummary - short description of the connected asset (if any).

The connection class is simply used to cache the properties for an connection. 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 String	assetSummary
protected String	clearPassword
protected Map<String,Object>	configurationProperties
protected ConnectorType	connectorType
protected String	description
protected String	displayName
protected String	encryptedPassword
protected Endpoint	endpoint
protected Map<String,String>	securedProperties
protected String	userId

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

additionalProperties, confidenceGovernanceClassification, confidentialityGovernanceClassification, criticalityGovernanceClassification, latestChange, latestChangeDetails, meanings, qualifiedName, retentionGovernanceClassification, searchKeywords, securityTags

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

classifications, extendedProperties, guid, type, url

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

CURRENT_AUDIT_HEADER_VERSION

Constructor Summary

Constructors

Constructor and Description
Connection() Default constructor sets the Connection properties to null.
Connection(Connection template) Copy/clone Constructor to return a copy of a connection object.

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	getAssetSummary() Return the description of the asset that this connection is linked to - or null if no asset connected, or the asset summary property in the relationship is not set.
String	getClearPassword() Return an unencrypted password.
Map<String,Object>	getConfigurationProperties() Return a copy of the configuration properties.
static ElementType	getConnectionType() Return the standard type for a connection type.
ConnectorType	getConnectorType() Returns a copy of the properties for this connection's connector type.
String	getDescription() Returns the stored description property for the connection.
String	getDisplayName() Returns the stored display name property for the connection.
String	getEncryptedPassword() Return an encrypted password.
Endpoint	getEndpoint() Returns a copy of the properties for this connection's endpoint.
Map<String,String>	getSecuredProperties() Return a copy of the secured properties.
String	getUserId() Return the userId to use on this connection.
int	hashCode() Return has code based on properties.
void	setAssetSummary(String assetSummary) Set up the description of the asset that this connection is linked to - or null if no asset connected, or the asset summary property in the relationship is not set.
void	setClearPassword(String clearPassword) Set up an unencrypted password.
void	setConfigurationProperties(Map<String,Object> configurationProperties) Set up the configuration properties for this Connection.
void	setConnectorType(ConnectorType connectorType) Set up the connector type properties for this Connection.
void	setDescription(String description) Set up description of the element.
void	setDisplayName(String displayName) Set up the display name for UIs and reports.
void	setEncryptedPassword(String encryptedPassword) Set up an encrypted password.
void	setEndpoint(Endpoint endpoint) Set up the endpoint properties for this Connection.
void	setSecuredProperties(Map<String,String> securedProperties) Set up the secured properties for this Connection.
void	setUserId(String userId) Set up the the userId to use on this connection.
String	toString() Standard toString method.

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

getAdditionalProperties, getConfidenceGovernanceClassification, getConfidentialityGovernanceClassification, getCriticalityGovernanceClassification, getLatestChange, getLatestChangeDetails, getMeanings, getQualifiedName, getRetentionGovernanceClassification, getSearchKeywords, getSecurityTags, setAdditionalProperties, setConfidenceGovernanceClassification, setConfidentialityGovernanceClassification, setCriticalityGovernanceClassification, setLatestChange, setLatestChangeDetails, setMeanings, setQualifiedName, setRetentionGovernanceClassification, setSearchKeywords, setSecurityTags

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

getClassifications, getExtendedProperties, getGUID, getType, getURL, setClassifications, setExtendedProperties, setGUID, setType, setURL

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

getHeaderVersion, setHeaderVersion

Methods inherited from class java.lang.Object

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

Field Detail

displayName

protected String displayName

description

protected String description

connectorType

protected ConnectorType connectorType

endpoint

protected Endpoint endpoint

userId

protected String userId

encryptedPassword

protected String encryptedPassword

clearPassword

protected String clearPassword

configurationProperties

protected Map<String,Object> configurationProperties

securedProperties

protected Map<String,String> securedProperties

assetSummary

protected String assetSummary

Constructor Detail

Connection

public Connection()

Default constructor sets the Connection properties to null.

Connection

public Connection(Connection template)

Copy/clone Constructor to return a copy of a connection object.

Parameters:

template - Connection to copy

Method Detail

getConnectionType

public static ElementType getConnectionType()

Return the standard type for a connection type.

Returns:

ElementType object

getDisplayName

public String getDisplayName()

Returns the stored display name property for the connection. Null means no displayName is available.

Returns:

displayName

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

getDescription

public String getDescription()

Returns the stored description property for the connection. If no description is provided then null is returned.

Returns:

description

setConnectorType

public void setConnectorType(ConnectorType connectorType)

Set up the connector type properties for this Connection.

Parameters:

connectorType - ConnectorType properties object

getConnectorType

public ConnectorType getConnectorType()

Returns a copy of the properties for this connection's connector type. A null means there is no connection type.

Returns:

connector type for the connection

getUserId

public String getUserId()

Return the userId to use on this connection.

Returns:

string

setUserId

public void setUserId(String userId)

Set up the the userId to use on this connection.

Parameters:

userId - string

getEncryptedPassword

public String getEncryptedPassword()

Return an encrypted password. The caller is responsible for decrypting it.

Returns:

string

setEncryptedPassword

public void setEncryptedPassword(String encryptedPassword)

Set up an encrypted password.

Parameters:

encryptedPassword - string

getClearPassword

public String getClearPassword()

Return an unencrypted password.

Returns:

string

setClearPassword

public void setClearPassword(String clearPassword)

Set up an unencrypted password.

Parameters:

clearPassword - string

setEndpoint

public void setEndpoint(Endpoint endpoint)

Set up the endpoint properties for this Connection.

Parameters:

endpoint - Endpoint properties object

getEndpoint

public Endpoint getEndpoint()

Returns a copy of the properties for this connection's endpoint. Null means no endpoint information available.

Returns:

endpoint for the connection

setConfigurationProperties

public void setConfigurationProperties(Map<String,Object> configurationProperties)

Set up the configuration properties for this Connection.

Parameters:

configurationProperties - properties that contain additional configuration information for the connector.

getConfigurationProperties

public Map<String,Object> getConfigurationProperties()

Return a copy of the configuration properties. Null means no secured properties are available.

Returns:

secured properties typically user credentials for the connection

setSecuredProperties

public void setSecuredProperties(Map<String,String> securedProperties)

Set up the secured properties for this Connection.

Parameters:

securedProperties - properties that contain secret information such as log on information.

getSecuredProperties

public Map<String,String> getSecuredProperties()

Return a copy of the secured properties. Null means no secured properties are available.

Returns:

secured properties typically user credentials for the connection

getAssetSummary

public String getAssetSummary()

Return the description of the asset that this connection is linked to - or null if no asset connected, or the asset summary property in the relationship is not set.

Returns:

string description

setAssetSummary

public void setAssetSummary(String assetSummary)

Set up the description of the asset that this connection is linked to - or null if no asset connected, or the asset summary property in the relationship is not set.

Parameters:

assetSummary - string description

toString

public String toString()

Standard toString method. Note SecuredProperties and other credential type properties are not displayed. This is deliberate because there is no knowing where the string will be printed.

Overrides:

toString in class Referenceable

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 Referenceable

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Return has code based on properties.

Overrides:

hashCode in class Referenceable

Returns:

int