Package org.odpi.openmetadata.accessservices.itinfrastructure.properties

Class EndpointProperties

java.lang.Object
org.odpi.openmetadata.accessservices.itinfrastructure.properties.ReferenceableProperties
org.odpi.openmetadata.accessservices.itinfrastructure.properties.ConfigurationItemProperties
org.odpi.openmetadata.accessservices.itinfrastructure.properties.EndpointProperties
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
EndpointRequestBody
public class EndpointProperties extends ConfigurationItemProperties
EndpointProperties describes the properties of a server endpoint. The endpoint is linked to the data platform's server and describes its network endpoint. It is also linked to connection objects that are used by clients to connect to the data platform. A connection is linked to each asset that is hosted on the data platform.
See Also:

  • Constructor Details

    • EndpointProperties

      public EndpointProperties()
      Default constructor

    • EndpointProperties

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

  • Method Details

    • setDisplayName

      public void setDisplayName(String displayName)
      Set up the display name for UIs and reports.
      Parameters:
      displayName - String name

    • getDisplayName

      public 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(String description)
      Set up description of the element.
      Parameters:
      description - String

    • getDescription

      public String getDescription()
      Return the description for the endpoint.
      Returns:
      String description

    • setAddress

      public void setAddress(String address)
      Set up the network address of the Endpoint.
      Parameters:
      address - String resource name

    • getAddress

      public 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(String protocol)
      Set up the protocol to use for this Endpoint
      Parameters:
      protocol - String protocol name

    • getProtocol

      public 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(String encryptionMethod)
      Set up the encryption method used on this Endpoint.
      Parameters:
      encryptionMethod - String name

    • getEncryptionMethod

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

    • hashCode

      public int hashCode()
      Return hash code based on properties.
      Overrides:
      hashCode in class ConfigurationItemProperties
      Returns:
      int