Class EndpointProperties

  • All Implemented Interfaces:
    java.io.Serializable

    public class EndpointProperties
    extends AssetReferenceable
    The Endpoint describes the network information necessary for a connector to connect to the server where the Asset is accessible from. The properties for an endpoint are defined in model 0026. They include:
    • type definition of the specific metadata type for the endpoint.
    • guid Globally unique identifier for the endpoint.
    • url External link address for the endpoint properties in the metadata repository. This URL can be stored as a property in another entity to create an explicit link to this endpoint.
    • qualifiedName The official (unique) name for the endpoint. 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 endpoint. 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 description for the endpoint.
    • address - The location of the asset. For network connected resources, this is typically the URL and port number (if needed) for the server where the asset is located (or at least accessible by the connector). For file-based resources, this is typically the name of the file.
    • protocol - The communication protocol that the connection should use to connect to the server.
    • encryptionMethod - Describes the encryption method to use (if any). This is an open value allowing information needed by the connector user to retrieve all the information they need to work with the endpoint.
    • additionalProperties - Any additional properties that the connector need to know in order to access the Asset.
    The Endpoint class is simply used to cache the properties for an endpoint. It is used by other classes to exchange this information between a metadata repository and a consumer.
    See Also:
    Serialized Form
    • Field Detail

      • endpointBean

        protected Endpoint endpointBean
    • Constructor Detail

      • EndpointProperties

        public EndpointProperties​(Endpoint templateEndpoint)
        Copy/clone constructor for an Endpoint that is connected to an Asset (either directly or indirectly).
        Parameters:
        templateEndpoint - template object to copy.
      • EndpointProperties

        public EndpointProperties​(EndpointProperties templateEndpoint)
        Copy/clone constructor for an Endpoint that is connected to an Asset (either directly or indirectly).
        Parameters:
        templateEndpoint - template object to copy.
    • Method Detail

      • getEndpointBean

        protected Endpoint getEndpointBean()
        Return the Endpoint bean that contains all the properties.
        Returns:
        Endpoint bean
      • getDisplayName

        public java.lang.String getDisplayName()
        Returns the stored display name property for the endpoint. If no display name is available then null is returned.
        Returns:
        displayName
      • getDescription

        public java.lang.String getDescription()
        Return the description for the endpoint.
        Returns:
        String description
      • getAddress

        public java.lang.String getAddress()
        Returns the stored address property for the endpoint. If no network address is available then null is returned.
        Returns:
        address
      • getProtocol

        public java.lang.String getProtocol()
        Returns the stored protocol property for the endpoint. If no protocol is available then null is returned.
        Returns:
        protocol
      • getEncryptionMethod

        public java.lang.String getEncryptionMethod()
        Returns the stored encryptionMethod property for the endpoint. This is an open type allowing the information needed to work with a specific encryption mechanism used by the endpoint to be defined. If no encryptionMethod property is available (typically because this is an unencrypted endpoint) then null is returned.
        Returns:
        encryption method information
      • toString

        public java.lang.String toString()
        Standard toString method.
        Overrides:
        toString in class AssetReferenceable
        Returns:
        print out of variables in a JSON-style
      • equals

        public boolean equals​(java.lang.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