mgao0 commented on code in PR #2421: URL: https://github.com/apache/helix/pull/2421#discussion_r1149822130
########## meta-client/src/main/java/org/apache/helix/metaclient/recipes/lock/LockClientInterface.java: ########## @@ -0,0 +1,62 @@ +package org.apache.helix.metaclient.recipes.lock; + +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import org.apache.helix.metaclient.api.MetaClientInterface; + +public interface LockClientInterface { + /** + * Acquires a lock by creating a node at entry key and lockinfo info. + * Will fail and return False if path and lockinfo is invalid. + * @param key key to identify the entry + * @param info Metadata of the lock + * @param mode EntryMode identifying if the entry will be deleted upon client disconnect + * @return True if the lock is acquired. False if failed to acquire (catches exception). + */ + boolean acquireLock(String key, LockInfo info, MetaClientInterface.EntryMode mode); + + /** + * Renews lock for a TTL Node. + * Will fail if key is an invalid path or isn't of type TTL. + * @param key key to identify the entry + * @return True if the lock was renews. False if failed to renew (catches exception). Review Comment: nit: did you mean "renewed"? ########## meta-client/src/main/java/org/apache/helix/metaclient/recipes/lock/LockClientInterface.java: ########## @@ -0,0 +1,62 @@ +package org.apache.helix.metaclient.recipes.lock; + +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import org.apache.helix.metaclient.api.MetaClientInterface; + +public interface LockClientInterface { + /** + * Acquires a lock by creating a node at entry key and lockinfo info. + * Will fail and return False if path and lockinfo is invalid. + * @param key key to identify the entry + * @param info Metadata of the lock + * @param mode EntryMode identifying if the entry will be deleted upon client disconnect + * @return True if the lock is acquired. False if failed to acquire (catches exception). + */ + boolean acquireLock(String key, LockInfo info, MetaClientInterface.EntryMode mode); + + /** + * Renews lock for a TTL Node. + * Will fail if key is an invalid path or isn't of type TTL. + * @param key key to identify the entry + * @return True if the lock was renews. False if failed to renew (catches exception). + */ + boolean renewTTLLock(String key); + + /** + * Releases the lock by deleted the node at entry key. Review Comment: Same as the first comment: Delete the node or not I think it depends on the underlying data store. Users just need to know that lock is released. ########## meta-client/src/main/java/org/apache/helix/metaclient/recipes/lock/LockClientInterface.java: ########## @@ -0,0 +1,62 @@ +package org.apache.helix.metaclient.recipes.lock; + +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import org.apache.helix.metaclient.api.MetaClientInterface; + +public interface LockClientInterface { + /** + * Acquires a lock by creating a node at entry key and lockinfo info. + * Will fail and return False if path and lockinfo is invalid. + * @param key key to identify the entry + * @param info Metadata of the lock + * @param mode EntryMode identifying if the entry will be deleted upon client disconnect + * @return True if the lock is acquired. False if failed to acquire (catches exception). + */ + boolean acquireLock(String key, LockInfo info, MetaClientInterface.EntryMode mode); + + /** + * Renews lock for a TTL Node. + * Will fail if key is an invalid path or isn't of type TTL. + * @param key key to identify the entry + * @return True if the lock was renews. False if failed to renew (catches exception). + */ + boolean renewTTLLock(String key); + + /** + * Releases the lock by deleted the node at entry key. + * Will fail if key is an invalid path. + * @param key key to identify the entry + * @return True if the lock was released. False if failed to release (catches exception). + */ + boolean releaseLock(String key); + + /** + * Obtains the metadata of a lock (the LockInfo). + * @param key key to identify the entry + * @return LockInfo object of the node at key. If key doesn't exist, raise exception. Review Comment: We can discuss about this - I think we just need to return an empty LockInfo object or null if the key doesn't exist, usually it's nothing alerting. ########## meta-client/src/main/java/org/apache/helix/metaclient/recipes/lock/LockClientInterface.java: ########## @@ -0,0 +1,62 @@ +package org.apache.helix.metaclient.recipes.lock; + +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import org.apache.helix.metaclient.api.MetaClientInterface; + +public interface LockClientInterface { + /** + * Acquires a lock by creating a node at entry key and lockinfo info. + * Will fail and return False if path and lockinfo is invalid. + * @param key key to identify the entry + * @param info Metadata of the lock + * @param mode EntryMode identifying if the entry will be deleted upon client disconnect + * @return True if the lock is acquired. False if failed to acquire (catches exception). + */ + boolean acquireLock(String key, LockInfo info, MetaClientInterface.EntryMode mode); Review Comment: There is nothing wrong with your code, this matches our current design. But I had a second thought about it and want to start a discussion with @Marcosrico @xyuanlu , do you think it's worthy to create a class for the operation result (two fields: boolean succeed, enum for return code)? Since we won't be able to surface the failure reason to users in this current way. ########## meta-client/src/main/java/org/apache/helix/metaclient/recipes/lock/LockClientInterface.java: ########## @@ -0,0 +1,62 @@ +package org.apache.helix.metaclient.recipes.lock; + +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import org.apache.helix.metaclient.api.MetaClientInterface; + +public interface LockClientInterface { + /** + * Acquires a lock by creating a node at entry key and lockinfo info. Review Comment: The internal logic of lock client can vary for different data stores, for example, for some data stores, we create a node for acquiring a lock, and for others, we may just update the znode data for acquiring a lock. So you may modify this statement a little. -- 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]
