com.liferay.portal.kernel.template.TemplateResourceLoaderUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com.liferay.portal.kernel Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
There is a newer version: 156.0.0
Show newest version
/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */

package com.liferay.portal.kernel.template;

import com.liferay.registry.Registry;
import com.liferay.registry.RegistryUtil;
import com.liferay.registry.ServiceReference;
import com.liferay.registry.ServiceTracker;
import com.liferay.registry.ServiceTrackerCustomizer;

import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;

/**
 * @author Tina Tian
 */
public class TemplateResourceLoaderUtil {

	public static void clearCache() {
		_instance._clearCache();
	}

	public static void clearCache(String templateResourceLoaderName)
		throws TemplateException {

		_instance._clearCache(templateResourceLoaderName);
	}

	public static void clearCache(
			String templateResourceLoaderName, String templateId)
		throws TemplateException {

		_instance._clearCache(templateResourceLoaderName, templateId);
	}

	public static TemplateResource getTemplateResource(
			String templateResourceLoaderName, String templateId)
		throws TemplateException {

		return _instance._getTemplateResource(
			templateResourceLoaderName, templateId);
	}

	public static TemplateResourceLoader getTemplateResourceLoader(
			String templateResourceLoaderName)
		throws TemplateException {

		return _instance._getTemplateResourceLoader(templateResourceLoaderName);
	}

	public static Set getTemplateResourceLoaderNames() {
		return _instance._getTemplateResourceLoaderNames();
	}

	public static boolean hasTemplateResource(
			String templateResourceLoaderName, String templateId)
		throws TemplateException {

		return _instance._hasTemplateResource(
			templateResourceLoaderName, templateId);
	}

	public static boolean hasTemplateResourceLoader(
		String templateResourceLoaderName) {

		return _instance._hasTemplateResourceLoader(templateResourceLoaderName);
	}

	private TemplateResourceLoaderUtil() {
		Registry registry = RegistryUtil.getRegistry();

		_serviceTracker = registry.trackServices(
			TemplateResourceLoader.class,
			new TemplateResourceLoaderTrackerCustomizer());

		_serviceTracker.open();
	}

	private void _clearCache() {
		for (TemplateResourceLoader templateResourceLoader :
				_templateResourceLoaders.values()) {

			templateResourceLoader.clearCache();
		}
	}

	private void _clearCache(String templateResourceLoaderName)
		throws TemplateException {

		TemplateResourceLoader templateResourceLoader =
			_getTemplateResourceLoader(templateResourceLoaderName);

		templateResourceLoader.clearCache();
	}

	private void _clearCache(
			String templateResourceLoaderName, String templateId)
		throws TemplateException {

		TemplateResourceLoader templateResourceLoader =
			_getTemplateResourceLoader(templateResourceLoaderName);

		templateResourceLoader.clearCache(templateId);
	}

	private TemplateResource _getTemplateResource(
			String templateResourceLoaderName, String templateId)
		throws TemplateException {

		TemplateResourceLoader templateResourceLoader =
			_getTemplateResourceLoader(templateResourceLoaderName);

		return templateResourceLoader.getTemplateResource(templateId);
	}

	private TemplateResourceLoader _getTemplateResourceLoader(
			String templateResourceLoaderName)
		throws TemplateException {

		TemplateResourceLoader templateResourceLoader =
			_templateResourceLoaders.get(templateResourceLoaderName);

		if (templateResourceLoader == null) {
			throw new TemplateException(
				"Unsupported template resource loader " +
					templateResourceLoaderName);
		}

		return templateResourceLoader;
	}

	private Set _getTemplateResourceLoaderNames() {
		return _templateResourceLoaders.keySet();
	}

	private boolean _hasTemplateResource(
			String templateResourceLoaderName, String templateId)
		throws TemplateException {

		TemplateResourceLoader templateResourceLoader =
			_getTemplateResourceLoader(templateResourceLoaderName);

		return templateResourceLoader.hasTemplateResource(templateId);
	}

	private boolean _hasTemplateResourceLoader(
		String templateResourceLoaderName) {

		return _templateResourceLoaders.containsKey(templateResourceLoaderName);
	}

	private static final TemplateResourceLoaderUtil _instance =
		new TemplateResourceLoaderUtil();

	private final ServiceTracker
		_serviceTracker;
	private final Map _templateResourceLoaders =
		new ConcurrentHashMap<>();

	private class TemplateResourceLoaderTrackerCustomizer
		implements ServiceTrackerCustomizer
			 {

		@Override
		public TemplateResourceLoader addingService(
			ServiceReference serviceReference) {

			Registry registry = RegistryUtil.getRegistry();

			TemplateResourceLoader templateResourceLoader = registry.getService(
				serviceReference);

			_templateResourceLoaders.put(
				templateResourceLoader.getName(), templateResourceLoader);

			return templateResourceLoader;
		}

		@Override
		public void modifiedService(
			ServiceReference serviceReference,
			TemplateResourceLoader templateResourceLoader) {
		}

		@Override
		public void removedService(
			ServiceReference serviceReference,
			TemplateResourceLoader templateResourceLoader) {

			_templateResourceLoaders.remove(templateResourceLoader.getName());

			templateResourceLoader.clearCache();

			templateResourceLoader.destroy();

			Registry registry = RegistryUtil.getRegistry();

			registry.ungetService(serviceReference);
		}

	}

}