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

Class VirtualConnectionProperties

  • All Implemented Interfaces:
    Serializable
    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
    See Also:
    Serialized Form

    • Constructor Detail

      • VirtualConnectionProperties

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

      • VirtualConnectionProperties

        public VirtualConnectionProperties​(AssetDescriptor parentAsset,
                                   VirtualConnection connectionBean)
        Bean constructor with parent asset
        Parameters:
        parentAsset - description of the asset that this connection is attached to.
        connectionBean - bean containing the properties

      • VirtualConnectionProperties

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

      • VirtualConnectionProperties

        public VirtualConnectionProperties​(AssetDescriptor parentAsset,
                                   VirtualConnectionProperties templateConnection)
        Copy/clone Constructor to return a copy of a connection object that is connected to an asset.
        Parameters:
        parentAsset - description of the asset that this connection is attached to.
        templateConnection - template object to copy.

    • Method Detail

      • 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

      • 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

        protected 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

      • 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