Interface MemberIdentityProvider

All Known Implementing Classes:
NullImplementation.NullMemberIdentityProvider, URLMemberIdentityProvider

public interface MemberIdentityProvider
A provider of values for a member's identity.
Since:
22.06
Author:
Jonathan Knight 2022.05.25
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    The System property to use to set the name of the identity provider class to use.
  • Method Summary

    Modifier and Type
    Method
    Description
    Return the name for the Machine (such as a host name) in which this Member resides.
    Return the name for the Member.
    Return the name for the Rack (such as a physical rack, cage or blade frame) in which this Member resides.
    Return the role name for the Member.
    Return the name for the Site (such as a data center) in which this Member resides.
    default void
    Set the cluster dependencies.
  • Field Details

    • PROPERTY

      static final String PROPERTY
      The System property to use to set the name of the identity provider class to use.

      This will take precedence over any providers discovered by the ServiceLoader

      See Also:
  • Method Details

    • getMachineName

      String getMachineName()
      Return the name for the Machine (such as a host name) in which this Member resides. This name is used for logging purposes and to differentiate among multiple servers, and may be used as the basis for determining the MachineId property.
      Returns:
      the configured Machine name or null
    • getMemberName

      String getMemberName()
      Return the name for the Member. This name is used for logging purposes and to differentiate among Members running within a particular process.
      Returns:
      the configured Member name or null
    • getRackName

      String getRackName()
      Return the name for the Rack (such as a physical rack, cage or blade frame) in which this Member resides. This name is used for logging purposes and to differentiate among multiple racks within a particular data center, for example.
      Returns:
      the configured Rack name or null
    • getSiteName

      String getSiteName()
      Return the name for the Site (such as a data center) in which this Member resides. This name is used for logging purposes and to differentiate among multiple geographic sites.
      Returns:
      the configured Site name or null
    • getRoleName

      String getRoleName()
      Return the role name for the Member. This role is completely definable by the application, and can be used to determine what Members to use for specific purposes.
      Returns:
      the configured role name for the Member or null
    • setDependencies

      default void setDependencies(ClusterDependencies deps)
      Set the cluster dependencies.
      Parameters:
      deps - the cluster dependencies