appc-adapters/appc-rest-adapter/appc-rest-adapter-bundle/src/main/java/org/onap/appc/adapter/rest/RestActivator.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP : APPC
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Copyright (C) 2017 Amdocs
   8  * =============================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  22  * ============LICENSE_END=========================================================
  23  */
  24
  25 package org.onap.appc.adapter.rest;
  26
  27 import org.onap.appc.Constants;
  28 import org.onap.appc.adapter.rest.impl.RestAdapterImpl;
  29 import org.onap.appc.configuration.Configuration;
  30 import org.onap.appc.configuration.ConfigurationFactory;
  31 import org.onap.appc.i18n.Msg;
  32 import org.osgi.framework.BundleActivator;
  33 import org.osgi.framework.BundleContext;
  34 import org.osgi.framework.ServiceRegistration;
  35
  36 import com.att.eelf.configuration.EELFLogger;
  37 import com.att.eelf.configuration.EELFManager;
  38
  39
  40 /**
  41  * This activator is used to initialize and terminate the connection pool to one or more providers.
  42  * <p>
  43  * The CDP abstraction layer supports multiple types of providers, with each provider supporting multiple tenants. The
  44  * "connection" to a specific tenant on a specific provider is represented by a "context" object. These context objects
  45  * are authenticated to a specific tenant on the provider, but can be reused from one request to another. Contexts are
  46  * slow to set up and are resource intensive, so they are cached. However, the contexts for a specific tenant on a
  47  * specific provider must be cached separately.
  48  * </p>
  49  * <p>
  50  * Activation of the bundle creates an empty cache which is organized first by provider type, then by tenant name, with
  51  * the contents being an empty pool of contexts for that provider/tenant combination. The pool is created on first use,
  52  * and retained for as long as the bundle is active.
  53  * </p>
  54  * <p>
  55  * When the bundle is deactivated, the cache is torn down with all contexts being closed.
  56  * </p>
  57  */
  58 public class RestActivator implements BundleActivator {
  59
  60     /**
  61      * The bundle registration
  62      */
  63     private ServiceRegistration registration = null;
  64
  65     /**
  66      * The reference to the actual implementation object that implements the services
  67      */
  68     private RestAdapter adapter;
  69
  70     /**
  71      * The logger to be used
  72      */
  73     private final EELFLogger logger = EELFManager.getInstance().getLogger(RestActivator.class);
  74
  75     /**
  76      * The configuration object used to configure this bundle
  77      */
  78     private Configuration configuration;
  79
  80     /**
  81      * Called when this bundle is started so the Framework can perform the bundle-specific activities necessary to start
  82      * this bundle. This method can be used to register services or to allocate any resources that this bundle needs.
  83      * <p>
  84      * This method must complete and return to its caller in a timely manner.
  85      * </p>
  86      *
  87      * @param context
  88      *            The execution context of the bundle being started.
  89      * @throws java.lang.Exception
  90      *             If this method throws an exception, this bundle is marked as stopped and the Framework will remove
  91      *             this bundle's listeners, unregister all services registered by this bundle, and release all services
  92      *             used by this bundle.
  93      * @see org.osgi.framework.BundleActivator#start(org.osgi.framework.BundleContext)
  94      */
  95     @Override
  96     public void start(BundleContext context) throws Exception {
  97         logger.info("Starting bundle " + getName());
  98
  99         configuration = ConfigurationFactory.getConfiguration();
 100         String appName = configuration.getProperty(Constants.PROPERTY_APPLICATION_NAME);
 101         logger.info(Msg.COMPONENT_INITIALIZING, appName, "rest adapter");
 102         adapter = new RestAdapterImpl();
 103         if (registration == null) {
 104             registration = context.registerService(RestAdapter.class, adapter, null);
 105         }
 106
 107         logger.info(Msg.COMPONENT_INITIALIZED, appName, "REST adapter");
 108     }
 109
 110     /**
 111      * Called when this bundle is stopped so the Framework can perform the bundle-specific activities necessary to stop
 112      * the bundle. In general, this method should undo the work that the BundleActivator.start method started. There
 113      * should be no active threads that were started by this bundle when this bundle returns. A stopped bundle must not
 114      * call any Framework objects.
 115      * <p>
 116      * This method must complete and return to its caller in a timely manner.
 117      * </p>
 118      *
 119      * @param context
 120      *            The execution context of the bundle being stopped.
 121      * @throws java.lang.Exception
 122      *             If this method throws an exception, the bundle is still marked as stopped, and the Framework will
 123      *             remove the bundle's listeners, unregister all services registered by the bundle, and release all
 124      *             services used by the bundle. *
 125      * @see org.osgi.framework.BundleActivator#stop(org.osgi.framework.BundleContext)
 126      */
 127     @Override
 128     public void stop(BundleContext context) throws Exception {
 129         logger.info("Stopping bundle " + getName());
 130
 131         if (registration != null) {
 132             String appName = configuration.getProperty(Constants.PROPERTY_APPLICATION_NAME);
 133             logger.info(Msg.COMPONENT_TERMINATING, appName, "REST adapter");
 134             logger.info(Msg.UNREGISTERING_SERVICE, appName, adapter.getAdapterName());
 135             registration.unregister();
 136             registration = null;
 137             logger.info(Msg.COMPONENT_TERMINATED, appName, "REST adapter");
 138         }
 139     }
 140
 141     public String getName() {
 142         return "APPC IaaS adapter";
 143     }
 144
 145 }