001/* 002 * Copyright 2018 Anyware Services 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 */ 016package org.ametys.cms.tag; 017 018import java.util.Map; 019import java.util.Set; 020 021import org.ametys.runtime.plugin.component.AbstractThreadSafeComponentExtensionPoint; 022 023/** 024 * This class is in charge to load and initialize tag providers. 025 * @param <T> The tag class 026 */ 027public abstract class AbstractTagProviderExtensionPoint<T extends Tag> extends AbstractThreadSafeComponentExtensionPoint<TagProvider<T>> 028{ 029 /** 030 * Get the tag 031 * @param name The tag's name 032 * @param contextualParameters Contextual parameters 033 * @return the tag or null if tag is not found 034 */ 035 public T getTag(String name, Map<String, Object> contextualParameters) 036 { 037 Set<String> extensionsIds = getExtensionsIds(); 038 039 for (String id : extensionsIds) 040 { 041 TagProvider<T> tagProvider = getExtension(id); 042 if (tagProvider.hasTag(name, contextualParameters)) 043 { 044 return tagProvider.getTag(name, contextualParameters); 045 } 046 } 047 048 return null; 049 } 050 051 /** 052 * Check if the tag exists 053 * @param name The tag's name 054 * @param contextualParameters Contextual parameters 055 * @return <code>true</code> if the tag is found, <code>false</code> otherwise 056 */ 057 public boolean hasTag(String name, Map<String, Object> contextualParameters) 058 { 059 Set<String> extensionsIds = getExtensionsIds(); 060 061 for (String id : extensionsIds) 062 { 063 TagProvider<T> tagProvider = getExtension(id); 064 if (tagProvider.hasTag(name, contextualParameters)) 065 { 066 return true; 067 } 068 } 069 070 return false; 071 } 072 073 /** 074 * Get the tags node name 075 * @return the tags node name 076 */ 077 public abstract String getTagsNodeName(); 078 079 /** 080 * Get the tag node type 081 * @return the tag node type 082 */ 083 public abstract String getTagsNodeType(); 084}