Record Class DSInfo

java.lang.Object
java.lang.Record
org.opends.server.replication.common.DSInfo
Record Components:
replicaId - DS replica id
adminEndpoint - The admin endpoint to connect to this DS
rsId - Server id of the RS that the DS is connected to
generationId - DS Generation Id
status - DS Status
groupId - Group id
processId - DS Process Id
refUrls - DS exported referrals URLs
eclIncludes - The set of entry attributes to include in the ECL
eclIncludesForDeletes - The set of entry attributes to include in the ECL for delete operations
protocolVersion - Protocol version. ProtocolVersion.UNKNOWN_VERSION when the protocol version is not known (too old version).
adminEndpoints - Admin host ports supported by this server.
ldapEndpoints - LDAP host ports supported by this server.
public record DSInfo(ReplicaId replicaId, com.forgerock.opendj.util.HostPort adminEndpoint, ReplicationServerId rsId, GenerationId generationId, ServerStatus status, GroupId groupId, ProcessId processId, Set<String> refUrls, Set<String> eclIncludes, Set<String> eclIncludesForDeletes, short protocolVersion, Set<com.forgerock.opendj.util.HostPort> adminEndpoints, Map<ConnectionSecurity, Set<com.forgerock.opendj.util.HostPort>> ldapEndpoints) extends Record
This class holds information about a DS connected to the topology. This information is to be exchanged through the replication protocol in topology messages, to keep every member (RS or DS) of the topology aware of the DS topology.

  • Constructor Details

    • DSInfo

      public DSInfo(ReplicaId replicaId, com.forgerock.opendj.util.HostPort adminEndpoint, ReplicationServerId rsId, GenerationId generationId, ServerStatus status, GroupId groupId, ProcessId processId, Set<String> refUrls, Set<String> eclIncludes, Set<String> eclIncludesForDeletes, short protocolVersion, Set<com.forgerock.opendj.util.HostPort> adminEndpoints, Map<ConnectionSecurity, Set<com.forgerock.opendj.util.HostPort>> ldapEndpoints)
      Canonical constructor.
      Parameters:
      replicaId - DS replica id
      adminEndpoint - The admin endpoint to connect to this DS
      rsId - Server id of the RS that the DS is connected to
      generationId - DS Generation Id
      status - DS Status
      groupId - Group id
      processId - DS Process Id
      refUrls - DS exported referrals URLs
      eclIncludes - The set of entry attributes to include in the ECL
      eclIncludesForDeletes - The set of entry attributes to include in the ECL for delete operations
      protocolVersion - Protocol version.
      adminEndpoints - Admin host ports supported by this server.
      ldapEndpoints - LDAP host ports supported by this server.

  • Method Details

    • cloneWithReplicationServerId

      public DSInfo cloneWithReplicationServerId(ReplicationServerId rsId)
      Returns a new instance of DSInfo with the specified replication server Id.
      Parameters:
      rsId - the replication server Id to set on the new DSInfo object.
      Returns:
      a new instance of DSInfo with the specified replication server Id

    • equals

      public boolean equals(Object obj)
      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 the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      obj - the object with which to compare
      Returns:
      true if this object is the same as the obj argument; false otherwise.

    • hashCode

      public 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

    • 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

    • replicaId

      public ReplicaId replicaId()
      Returns the value of the replicaId record component.
      Returns:
      the value of the replicaId record component

    • adminEndpoint

      public com.forgerock.opendj.util.HostPort adminEndpoint()
      Returns the value of the adminEndpoint record component.
      Returns:
      the value of the adminEndpoint record component

    • rsId

      public ReplicationServerId rsId()
      Returns the value of the rsId record component.
      Returns:
      the value of the rsId record component

    • generationId

      public GenerationId generationId()
      Returns the value of the generationId record component.
      Returns:
      the value of the generationId record component

    • status

      public ServerStatus status()
      Returns the value of the status record component.
      Returns:
      the value of the status record component

    • groupId

      public GroupId groupId()
      Returns the value of the groupId record component.
      Returns:
      the value of the groupId record component

    • processId

      public ProcessId processId()
      Returns the value of the processId record component.
      Returns:
      the value of the processId record component

    • refUrls

      public Set<String> refUrls()
      Returns the value of the refUrls record component.
      Returns:
      the value of the refUrls record component

    • eclIncludes

      public Set<String> eclIncludes()
      Returns the value of the eclIncludes record component.
      Returns:
      the value of the eclIncludes record component

    • eclIncludesForDeletes

      public Set<String> eclIncludesForDeletes()
      Returns the value of the eclIncludesForDeletes record component.
      Returns:
      the value of the eclIncludesForDeletes record component

    • protocolVersion

      public short protocolVersion()
      Returns the value of the protocolVersion record component.
      Returns:
      the value of the protocolVersion record component

    • adminEndpoints

      public Set<com.forgerock.opendj.util.HostPort> adminEndpoints()
      Returns the value of the adminEndpoints record component.
      Returns:
      the value of the adminEndpoints record component

    • ldapEndpoints

      public Map<ConnectionSecurity, Set<com.forgerock.opendj.util.HostPort>> ldapEndpoints()
      Returns the value of the ldapEndpoints record component.
      Returns:
      the value of the ldapEndpoints record component