001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.eclipse.aether.named.hazelcast;
020
021import com.hazelcast.core.HazelcastInstance;
022import com.hazelcast.cp.ISemaphore;
023import org.eclipse.aether.named.NamedLockKey;
024
025/**
026 * Support class for providers of {@link ISemaphore} instances.
027 */
028public abstract class HazelcastSemaphoreProvider {
029    /**
030     * Name prefix recommended using for simpler configuration of Hazelcast.
031     */
032    protected static final String NAME_PREFIX = "maven:resolver:";
033
034    /**
035     * Invoked when new instance of semaphore needed for given key. must not return {@code null}.
036     */
037    public abstract ISemaphore acquireSemaphore(HazelcastInstance hazelcastInstance, NamedLockKey key);
038
039    /**
040     * Invoked when passed in semaphore associated with passed in key is not to be used anymore.
041     */
042    public abstract void releaseSemaphore(HazelcastInstance hazelcastInstance, NamedLockKey key, ISemaphore semaphore);
043}