828cdb7732d86f0fe05422979fd691473969e634
[appc.git] / services / appc-dmaap-service / appc-dmaap-adapter-bundle / src / main / java / org / onap / appc / adapter / messaging / dmaap / AppcDmaapAdapterActivator.java
1 /*-
2  * ============LICENSE_START=======================================================
3  * ONAP : APPC
4  * ================================================================================
5  * Copyright (C) 2017-2018 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  * ============LICENSE_END=========================================================
22  */
23
24 package org.onap.appc.adapter.messaging.dmaap;
25
26 import com.att.eelf.configuration.EELFLogger;
27 import com.att.eelf.configuration.EELFManager;
28 import org.osgi.framework.BundleActivator;
29 import org.osgi.framework.BundleContext;
30
31
32
33 /**
34  * This activator is used to initialize and terminate the connection pool to one or more providers.
35  * <p>
36  * The CDP abstraction layer supports multiple types of providers, with each provider supporting multiple tenants. The
37  * "connection" to a specific tenant on a specific provider is represented by a "context" object. These context objects
38  * are authenticated to a specific tenant on the provider, but can be reused from one request to another. Contexts are
39  * slow to set up and are resource intensive, so they are cached. However, the contexts for a specific tenant on a
40  * specific provider must be cached separately.
41  * </p>
42  * <p>
43  * Activation of the bundle creates an empty cache which is organized first by provider type, then by tenant name, with
44  * the contents being an empty pool of contexts for that provider/tenant combination. The pool is created on first use,
45  * and retained for as long as the bundle is active.
46  * </p>
47  * <p>
48  * When the bundle is deactivated, the cache is torn down with all contexts being closed.
49  * </p>
50  */
51 public class AppcDmaapAdapterActivator implements BundleActivator {
52
53     /**
54      * The logger to be used
55      */
56     private static final EELFLogger LOG = EELFManager.getInstance().getLogger(AppcDmaapAdapterActivator.class);
57
58     /**
59      * Called when this bundle is started so the Framework can perform the bundle-specific activities necessary to start
60      * this bundle. This method can be used to register services or to allocate any resources that this bundle needs.
61      * <p>
62      * This method must complete and return to its caller in a timely manner.
63      * </p>
64      *
65      * @param bundleContext
66      *            The execution context of the bundle being started.
67      * @throws java.lang.Exception
68      *             If this method throws an exception, this bundle is marked as stopped and the Framework will remove
69      *             this bundle's listeners, unregister all services registered by this bundle, and release all services
70      *             used by this bundle.
71      * @see org.osgi.framework.BundleActivator#start(org.osgi.framework.BundleContext)
72      */
73     @Override
74     public void start(final BundleContext bundleContext) throws Exception {
75         LOG.info("Starting Bundle " + getName());
76     }
77
78     /**
79      * Called when this bundle is stopped so the Framework can perform the bundle-specific activities necessary to stop
80      * the bundle. In general, this method should undo the work that the BundleActivator.start method started. There
81      * should be no active threads that were started by this bundle when this bundle returns. A stopped bundle must not
82      * call any Framework objects.
83      * <p>
84      * This method must complete and return to its caller in a timely manner.
85      * </p>
86      *
87      * @param ctx
88      *            The execution context of the bundle being stopped.
89      * @throws java.lang.Exception
90      *             If this method throws an exception, the bundle is still marked as stopped, and the Framework will
91      *             remove the bundle's listeners, unregister all services registered by the bundle, and release all
92      *             services used by the bundle. *
93      * @see org.osgi.framework.BundleActivator#stop(org.osgi.framework.BundleContext)
94      */
95     @Override
96     public void stop(BundleContext ctx) throws Exception {
97         LOG.info("Stopped Bundle " + getName());
98     }
99
100     public String getName() {
101         return "DMaaP Adapter";
102     }
103
104 }