Package org.odpi.openmetadata.frameworks.connectors.properties

Class VirtualConnectionProperties

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.ConnectionProperties
org.odpi.openmetadata.frameworks.connectors.properties.VirtualConnectionProperties
public class VirtualConnectionProperties extends ConnectionProperties
The VirtualConnectionProperties is an object that contains the properties needed to create and initialise a virtual connector to access a virtual asset that is constructed from access to one of more other assets. Connectors are uses to access the underlying assets.

The properties for VirtualConnectionProperties are those for ConnectionProperties plus a list of connections for the embedded connectors.

  • Field Details

  • Constructor Details

    • VirtualConnectionProperties

      public VirtualConnectionProperties(VirtualConnection connectionBean)
      Bean constructor
      Parameters:
      connectionBean - bean containing the properties

    • VirtualConnectionProperties

      public VirtualConnectionProperties(VirtualConnectionProperties templateConnection)
      Copy/clone Constructor to return a copy of a connection object that is connected to an asset.
      Parameters:
      templateConnection - template object to copy.

  • Method Details

    • getConnectionBean

      protected VirtualConnection getConnectionBean()
      Return the bean with all the properties.
      Overrides:
      getConnectionBean in class ConnectionProperties
      Returns:
      connection bean

    • getEmbeddedConnections

      public List<EmbeddedConnectionProperties> getEmbeddedConnections()
      Returns the stored display name property for the connection. Null means no displayName is available.
      Returns:
      displayName

    • getConnectionName

      public String getConnectionName()
      Returns a formatted string with the connection name. It is used in formatting error messages for the exceptions thrown by consuming components. It is extremely cautious because most of the exceptions are reporting a malformed connection object so who knows what else is wrong with it. Within the connection are 2 possible properties that could contain the connection name: ** qualifiedName - this is a uniqueName and should be there ** displayName - shorter simpler name but may not be unique - so may not identify the connection in error This method inspects these properties and builds up a string to represent the connection name
      Overrides:
      getConnectionName in class ConnectionProperties
      Returns:
      connection name

    • getDescription

      public String getDescription()
      Returns the stored description property for the connection. If no description is provided then null is returned.
      Overrides:
      getDescription in class ConnectionProperties
      Returns:
      description

    • getConnectorType

      public ConnectorTypeProperties getConnectorType()
      Returns a copy of the properties for this connection's connector type. A null means there is no connection type.
      Overrides:
      getConnectorType in class ConnectionProperties
      Returns:
      connector type for the connection

    • getEndpoint

      public EndpointProperties getEndpoint()
      Returns a copy of the properties for this connection's endpoint. Null means no endpoint information available.
      Overrides:
      getEndpoint in class ConnectionProperties
      Returns:
      endpoint for the connection

    • getSecuredProperties

      public Map<String,String> getSecuredProperties()
      Return a copy of the secured properties. Null means no secured properties are available. This method is protected so only OCF (or subclasses) can access them. When Connector is passed to calling OMAS, the secured properties are not available.
      Overrides:
      getSecuredProperties in class ConnectionProperties
      Returns:
      secured properties typically user credentials for the connection

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class ConnectionProperties
      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 ConnectionProperties
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Hash of properties
      Overrides:
      hashCode in class ConnectionProperties
      Returns:
      int