Class EndpointProperties

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    EndpointRequestBody

    public class EndpointProperties
    extends ReferenceableProperties
    EndpointProperties describes the properties of a server endpoint. The endpoint is linked to the data manager's server and describes its network endpoint. It is also linked to connection objects that are used by clients to connect to the data manager. A connection is linked to each asset that is hosted on the data manager.
    See Also:
    Serialized Form
    • Constructor Detail

      • EndpointProperties

        public EndpointProperties()
        Default constructor
      • EndpointProperties

        public EndpointProperties​(EndpointProperties template)
        Copy/clone constructor for an Endpoint.
        Parameters:
        template - template object to copy.
    • Method Detail

      • setDisplayName

        public void setDisplayName​(java.lang.String displayName)
        Set up the display name for UIs and reports.
        Parameters:
        displayName - String name
      • 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:
        String name
      • setDescription

        public void setDescription​(java.lang.String description)
        Set up description of the element.
        Parameters:
        description - String
      • getDescription

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

        public void setAddress​(java.lang.String address)
        Set up the network address of the Endpoint.
        Parameters:
        address - String resource name
      • 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
      • setProtocol

        public void setProtocol​(java.lang.String protocol)
        Set up the protocol to use for this Endpoint
        Parameters:
        protocol - String protocol name
      • 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
      • setEncryptionMethod

        public void setEncryptionMethod​(java.lang.String encryptionMethod)
        Set up the encryption method used on this Endpoint.
        Parameters:
        encryptionMethod - String name
      • 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 ReferenceableProperties
        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 ReferenceableProperties
        Parameters:
        objectToCompare - supplied object
        Returns:
        boolean result of comparison