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