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.
• 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.
• connectorType - Properties that describe the connector type for the connector.
• endpoint - Properties that describe the server endpoint where the connector will retrieve the assets.

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 ConnectorType	connectorType
protected String	description
protected String	displayName
protected Endpoint	endpoint
protected Map<String,Object>	securedProperties

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

additionalProperties, qualifiedName

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

classifications, guid, type, url

Constructor Summary

Constructors

Constructor and Description
Connection() Default constructor sets the Connection properties to null.
Connection(Connection templateConnection) 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.
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.
Endpoint	getEndpoint() Returns a copy of the properties for this connection's endpoint.
Map<String,Object>	getSecuredProperties() Return a copy of the secured properties.
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	setEndpoint(Endpoint endpoint) Set up the endpoint properties for this Connection.
void	setSecuredProperties(Map<String,Object> securedProperties) Set up the secured properties for this Connection.
String	toString() Standard toString method.

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

getAdditionalProperties, getQualifiedName, setAdditionalProperties, setQualifiedName

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

getClassifications, getGUID, getType, getURL, hashCode, setClassifications, setGUID, setType, setURL

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

securedProperties

protected Map<String,Object> securedProperties

Constructor Detail

Connection

public Connection()

Default constructor sets the Connection properties to null.

Connection

public Connection(Connection templateConnection)

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

Parameters:

templateConnection - 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

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

setSecuredProperties

public void setSecuredProperties(Map<String,Object> 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,Object> getSecuredProperties()

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

Returns:

secured properties typically user credentials for the connection

toString

public String toString()

Standard toString method. Note SecuredProperties 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