2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.mdsal.singleton.common.api;
11 * {@link ClusterSingletonServiceProvider} provides a functionality to register and group services
12 * {@link ClusterSingletonService} by service group identifier. Services could be Applications or RPCs.
13 * Provider provides a functionality which allows to have only one fully instantiated service instance
14 * in a cluster at one time and service group means to have all service instances for the same group
15 * situated on same Cluster Node. This is realized via a double candidate approach where a service
16 * group instance maintains a candidate registration for ownership of the service group entity in the
17 * cluster and also a registration that acts as a guard to ensure a service group instance has fully
18 * closed prior to relinquishing service group ownership. To achieve ownership of the service group,
19 * a service group candidate must hold ownership of both these entities.
21 public interface ClusterSingletonServiceProvider extends AutoCloseable {
23 * Method registers {@link ClusterSingletonService} to Provider.
24 * Method returns {@link java.lang.RuntimeException} for unexpected state, so be careful with implementation.
25 * Note: RuntimeException is implemented as a notification about some problems with registration and client
26 * has to implement some strategy for handling this issue.
27 * TODO: RuntimeException is not a transparent contract for handling unexpected state and it needs to be
28 * replaced with a specific documented Exception or it needs to add another contract definition for a client
29 * notification about the unexpected state reason in {@link ClusterSingletonService}.
30 * RuntimeException implementation is a hotfix for an unwanted API contract changes in boron release only.
32 * @param service ClusterSingletonService instance
33 * @return {@link AutoCloseable} registration
35 ClusterSingletonServiceRegistration registerClusterSingletonService(ClusterSingletonService service);