opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/ConfigRegistry.java

   1 /*
   2  * Copyright (c) 2013, 2017 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.controller.config.api;
   9
  10 import java.util.List;
  11 import java.util.Set;
  12 import javax.management.ObjectName;
  13 import org.opendaylight.controller.config.api.jmx.CommitStatus;
  14 import org.opendaylight.controller.config.api.jmx.constants.ConfigRegistryConstants;
  15
  16 /**
  17  * Provides functionality for working with configuration registry - mainly
  18  * creating and committing config transactions.
  19  */
  20 public interface ConfigRegistry extends LookupRegistry, ServiceReferenceReadableRegistry {
  21
  22     /**
  23      * Only well-known ObjectName in configuration system, under which
  24      * ConfigRegistry is registered.
  25      */
  26     ObjectName OBJECT_NAME = ConfigRegistryConstants.OBJECT_NAME;
  27     ObjectName OBJECT_NAME_NO_NOTIFICATIONS = ConfigRegistryConstants.OBJECT_NAME_NO_NOTIFICATIONS;
  28
  29     /**
  30      * Opens new configuration transaction.
  31      *
  32      * @return {@link ObjectName} of
  33      *         {@link org.opendaylight.controller.config.api.jmx.ConfigTransactionControllerMXBean}
  34      */
  35     ObjectName beginConfig();
  36
  37     /**
  38      * Verifies and commits transaction.
  39      *
  40      * @param transactionControllerON
  41      *            {@link ObjectName} of
  42      *            {@link org.opendaylight.controller.config.api.jmx.ConfigTransactionControllerMXBean}
  43      *            that was received in {@link #beginConfig()} method call.
  44      * @return CommitStatus
  45      * @throws ValidationException
  46      *             if validation fails
  47      * @throws ConflictingVersionException
  48      *             if configuration state was changed
  49      */
  50     CommitStatus commitConfig(ObjectName transactionControllerON)
  51             throws ConflictingVersionException, ValidationException;
  52
  53     /**
  54      * List of open configuration transactions.
  55      *
  56      * @return list of open configuration transactions.
  57      */
  58     List<ObjectName> getOpenConfigs();
  59
  60     /**
  61      * Will return true unless there was a transaction that succeeded during
  62      * validation but failed in second phase of commit. In this case the server is
  63      * unstable and its state is undefined.
  64      */
  65     boolean isHealthy();
  66
  67     /**
  68      * Get the module names available in the system.
  69      *
  70      * @return module factory names available in the system
  71      */
  72     Set<String> getAvailableModuleNames();
  73 }