Class RefreshToken

java.lang.Object
org.localify.user.support.RefreshToken

@Entity public class RefreshToken extends Object
Represents a refresh token for a user session.
  • Constructor Details

    • RefreshToken

      public RefreshToken()
      Default constructor.
  • Method Details

    • getId

      public UUID getId()
      Gets the ID of the refresh token.
      Returns:
      The ID.
    • setId

      public RefreshToken setId(UUID id)
      Sets the ID of the refresh token.
      Parameters:
      id - The ID.
      Returns:
      The refresh token.
    • getSession

      public UserSession getSession()
      Gets the user session associated with the refresh token.
      Returns:
      The user session.
    • setSession

      public RefreshToken setSession(UserSession session)
      Sets the user session associated with the refresh token.
      Parameters:
      session - The user session.
      Returns:
      The refresh token.
    • getIpAddress

      public InetAddress getIpAddress()
      Gets the IP address from which the refresh token was issued.
      Returns:
      The IP address.
    • setIpAddress

      public RefreshToken setIpAddress(InetAddress ipAddress)
      Sets the IP address from which the refresh token was issued.
      Parameters:
      ipAddress - The IP address.
      Returns:
      The refresh token.
    • getUserAgent

      public String getUserAgent()
      Gets the user agent from which the refresh token was issued.
      Returns:
      The user agent.
    • setUserAgent

      public RefreshToken setUserAgent(String userAgent)
      Sets the user agent from which the refresh token was issued.
      Parameters:
      userAgent - The user agent.
      Returns:
      The refresh token.
    • getIssuedAt

      public Instant getIssuedAt()
      Gets the timestamp at which the refresh token was issued.
      Returns:
      The issuance timestamp.
    • setIssuedAt

      public RefreshToken setIssuedAt(Instant issuedAt)
      Sets the timestamp at which the refresh token was issued.
      Parameters:
      issuedAt - The issuance timestamp.
      Returns:
      The refresh token.
    • getExpiresAt

      public Instant getExpiresAt()
      Gets the expiration timestamp of the refresh token.
      Returns:
      The expiration timestamp.
    • setExpiresAt

      public RefreshToken setExpiresAt(Instant expiresAt)
      Sets the expiration timestamp of the refresh token.
      Parameters:
      expiresAt - The expiration timestamp.
      Returns:
      The refresh token.
    • getGeoIpDetails

      public GeoIpDetails getGeoIpDetails()
      Gets the GeoIP details for the refresh token.
      Returns:
      The GeoIP details.
    • setGeoIpDetails

      public RefreshToken setGeoIpDetails(GeoIpDetails geoIpDetails)
      Sets the GeoIP details for the refresh token.
      Parameters:
      geoIpDetails - The GeoIP details.
      Returns:
      The refresh token.
    • getToken

      public String getToken()
      Gets the token string.
      Returns:
      The token string.
    • setToken

      public RefreshToken setToken(String token)
      Sets the token string.
      Parameters:
      token - The token string.
      Returns:
      The refresh token.
    • getConsumedAt

      protected Instant getConsumedAt()
      Gets the consumption timestamp of the refresh token.
      Returns:
      The consumption timestamp.
    • setConsumedAt

      protected void setConsumedAt(Instant consumedAt)
      Sets the consumption timestamp of the refresh token.
      Parameters:
      consumedAt - The consumption timestamp.
    • isConsumed

      public boolean isConsumed()
      Checks if the refresh token has been consumed.
      Returns:
      true if the refresh token has been consumed, false otherwise.
    • consume

      public void consume()
      Marks the refresh token as consumed.