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.portal.kernel.deploy;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.plugin.PluginPackage;
020    
021    import java.io.File;
022    
023    import java.util.List;
024    import java.util.Map;
025    
026    /**
027     * @author Brian Wing Shun Chan
028     */
029    @ProviderType
030    public interface Deployer {
031    
032            public void addExtJar(List<String> jars, String resource) throws Exception;
033    
034            public void addRequiredJar(List<String> jars, String resource)
035                    throws Exception;
036    
037            public void checkArguments();
038    
039            public void copyDependencyXml(String fileName, String targetDir)
040                    throws Exception;
041    
042            public void copyDependencyXml(
043                            String fileName, String targetDir, Map<String, String> filterMap)
044                    throws Exception;
045    
046            public void copyDependencyXml(
047                            String fileName, String targetDir, Map<String, String> filterMap,
048                            boolean overwrite)
049                    throws Exception;
050    
051            public void copyJars(File srcFile, PluginPackage pluginPackage)
052                    throws Exception;
053    
054            public void copyProperties(File srcFile, PluginPackage pluginPackage)
055                    throws Exception;
056    
057            public void copyTlds(File srcFile, PluginPackage pluginPackage)
058                    throws Exception;
059    
060            public void copyXmls(
061                            File srcFile, String displayName, PluginPackage pluginPackage)
062                    throws Exception;
063    
064            public Map<String, String> processPluginPackageProperties(
065                            File srcFile, String displayName, PluginPackage pluginPackage)
066                    throws Exception;
067    
068            public PluginPackage readPluginPackage(File file);
069    
070            public void setAppServerType(String appServerType);
071    
072            public void setAuiTaglibDTD(String auiTaglibDTD);
073    
074            public void setBaseDir(String baseDir);
075    
076            public void setDestDir(String destDir);
077    
078            public void setFilePattern(String filePattern);
079    
080            public void setJars(List<String> jars);
081    
082            public void setJbossPrefix(String jbossPrefix);
083    
084            public void setPortletExtTaglibDTD(String portletExtTaglibDTD);
085    
086            public void setPortletTaglibDTD(String portletTaglibDTD);
087    
088            public void setSecurityTaglibDTD(String securityTaglibDTD);
089    
090            public void setThemeTaglibDTD(String themeTaglibDTD);
091    
092            public void setTomcatLibDir(String tomcatLibDir);
093    
094            public void setUiTaglibDTD(String uiTaglibDTD);
095    
096            public void setUnpackWar(boolean unpackWar);
097    
098            public void setUtilTaglibDTD(String utilTaglibDTD);
099    
100            public void setWars(List<String> wars);
101    
102            public void setWildflyPrefix(String wildflyPrefix);
103    
104            public void updateWebXml(
105                            File webXml, File srcFile, String displayName,
106                            PluginPackage pluginPackage)
107                    throws Exception;
108    
109            public String wrapCDATA(String string);
110    
111    }