com.liferay.portal.tools.deploy
Class BaseDeployer

java.lang.Object
  extended by com.liferay.portal.tools.deploy.BaseDeployer
All Implemented Interfaces:
com.liferay.portal.kernel.deploy.Deployer
Direct Known Subclasses:
ExtDeployer, HookDeployer, LayoutTemplateDeployer, PortletDeployer, ThemeDeployer, WebDeployer

public class BaseDeployer
extends java.lang.Object
implements com.liferay.portal.kernel.deploy.Deployer

View Source

Author:
Brian Wing Shun Chan, Sandeep Soni

Field Summary
protected  java.lang.String appServerType
           
protected  java.lang.String baseDir
           
static java.lang.String DEPLOY_TO_PREFIX
           
protected  java.lang.String destDir
           
protected  java.lang.String filePattern
           
protected  java.util.List<java.lang.String> jars
           
protected  java.lang.String jbossPrefix
           
protected  java.lang.String portletExtTaglibDTD
           
protected  java.lang.String portletTaglibDTD
           
protected  java.lang.String securityTaglibDTD
           
protected  java.lang.String themeTaglibDTD
           
protected  java.lang.String tomcatLibDir
           
protected  java.lang.String uiTaglibDTD
           
protected  boolean unpackWar
           
protected  java.lang.String utilTaglibDTD
           
protected  java.util.List<java.lang.String> wars
           
 
Constructor Summary
BaseDeployer()
           
BaseDeployer(java.util.List<java.lang.String> wars, java.util.List<java.lang.String> jars)
           
 
Method Summary
 void addExtJar(java.util.List<java.lang.String> jars, java.lang.String resource)
           
 void addRequiredJar(java.util.List<java.lang.String> jars, java.lang.String resource)
           
 void checkArguments()
           
 void copyDependencyXml(java.lang.String fileName, java.lang.String targetDir)
           
 void copyDependencyXml(java.lang.String fileName, java.lang.String targetDir, java.util.Map<java.lang.String,java.lang.String> filterMap)
           
 void copyDependencyXml(java.lang.String fileName, java.lang.String targetDir, java.util.Map<java.lang.String,java.lang.String> filterMap, boolean overwrite)
           
 void copyJars(java.io.File srcFile, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
           
 void copyPortalDependencies(java.io.File srcFile)
           
 void copyProperties(java.io.File srcFile, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
           
 void copyTlds(java.io.File srcFile, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
           
 void copyXmls(java.io.File srcFile, java.lang.String displayName, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
           
 void deploy()
           
 void deployDirectory(java.io.File srcFile, java.io.File mergeDir, java.io.File deployDir, java.lang.String displayName, boolean overwrite, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
           
 void deployDirectory(java.io.File srcFile, java.lang.String displayName, boolean override, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
           
 void deployFile(java.io.File srcFile)
           
 boolean deployFile(java.io.File srcFile, java.io.File mergeDir, java.io.File deployDir, java.lang.String displayName, boolean overwrite, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
           
 java.lang.String downloadJar(java.lang.String jar)
           
 DeploymentHandler getDeploymentHandler()
           
 java.lang.String getDisplayName(java.io.File srcFile)
           
 java.lang.String getExtraContent(double webXmlVersion, java.io.File srcFile, java.lang.String displayName)
           
 java.lang.String getIgnoreFiltersContent(java.io.File srcFile)
           
 java.lang.String getPluginPackageLicensesXml(java.util.List<com.liferay.portal.kernel.plugin.License> licenses)
           
 java.lang.String getPluginPackageLiferayVersionsXml(java.util.List<java.lang.String> liferayVersions)
           
 java.util.Properties getPluginPackageProperties(java.io.File srcFile)
           
 java.lang.String getPluginPackageTagsXml(java.util.List<java.lang.String> tags)
           
 java.lang.String getSpeedFiltersContent(java.io.File srcFile)
           
 boolean isJEEDeploymentEnabled()
           
static void main(java.lang.String[] args)
           
 void mergeDirectory(java.io.File mergeDir, java.io.File targetDir)
           
 void processPluginPackageProperties(java.io.File srcFile, java.lang.String displayName, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
           
 com.liferay.portal.kernel.plugin.PluginPackage readPluginPackage(java.io.File file)
           
 void rewriteFiles(java.io.File srcDir)
           
 void updateDeployDirectory(java.io.File srcFile)
           
 void updateGeronimoWebXml(java.io.File srcFile, java.lang.String displayName, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
           
 void updateWebXml(java.io.File webXml, java.io.File srcFile, java.lang.String displayName, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEPLOY_TO_PREFIX

public static final java.lang.String DEPLOY_TO_PREFIX
See Also:
Constant Field Values

baseDir

protected java.lang.String baseDir

destDir

protected java.lang.String destDir

appServerType

protected java.lang.String appServerType

portletTaglibDTD

protected java.lang.String portletTaglibDTD

portletExtTaglibDTD

protected java.lang.String portletExtTaglibDTD

securityTaglibDTD

protected java.lang.String securityTaglibDTD

themeTaglibDTD

protected java.lang.String themeTaglibDTD

uiTaglibDTD

protected java.lang.String uiTaglibDTD

utilTaglibDTD

protected java.lang.String utilTaglibDTD

unpackWar

protected boolean unpackWar

filePattern

protected java.lang.String filePattern

jbossPrefix

protected java.lang.String jbossPrefix

tomcatLibDir

protected java.lang.String tomcatLibDir

wars

protected java.util.List<java.lang.String> wars

jars

protected java.util.List<java.lang.String> jars
Constructor Detail

BaseDeployer

public BaseDeployer()

BaseDeployer

public BaseDeployer(java.util.List<java.lang.String> wars,
                    java.util.List<java.lang.String> jars)
Method Detail

main

public static void main(java.lang.String[] args)

addExtJar

public void addExtJar(java.util.List<java.lang.String> jars,
                      java.lang.String resource)
               throws java.lang.Exception
Throws:
java.lang.Exception

addRequiredJar

public void addRequiredJar(java.util.List<java.lang.String> jars,
                           java.lang.String resource)
                    throws java.lang.Exception
Throws:
java.lang.Exception

checkArguments

public void checkArguments()

copyDependencyXml

public void copyDependencyXml(java.lang.String fileName,
                              java.lang.String targetDir)
                       throws java.lang.Exception
Throws:
java.lang.Exception

copyDependencyXml

public void copyDependencyXml(java.lang.String fileName,
                              java.lang.String targetDir,
                              java.util.Map<java.lang.String,java.lang.String> filterMap)
                       throws java.lang.Exception
Throws:
java.lang.Exception

copyDependencyXml

public void copyDependencyXml(java.lang.String fileName,
                              java.lang.String targetDir,
                              java.util.Map<java.lang.String,java.lang.String> filterMap,
                              boolean overwrite)
                       throws java.lang.Exception
Throws:
java.lang.Exception

copyJars

public void copyJars(java.io.File srcFile,
                     com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
              throws java.lang.Exception
Specified by:
copyJars in interface com.liferay.portal.kernel.deploy.Deployer
Throws:
java.lang.Exception

copyPortalDependencies

public void copyPortalDependencies(java.io.File srcFile)
                            throws java.lang.Exception
Throws:
java.lang.Exception

copyProperties

public void copyProperties(java.io.File srcFile,
                           com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
                    throws java.lang.Exception
Specified by:
copyProperties in interface com.liferay.portal.kernel.deploy.Deployer
Throws:
java.lang.Exception

copyTlds

public void copyTlds(java.io.File srcFile,
                     com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
              throws java.lang.Exception
Specified by:
copyTlds in interface com.liferay.portal.kernel.deploy.Deployer
Throws:
java.lang.Exception

copyXmls

public void copyXmls(java.io.File srcFile,
                     java.lang.String displayName,
                     com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
              throws java.lang.Exception
Specified by:
copyXmls in interface com.liferay.portal.kernel.deploy.Deployer
Throws:
java.lang.Exception

deploy

public void deploy()
            throws java.lang.Exception
Throws:
java.lang.Exception

deployDirectory

public void deployDirectory(java.io.File srcFile,
                            java.lang.String displayName,
                            boolean override,
                            com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
                     throws java.lang.Exception
Throws:
java.lang.Exception

deployDirectory

public void deployDirectory(java.io.File srcFile,
                            java.io.File mergeDir,
                            java.io.File deployDir,
                            java.lang.String displayName,
                            boolean overwrite,
                            com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
                     throws java.lang.Exception
Throws:
java.lang.Exception

deployFile

public void deployFile(java.io.File srcFile)
                throws java.lang.Exception
Throws:
java.lang.Exception

deployFile

public boolean deployFile(java.io.File srcFile,
                          java.io.File mergeDir,
                          java.io.File deployDir,
                          java.lang.String displayName,
                          boolean overwrite,
                          com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
                   throws java.lang.Exception
Throws:
java.lang.Exception

downloadJar

public java.lang.String downloadJar(java.lang.String jar)
                             throws java.lang.Exception
Throws:
java.lang.Exception

getDisplayName

public java.lang.String getDisplayName(java.io.File srcFile)

getDeploymentHandler

public DeploymentHandler getDeploymentHandler()

getExtraContent

public java.lang.String getExtraContent(double webXmlVersion,
                                        java.io.File srcFile,
                                        java.lang.String displayName)
                                 throws java.lang.Exception
Throws:
java.lang.Exception

getIgnoreFiltersContent

public java.lang.String getIgnoreFiltersContent(java.io.File srcFile)
                                         throws java.lang.Exception
Throws:
java.lang.Exception

getPluginPackageLicensesXml

public java.lang.String getPluginPackageLicensesXml(java.util.List<com.liferay.portal.kernel.plugin.License> licenses)

getPluginPackageLiferayVersionsXml

public java.lang.String getPluginPackageLiferayVersionsXml(java.util.List<java.lang.String> liferayVersions)

getPluginPackageProperties

public java.util.Properties getPluginPackageProperties(java.io.File srcFile)
                                                throws java.lang.Exception
Throws:
java.lang.Exception

getPluginPackageTagsXml

public java.lang.String getPluginPackageTagsXml(java.util.List<java.lang.String> tags)

getSpeedFiltersContent

public java.lang.String getSpeedFiltersContent(java.io.File srcFile)
                                        throws java.lang.Exception
Throws:
java.lang.Exception

isJEEDeploymentEnabled

public boolean isJEEDeploymentEnabled()

mergeDirectory

public void mergeDirectory(java.io.File mergeDir,
                           java.io.File targetDir)

processPluginPackageProperties

public void processPluginPackageProperties(java.io.File srcFile,
                                           java.lang.String displayName,
                                           com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
                                    throws java.lang.Exception
Specified by:
processPluginPackageProperties in interface com.liferay.portal.kernel.deploy.Deployer
Throws:
java.lang.Exception

readPluginPackage

public com.liferay.portal.kernel.plugin.PluginPackage readPluginPackage(java.io.File file)
Specified by:
readPluginPackage in interface com.liferay.portal.kernel.deploy.Deployer

rewriteFiles

public void rewriteFiles(java.io.File srcDir)
                  throws java.lang.Exception
Throws:
java.lang.Exception

updateDeployDirectory

public void updateDeployDirectory(java.io.File srcFile)
                           throws java.lang.Exception
Throws:
java.lang.Exception

updateGeronimoWebXml

public void updateGeronimoWebXml(java.io.File srcFile,
                                 java.lang.String displayName,
                                 com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
                          throws java.lang.Exception
Throws:
java.lang.Exception

updateWebXml

public void updateWebXml(java.io.File webXml,
                         java.io.File srcFile,
                         java.lang.String displayName,
                         com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
                  throws java.lang.Exception
Specified by:
updateWebXml in interface com.liferay.portal.kernel.deploy.Deployer
Throws:
java.lang.Exception