Adding interfaces in documentation
[aai/sparky-be.git] / sparkybe-onap-service / src / main / java / org / onap / aai / sparky / search / registry / SearchProviderRegistry.java
1 /**
2  * ============LICENSE_START===================================================
3  * SPARKY (AAI UI service)
4  * ============================================================================
5  * Copyright © 2017 AT&T Intellectual Property.
6  * Copyright © 2017 Amdocs
7  * All rights reserved.
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  * ============LICENSE_END=====================================================
21  *
22  * ECOMP and OpenECOMP are trademarks
23  * and service marks of AT&T Intellectual Property.
24  */
25 package org.onap.aai.sparky.search.registry;
26
27 import java.util.ArrayList;
28 import java.util.List;
29
30 import org.onap.aai.sparky.search.api.SearchProvider;
31
32 /**
33  * Make this a java-scoped singleton to resolve the contextual issue spanning a Spring Context and
34  * accessing the SPR in other parts of the code that are not directly instantiated by a Spring Bean.
35  * Eventually the SPR doesn’t have to be a real singleton, it could simply be a Spring bean scoped
36  * as a singleton and then wired in via dependency injection to the classes that need it. But I’m
37  * not there yet. This will get a demonstrable extension mechanism in place quickly at practically
38  * no cost, beyond what’s already in the email plus some testing.
39  */
40
41 public class SearchProviderRegistry {
42
43   private List<SearchProvider> searchProviders;
44
45   public SearchProviderRegistry() {
46     searchProviders = new ArrayList<SearchProvider>();
47   }
48
49   public List<SearchProvider> getSearchProviders() {
50     return searchProviders;
51   }
52
53   public final void addSearchProvider(SearchProvider searchProvider) {
54
55     if (searchProvider == null) {
56       return;
57     }
58
59     if (!searchProviders.contains(searchProvider)) {
60       searchProviders.add(searchProvider);
61     }
62   }
63
64   public final void addSearchProviders(List<SearchProvider> searchProviders) {
65
66     if (searchProviders == null) {
67       return;
68     }
69
70     for (SearchProvider searchProvider : searchProviders) {
71       addSearchProvider(searchProvider);
72     }
73
74   }
75
76 }