xyuanlu commented on code in PR #2429:
URL: https://github.com/apache/helix/pull/2429#discussion_r1160300646
##########
meta-client/src/main/java/org/apache/helix/metaclient/recipes/lock/LockInfo.java:
##########
@@ -19,6 +19,231 @@
* under the License.
*/
+import java.time.Duration;
+import java.time.temporal.ChronoUnit;
+import org.apache.helix.zookeeper.datamodel.ZNRecord;
+
+/**
+ * This structure represents a Lock node information, implemented using
ZNRecord
+ */
public class LockInfo {
-}
+
+ // Default values for each attribute if there are no current values set by
user
+ public static final String DEFAULT_LOCK_ID_TEXT = "";
+ public static final String DEFAULT_OWNER_ID_TEXT = "";
+ public static final String DEFAULT_CLIENT_ID_TEXT = "";
+ public static final String DEFAULT_CLIENT_DATA = "";
+ public static final long DEFAULT_GRANTED_AT_LONG = -1L;
+ public static final long DEFAULT_LAST_RENEWED_AT_LONG = -1L;
+ public static final Duration DEFAULT_TIMEOUT_DURATION =
Duration.ofMillis(-1L);
+ private static final String ZNODE_ID = "LOCK";
+ private final ZNRecord _record;
+
+ /**
+ * The keys to lock information
+ */
+ public enum LockInfoAttribute {
+ LOCK_ID,
+ OWNER_ID,
+ CLIENT_ID,
+ //CLIENT_DATA is a string that represents the serialized object passed in
from the user.
+ CLIENT_DATA,
+ GRANTED_AT,
+ LAST_RENEWED_AT,
+ TIMEOUT
+ }
+
+ /**
+ * Initialize a default LockInfo instance
+ */
+ private LockInfo() {
+ _record = new ZNRecord(ZNODE_ID);
+ setLockInfoFields(DEFAULT_LOCK_ID_TEXT, DEFAULT_OWNER_ID_TEXT,
DEFAULT_CLIENT_ID_TEXT, DEFAULT_CLIENT_DATA, DEFAULT_GRANTED_AT_LONG,
+ DEFAULT_LAST_RENEWED_AT_LONG, DEFAULT_TIMEOUT_DURATION);
+ }
+
+ /**
+ * Initialize a LockInfo with a ZNRecord, set all info fields to default data
+ * @param znRecord The ZNRecord contains lock node data that used to
initialize the LockInfo
+ */
+ public LockInfo(ZNRecord znRecord) {
+ this();
+ if (znRecord != null) {
+ String lockId =
znRecord.getSimpleField(LockInfoAttribute.LOCK_ID.name());
+ String ownerId =
znRecord.getSimpleField(LockInfoAttribute.OWNER_ID.name());
+ String clientId =
znRecord.getSimpleField(LockInfoAttribute.CLIENT_ID.name());
+ String clientData =
znRecord.getSimpleField(LockInfoAttribute.CLIENT_DATA.name());
+ long grantTime =
znRecord.getLongField(LockInfoAttribute.GRANTED_AT.name(),
DEFAULT_GRANTED_AT_LONG);
+ long lastRenewalTime =
+ znRecord.getLongField(LockInfoAttribute.LAST_RENEWED_AT.name(),
DEFAULT_LAST_RENEWED_AT_LONG);
+ long timeout = znRecord.getLongField(LockInfoAttribute.TIMEOUT.name(),
DEFAULT_TIMEOUT_DURATION.toMillis());
+ Duration duration = Duration.of(timeout, ChronoUnit.MILLIS);
+ setLockInfoFields(lockId,ownerId, clientId, clientData, grantTime,
+ lastRenewalTime, duration);
+ }
+ }
+
+ /**
+ * Initialize a LockInfo with data for each field, set all null info fields
to default data
+ * @param lockId value of LOCK_ID attribute
+ * @param ownerId value of OWNER_ID attribute
+ * @param clientId value of CLIENT_ID attribute
+ * @param clientData value of CLIENT_DATA attribute
+ * @param grantTime the time the lock was granted
+ * @param lastRenewalTime the last time the lock was renewed
+ * @param timeout value of TIMEOUT attribute
+ */
+ public LockInfo(String lockId, String ownerId, String clientId,
+ String clientData, long grantTime, long lastRenewalTime,
Duration timeout) {
+ this();
+ setLockInfoFields(lockId, ownerId, clientId, clientData, grantTime,
lastRenewalTime, timeout);
+ }
+
+ /**
+ * Set each field of lock info to user provided values if the values
+ * are not null, null values are set to default values
+ * @param lockId value of LOCK_ID attribute
+ * @param ownerId value of OWNER_ID attribute
+ * @param clientId value of CLIENT_ID attribute
+ * @param clientData value of CLIENT_DATA attribute
+ * @param grantTime the time the lock was granted
+ * @param lastRenewalTime the last time the lock was renewed
+ * @param timeout value of TIMEOUT attribute
+ */
+ private void setLockInfoFields(String lockId, String ownerId, String
clientId, String clientData, long grantTime, long lastRenewalTime,
+ Duration timeout) {
+ setLockId(lockId);
+ setOwnerId(ownerId);
+ setClientId(clientId);
+ setClientData(clientData);
+ setGrantedAt(grantTime);
+ setLastRenewedAt(lastRenewalTime);
+ setTimeout(timeout);
+ }
+
+ /**
+ * Set the value for LOCK_ID attribute of the lock
+ * @param lockId String representing the lock id
+ */
+ public void setLockId(String lockId) {
+ _record.setSimpleField(LockInfoAttribute.LOCK_ID.name(), lockId == null ?
DEFAULT_LOCK_ID_TEXT : lockId);
+ }
+
+ /**
+ * Get the value for OWNER_ID attribute of the lock
+ * @param ownerId String representing the owner id
+ */
+ public void setOwnerId(String ownerId) {
Review Comment:
There are 3 `ID` fields in this info. We probably want to explain what's the
difference, what info is suitable for each of these fields, maybe with an
example.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
