Package io.axoniq.framework.springcloud.discovery

Record Class ServiceInstanceKey

java.lang.Object
java.lang.Record
io.axoniq.framework.springcloud.discovery.ServiceInstanceKey
Record Components:
serviceId - the service id of the instance
host - the host of the instance
port - the port of the instance
public record ServiceInstanceKey(String serviceId, String host, int port) extends Record
An identity for a ServiceInstance that can safely be used as a map key.

ServiceInstance is an interface, and several Spring Cloud Discovery implementations return instances that do not override Object.equals(Object). Two lookups of the same running service therefore routinely produce objects that are unequal, which quietly breaks any bookkeeping keyed on the instance itself. This record pins the identity down to the three fields every implementation populates: the service id, host and port.

Since:
5.4.0
Author:
Allard Buijze

  • Constructor Summary

    Constructors
    Constructor
    Description
    ServiceInstanceKey(String serviceId, String host, int port)
    Creates an instance of a ServiceInstanceKey record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    host()
    Returns the value of the host record component.
    static ServiceInstanceKey
    of(org.springframework.cloud.client.ServiceInstance instance)
    Derives the ServiceInstanceKey of the given instance.
    int
    port()
    Returns the value of the port record component.
    String
    serviceId()
    Returns the value of the serviceId record component.
    String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ServiceInstanceKey

      public ServiceInstanceKey(String serviceId, String host, int port)
      Creates an instance of a ServiceInstanceKey record class.
      Parameters:
      serviceId - the value for the serviceId record component
      host - the value for the host record component
      port - the value for the port record component

  • Method Details

    • of

      public static ServiceInstanceKey of(org.springframework.cloud.client.ServiceInstance instance)
      Derives the ServiceInstanceKey of the given instance.
      Parameters:
      instance - the instance to derive a key for
      Returns:
      the key identifying the given instance

    • toString

      public String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • serviceId

      public String serviceId()
      Returns the value of the serviceId record component.
      Returns:
      the value of the serviceId record component

    • host

      public String host()
      Returns the value of the host record component.
      Returns:
      the value of the host record component

    • port

      public int port()
      Returns the value of the port record component.
      Returns:
      the value of the port record component