001/*
002 * HA-JDBC: High-Availability JDBC
003 * Copyright (C) 2012  Paul Ferraro
004 *
005 * This program is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU Lesser General Public License as published by
007 * the Free Software Foundation, either version 3 of the License, or
008 * (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
013 * GNU Lesser General Public License for more details.
014 *
015 * You should have received a copy of the GNU Lesser General Public License
016 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
017 */
018package net.sf.hajdbc.lock.distributed;
019
020import java.util.concurrent.locks.Lock;
021
022import net.sf.hajdbc.distributed.Command;
023
024/**
025 * A lock command to be executed on the group coordinator.
026 * @author Paul Ferraro
027 */
028public abstract class CoordinatorLockCommand<R> implements Command<R, LockCommandContext>
029{
030        private static final long serialVersionUID = 5921849426289256348L;
031        
032        private final RemoteLockDescriptor descriptor;
033
034        protected CoordinatorLockCommand(RemoteLockDescriptor descriptor)
035        {
036                this.descriptor = descriptor;
037        }
038        
039        /**
040         * {@inheritDoc}
041         * @see net.sf.hajdbc.distributed.Command#execute(java.lang.Object)
042         */
043        @Override
044        public R execute(LockCommandContext context)
045        {
046                return this.execute(context.getDistibutedLock(this.descriptor));
047        }
048        
049        protected abstract R execute(Lock lock);
050
051        /**
052         * {@inheritDoc}
053         * @see java.lang.Object#toString()
054         */
055        @Override
056        public String toString()
057        {
058                return String.format("%s(%s)", this.getClass().getSimpleName(), this.descriptor);
059        }
060}