opendaylight/containermanager/api/src/main/java/org/opendaylight/controller/containermanager/IContainerManager.java

   1
   2 /*
   3  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   4  *
   5  * This program and the accompanying materials are made available under the
   6  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   7  * and is available at http://www.eclipse.org/legal/epl-v10.html
   8  */
   9
  10 package org.opendaylight.controller.containermanager;
  11
  12 import java.util.List;
  13
  14 import org.opendaylight.controller.sal.utils.Status;
  15
  16 /**
  17  * Container Manager Interface - provides methods to get information on existing OSGI containers
  18  *
  19  */
  20 public interface IContainerManager {
  21
  22     /**
  23      * Returns true if there are any non-default Containers present.
  24      *
  25      * @return  true if any non-default container is present false otherwise.
  26      */
  27     public boolean hasNonDefaultContainer();
  28
  29     /**
  30      * Returns a list of the existing containers.
  31      *
  32      * @return  List of Container name strings.
  33      */
  34     public List<String> getContainerNames();
  35
  36     /**
  37      * Save the current container configuration to disk.
  38      * TODO : REMOVE THIS FUNCTION and make Save as a service rather than the
  39      * current hack of calling individual save routines.
  40      *
  41      * @return  status code
  42      */
  43     @Deprecated
  44     public Status saveContainerConfig();
  45 }