Package org.odpi.openmetadata.frameworks.openmetadata.properties.connections

Class EndpointProperties

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataRootProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.SupplementaryProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.connections.EndpointProperties
Direct Known Subclasses:
EndpointRequestBody
public class EndpointProperties extends SupplementaryProperties
EndpointProperties describes the properties of a server endpoint. The endpoint is linked to the asset manager's server and describes its network endpoint. It is also linked to connection objects that are used by clients to connect to the asset manager. A connection is linked to each asset that is hosted on the asset manager.

  • 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

    • setName

      public void setName(String name)
      Set up the technical name for the endpoint.
      Parameters:
      name - String name

    • getName

      public String getName()
      Returns the stored technical name property for the endpoint. If no technical name is available then null is returned.
      Returns:
      String name

    • setResourceDescription

      public void setResourceDescription(String resourceDescription)
      Set up the technical description of the endpoint.
      Parameters:
      resourceDescription - String

    • getResourceDescription

      public String getResourceDescription()
      Return the technical description for the endpoint.
      Returns:
      String technicalDescription

    • 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 SupplementaryProperties
      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 SupplementaryProperties
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Create a hash code for this element type.
      Overrides:
      hashCode in class SupplementaryProperties
      Returns:
      int hash code