001    /**
002     * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portlet.asset;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.log.Log;
020    import com.liferay.portal.kernel.log.LogFactoryUtil;
021    import com.liferay.portal.kernel.util.ListUtil;
022    import com.liferay.portal.util.PortalUtil;
023    import com.liferay.portlet.asset.model.AssetRendererFactory;
024    import com.liferay.registry.Registry;
025    import com.liferay.registry.RegistryUtil;
026    import com.liferay.registry.ServiceReference;
027    import com.liferay.registry.ServiceRegistration;
028    import com.liferay.registry.ServiceTracker;
029    import com.liferay.registry.ServiceTrackerCustomizer;
030    import com.liferay.registry.collections.ServiceRegistrationMap;
031    
032    import java.util.List;
033    import java.util.Map;
034    import java.util.concurrent.ConcurrentHashMap;
035    
036    /**
037     * @author Bruno Farache
038     * @author Marcellus Tavares
039     */
040    @ProviderType
041    public class AssetRendererFactoryRegistryUtil {
042    
043            /**
044             * @deprecated As of 6.2.0, replaced by {@link
045             *             #getAssetRendererFactories(long)}
046             */
047            @Deprecated
048            public static List<AssetRendererFactory> getAssetRendererFactories() {
049                    return _instance._getAssetRendererFactories();
050            }
051    
052            public static List<AssetRendererFactory> getAssetRendererFactories(
053                    long companyId) {
054    
055                    return _instance._getAssetRendererFactories(companyId);
056            }
057    
058            public static AssetRendererFactory getAssetRendererFactoryByClassName(
059                    String className) {
060    
061                    return _instance._getAssetRendererFactoryByClassName(className);
062            }
063    
064            public static AssetRendererFactory getAssetRendererFactoryByClassNameId(
065                    long classNameId) {
066    
067                    return _instance._getAssetRendererFactoryByClassNameId(classNameId);
068            }
069    
070            public static AssetRendererFactory getAssetRendererFactoryByType(
071                    String type) {
072    
073                    return _instance._getAssetRendererFactoryByType(type);
074            }
075    
076            /**
077             * @deprecated As of 6.2.0, replaced by {@link #getClassNameIds( long)}
078             */
079            @Deprecated
080            public static long[] getClassNameIds() {
081                    return _instance._getClassNameIds(0, false);
082            }
083    
084            public static long[] getClassNameIds(long companyId) {
085                    return _instance._getClassNameIds(companyId, false);
086            }
087    
088            public static long[] getClassNameIds(
089                    long companyId, boolean filterSelectable) {
090    
091                    return _instance._getClassNameIds(companyId, filterSelectable);
092            }
093    
094            public static void register(AssetRendererFactory assetRendererFactory) {
095                    _instance._register(assetRendererFactory);
096            }
097    
098            public static void register(
099                    List<AssetRendererFactory> assetRendererFactories) {
100    
101                    for (AssetRendererFactory assetRendererFactory :
102                                    assetRendererFactories) {
103    
104                            register(assetRendererFactory);
105                    }
106            }
107    
108            public static void unregister(AssetRendererFactory assetRendererFactory) {
109                    _instance._unregister(assetRendererFactory);
110            }
111    
112            public static void unregister(
113                    List<AssetRendererFactory> assetRendererFactories) {
114    
115                    for (AssetRendererFactory assetRendererFactory :
116                                    assetRendererFactories) {
117    
118                            unregister(assetRendererFactory);
119                    }
120            }
121    
122            private AssetRendererFactoryRegistryUtil() {
123                    Registry registry = RegistryUtil.getRegistry();
124    
125                    _serviceTracker = registry.trackServices(
126                            AssetRendererFactory.class,
127                            new AssetRendererFactoryServiceTrackerCustomizer());
128    
129                    _serviceTracker.open();
130            }
131    
132            private Map<String, AssetRendererFactory> _filterAssetRendererFactories(
133                    long companyId,
134                    Map<String, AssetRendererFactory> assetRendererFactories,
135                    boolean filterSelectable) {
136    
137                    Map<String, AssetRendererFactory> filteredAssetRendererFactories =
138                            new ConcurrentHashMap<String, AssetRendererFactory>();
139    
140                    for (String className : assetRendererFactories.keySet()) {
141                            AssetRendererFactory assetRendererFactory =
142                                    assetRendererFactories.get(className);
143    
144                            if (assetRendererFactory.isActive(companyId) &&
145                                    (!filterSelectable || assetRendererFactory.isSelectable())) {
146    
147                                    filteredAssetRendererFactories.put(
148                                            className, assetRendererFactory);
149                            }
150                    }
151    
152                    return filteredAssetRendererFactories;
153            }
154    
155            private List<AssetRendererFactory> _getAssetRendererFactories() {
156                    return ListUtil.fromMapValues(_assetRenderFactoriesMapByClassName);
157            }
158    
159            private List<AssetRendererFactory> _getAssetRendererFactories(
160                    long companyId) {
161    
162                    return ListUtil.fromMapValues(
163                            _filterAssetRendererFactories(
164                                    companyId, _assetRenderFactoriesMapByClassName, false));
165            }
166    
167            private AssetRendererFactory _getAssetRendererFactoryByClassName(
168                    String className) {
169    
170                    return _assetRenderFactoriesMapByClassName.get(className);
171            }
172    
173            private AssetRendererFactory _getAssetRendererFactoryByClassNameId(
174                    long classNameId) {
175    
176                    return _getAssetRendererFactoryByClassName(
177                            PortalUtil.getClassName(classNameId));
178            }
179    
180            private AssetRendererFactory _getAssetRendererFactoryByType(String type) {
181                    return _assetRenderFactoriesMapByClassType.get(type);
182            }
183    
184            private long[] _getClassNameIds(long companyId, boolean filterSelectable) {
185                    Map<String, AssetRendererFactory> assetRenderFactories =
186                            _assetRenderFactoriesMapByClassName;
187    
188                    if (companyId > 0) {
189                            assetRenderFactories = _filterAssetRendererFactories(
190                                    companyId, _assetRenderFactoriesMapByClassName,
191                                    filterSelectable);
192                    }
193    
194                    long[] classNameIds = new long[assetRenderFactories.size()];
195    
196                    int i = 0;
197    
198                    for (AssetRendererFactory assetRendererFactory :
199                                    assetRenderFactories.values()) {
200    
201                            classNameIds[i] = assetRendererFactory.getClassNameId();
202    
203                            i++;
204                    }
205    
206                    return classNameIds;
207            }
208    
209            private void _register(AssetRendererFactory assetRendererFactory) {
210                    Registry registry = RegistryUtil.getRegistry();
211    
212                    ServiceRegistration<AssetRendererFactory> serviceRegistration =
213                            registry.registerService(
214                                    AssetRendererFactory.class, assetRendererFactory);
215    
216                    _serviceRegistrations.put(assetRendererFactory, serviceRegistration);
217            }
218    
219            private void _unregister(AssetRendererFactory assetRendererFactory) {
220                    ServiceRegistration<AssetRendererFactory> serviceRegistration =
221                            _serviceRegistrations.remove(assetRendererFactory);
222    
223                    if (serviceRegistration != null) {
224                            serviceRegistration.unregister();
225                    }
226            }
227    
228            private static Log _log = LogFactoryUtil.getLog(
229                    AssetRendererFactoryRegistryUtil.class);
230    
231            private static AssetRendererFactoryRegistryUtil _instance =
232                    new AssetRendererFactoryRegistryUtil();
233    
234            private Map<String, AssetRendererFactory>
235                    _assetRenderFactoriesMapByClassName =
236                            new ConcurrentHashMap<String, AssetRendererFactory>();
237            private Map<String, AssetRendererFactory>
238                    _assetRenderFactoriesMapByClassType =
239                            new ConcurrentHashMap<String, AssetRendererFactory>();
240            private ServiceRegistrationMap<AssetRendererFactory> _serviceRegistrations =
241                    new ServiceRegistrationMap<AssetRendererFactory>();
242            private ServiceTracker<AssetRendererFactory, AssetRendererFactory>
243                    _serviceTracker;
244    
245            private class AssetRendererFactoryServiceTrackerCustomizer
246                    implements ServiceTrackerCustomizer
247                            <AssetRendererFactory, AssetRendererFactory> {
248    
249                    @Override
250                    public AssetRendererFactory addingService(
251                            ServiceReference<AssetRendererFactory> serviceReference) {
252    
253                            Registry registry = RegistryUtil.getRegistry();
254    
255                            AssetRendererFactory assetRendererFactory = registry.getService(
256                                    serviceReference);
257    
258                            String className = assetRendererFactory.getClassName();
259    
260                            AssetRendererFactory classNameAssetRendererFactory =
261                                    _assetRenderFactoriesMapByClassName.put(
262                                            className, assetRendererFactory);
263    
264                            if (_log.isWarnEnabled() &&
265                                    (classNameAssetRendererFactory != null)) {
266    
267                                    _log.warn(
268                                            "Replacing " + classNameAssetRendererFactory +
269                                                    " for class name " + className + " with " +
270                                                            assetRendererFactory);
271                            }
272    
273                            String type = assetRendererFactory.getType();
274    
275                            AssetRendererFactory typeAssetRendererFactory =
276                                    _assetRenderFactoriesMapByClassType.put(
277                                            type, assetRendererFactory);
278    
279                            if (_log.isWarnEnabled() && (typeAssetRendererFactory != null)) {
280                                    _log.warn(
281                                            "Replacing " + typeAssetRendererFactory + " for type " +
282                                                    type + " with " + assetRendererFactory);
283                            }
284    
285                            return assetRendererFactory;
286                    }
287    
288                    @Override
289                    public void modifiedService(
290                            ServiceReference<AssetRendererFactory> serviceReference,
291                            AssetRendererFactory assetRendererFactory) {
292                    }
293    
294                    @Override
295                    public void removedService(
296                            ServiceReference<AssetRendererFactory> serviceReference,
297                            AssetRendererFactory assetRendererFactory) {
298    
299                            Registry registry = RegistryUtil.getRegistry();
300    
301                            registry.ungetService(serviceReference);
302    
303                            _assetRenderFactoriesMapByClassName.remove(
304                                    assetRendererFactory.getClassName());
305                            _assetRenderFactoriesMapByClassType.remove(
306                                    assetRendererFactory.getType());
307                    }
308    
309            }
310    
311    }