com.liferay.portal.tools.deploy

Class BaseDeployer

Object

com.liferay.portal.tools.deploy.BaseDeployer

All Implemented Interfaces:

com.liferay.portal.kernel.deploy.auto.AutoDeployer, com.liferay.portal.kernel.deploy.Deployer, Closeable, AutoCloseable

Direct Known Subclasses:

ExtDeployer, HookDeployer, LayoutTemplateDeployer, ModuleAutoDeployer, PortletDeployer, ThemeDeployer, WebDeployer

public class BaseDeployer
extends Object
implements com.liferay.portal.kernel.deploy.auto.AutoDeployer, com.liferay.portal.kernel.deploy.Deployer

Author:

Brian Wing Shun Chan, Sandeep Soni

Field Summary

Fields

Modifier and Type	Field and Description
protected String	appServerType
protected String	auiTaglibDTD
protected String	baseDir
static String	DEPLOY_TO_PREFIX
protected String	destDir
protected String	filePattern
protected List<String>	jars
protected String	jbossPrefix
protected String	portletExtTaglibDTD
protected String	portletTaglibDTD
protected String	securityTaglibDTD
protected Set<Path>	tempDirPaths
protected String	themeTaglibDTD
protected String	tomcatLibDir
protected String	uiTaglibDTD
protected boolean	unpackWar
protected String	utilTaglibDTD
protected List<String>	wars
protected String	wildflyPrefix

Fields inherited from interface com.liferay.portal.kernel.deploy.auto.AutoDeployer

CODE_DEFAULT, CODE_NOT_APPLICABLE, CODE_SKIP_NEWER_VERSION

Constructor Summary

Constructors

Constructor and Description
BaseDeployer()
BaseDeployer(List<String> wars, List<String> jars)

Method Summary

Modifier and Type	Method and Description
void	addExtJar(List<String> jars, String resource)
void	addRequiredJar(List<String> jars, String resource)
int	autoDeploy(com.liferay.portal.kernel.deploy.auto.context.AutoDeploymentContext autoDeploymentContext)
void	checkArguments()
com.liferay.portal.kernel.deploy.auto.AutoDeployer	cloneAutoDeployer()
void	close()
void	copyDependencyXml(String fileName, String targetDir)
void	copyDependencyXml(String fileName, String targetDir, Map<String,String> filterMap)
void	copyDependencyXml(String fileName, String targetDir, Map<String,String> filterMap, boolean overwrite)
void	copyJars(File srcFile, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
void	copyPortalDependencies(File srcFile)
void	copyProperties(File srcFile, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
void	copyTlds(File srcFile, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
void	copyTomcatContextXml(File targetDir)
void	copyXmls(File srcFile, String displayName, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
void	deploy(String context)
void	deployDirectory(File srcFile, File mergeDir, File deployDir, String displayName, boolean overwrite, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
void	deployDirectory(File srcFile, String displayName, boolean override, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
int	deployFile(com.liferay.portal.kernel.deploy.auto.context.AutoDeploymentContext autoDeploymentContext)
boolean	deployFile(File srcFile, File mergeDir, File deployDir, String displayName, boolean overwrite, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
String	fixPortalDependencyJar(String portalJar)
DeploymentHandler	getDeploymentHandler()
String	getDisplayName(File srcFile)
String	getDynamicResourceServletContent()
String	getExtraContent(double webXmlVersion, File srcFile, String displayName)
String	getExtraFiltersContent(double webXmlVersion, File srcFile)
String	getIgnoreFiltersContent(File srcFile)
String	getInvokerFilterContent()
String	getInvokerFilterContent(String dispatcher)
String	getPluginPackageLicensesXml(List<com.liferay.portal.kernel.plugin.License> licenses)
String	getPluginPackageLiferayVersionsXml(List<String> liferayVersions)
Properties	getPluginPackageProperties(File srcFile)
String	getPluginPackageRequiredDeploymentContextsXml(List<String> requiredDeploymentContexts)
String	getPluginPackageTagsXml(List<String> tags)
Map<String,String>	getPluginPackageXmlFilterMap(com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
String	getPluginType()
String	getServletContextIncludeFiltersContent(double webXmlVersion, File srcFile)
String	getSessionFiltersContent()
String	getSpeedFiltersContent(File srcFile)
boolean	isJEEDeploymentEnabled()
static void	main(String[] args)
void	mergeDirectory(File mergeDir, File targetDir)
void	postDeploy(String destDir, String deployDir)
void	postDeployGlassfish(String destDir, String deployDir)
void	postDeployJBoss(String destDir, String deployDir)
void	postDeployWildfly(String destDir, String deployDir)
Map<String,String>	processPluginPackageProperties(File srcFile, String displayName, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
com.liferay.portal.kernel.plugin.PluginPackage	readPluginPackage(File file)
void	rewriteFiles(File srcDir)
String	secureWebXml(String content, boolean hasCustomServletListener, boolean securityManagerEnabled)
void	setAppServerType(String appServerType)
void	setAuiTaglibDTD(String auiTaglibDTD)
void	setBaseDir(String baseDir)
void	setDestDir(String destDir)
void	setFilePattern(String filePattern)
void	setJars(List<String> jars)
void	setJbossPrefix(String jbossPrefix)
void	setPortletExtTaglibDTD(String portletExtTaglibDTD)
void	setPortletTaglibDTD(String portletTaglibDTD)
void	setSecurityTaglibDTD(String securityTaglibDTD)
void	setThemeTaglibDTD(String themeTaglibDTD)
void	setTomcatLibDir(String tomcatLibDir)
void	setUiTaglibDTD(String uiTaglibDTD)
void	setUnpackWar(boolean unpackWar)
void	setUtilTaglibDTD(String utilTaglibDTD)
void	setWars(List<String> wars)
void	setWildflyPrefix(String wildflyPrefix)
void	updateDeployDirectory(File srcFile)
String	updateLiferayWebXml(double webXmlVersion, File srcFile, String webXmlContent)
void	updateWebXml(File webXml, File srcFile, String displayName, com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
String	wrapCDATA(String string)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEPLOY_TO_PREFIX

public static final String DEPLOY_TO_PREFIX

See Also:

Constant Field Values

appServerType

protected String appServerType

auiTaglibDTD

protected String auiTaglibDTD

baseDir

protected String baseDir

destDir

protected String destDir

filePattern

protected String filePattern

jars

protected List<String> jars

jbossPrefix

protected String jbossPrefix

portletExtTaglibDTD

protected String portletExtTaglibDTD

portletTaglibDTD

protected String portletTaglibDTD

securityTaglibDTD

protected String securityTaglibDTD

tempDirPaths

protected final Set<Path> tempDirPaths

themeTaglibDTD

protected String themeTaglibDTD

tomcatLibDir

protected String tomcatLibDir

uiTaglibDTD

protected String uiTaglibDTD

unpackWar

protected boolean unpackWar

utilTaglibDTD

protected String utilTaglibDTD

wars

protected List<String> wars

wildflyPrefix

protected String wildflyPrefix

Constructor Detail

BaseDeployer

public BaseDeployer()

BaseDeployer

public BaseDeployer(List<String> wars,
                    List<String> jars)

Method Detail

main

public static void main(String[] args)

addExtJar

public void addExtJar(List<String> jars,
                      String resource)
               throws Exception

Specified by:

addExtJar in interface com.liferay.portal.kernel.deploy.Deployer

Throws:

Exception

addRequiredJar

public void addRequiredJar(List<String> jars,
                           String resource)
                    throws Exception

Specified by:

addRequiredJar in interface com.liferay.portal.kernel.deploy.Deployer

Throws:

Exception

autoDeploy

public int autoDeploy(com.liferay.portal.kernel.deploy.auto.context.AutoDeploymentContext autoDeploymentContext)
               throws com.liferay.portal.kernel.deploy.auto.AutoDeployException

Specified by:

autoDeploy in interface com.liferay.portal.kernel.deploy.auto.AutoDeployer

Throws:

com.liferay.portal.kernel.deploy.auto.AutoDeployException

checkArguments

public void checkArguments()

Specified by:

checkArguments in interface com.liferay.portal.kernel.deploy.Deployer

cloneAutoDeployer

public com.liferay.portal.kernel.deploy.auto.AutoDeployer cloneAutoDeployer()
                                                                     throws com.liferay.portal.kernel.deploy.auto.AutoDeployException

Specified by:

cloneAutoDeployer in interface com.liferay.portal.kernel.deploy.auto.AutoDeployer

Throws:

com.liferay.portal.kernel.deploy.auto.AutoDeployException

close

public void close()
           throws IOException

Specified by:

close in interface com.liferay.portal.kernel.deploy.auto.AutoDeployer

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

copyDependencyXml

public void copyDependencyXml(String fileName,
                              String targetDir)
                       throws Exception

Specified by:

copyDependencyXml in interface com.liferay.portal.kernel.deploy.Deployer

Throws:

Exception

copyDependencyXml

public void copyDependencyXml(String fileName,
                              String targetDir,
                              Map<String,String> filterMap)
                       throws Exception

Specified by:

copyDependencyXml in interface com.liferay.portal.kernel.deploy.Deployer

Throws:

Exception

copyDependencyXml

public void copyDependencyXml(String fileName,
                              String targetDir,
                              Map<String,String> filterMap,
                              boolean overwrite)
                       throws Exception

Specified by:

copyDependencyXml in interface com.liferay.portal.kernel.deploy.Deployer

Throws:

Exception

copyJars

public void copyJars(File srcFile,
                     com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
              throws Exception

Specified by:

copyJars in interface com.liferay.portal.kernel.deploy.Deployer

Throws:

Exception

copyPortalDependencies

public void copyPortalDependencies(File srcFile)
                            throws Exception

Throws:

Exception

copyProperties

public void copyProperties(File srcFile,
                           com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
                    throws Exception

Specified by:

copyProperties in interface com.liferay.portal.kernel.deploy.Deployer

Throws:

Exception

copyTlds

public void copyTlds(File srcFile,
                     com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
              throws Exception

Specified by:

copyTlds in interface com.liferay.portal.kernel.deploy.Deployer

Throws:

Exception

copyTomcatContextXml

public void copyTomcatContextXml(File targetDir)
                          throws Exception

Throws:

Exception

copyXmls

public void copyXmls(File srcFile,
                     String displayName,
                     com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
              throws Exception

Specified by:

copyXmls in interface com.liferay.portal.kernel.deploy.Deployer

Throws:

Exception

deploy

public void deploy(String context)
            throws Exception

Throws:

Exception

deployDirectory

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

Throws:

Exception

deployDirectory

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

Throws:

Exception

deployFile

public int deployFile(com.liferay.portal.kernel.deploy.auto.context.AutoDeploymentContext autoDeploymentContext)
               throws Exception

Throws:

Exception

deployFile

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

Throws:

Exception

fixPortalDependencyJar

public String fixPortalDependencyJar(String portalJar)

getDeploymentHandler

public DeploymentHandler getDeploymentHandler()

getDisplayName

public String getDisplayName(File srcFile)

getDynamicResourceServletContent

public String getDynamicResourceServletContent()

getExtraContent

public String getExtraContent(double webXmlVersion,
                              File srcFile,
                              String displayName)
                       throws Exception

Throws:

Exception

getExtraFiltersContent

public String getExtraFiltersContent(double webXmlVersion,
                                     File srcFile)
                              throws Exception

Throws:

Exception

getIgnoreFiltersContent

public String getIgnoreFiltersContent(File srcFile)
                               throws Exception

Throws:

Exception

getInvokerFilterContent

public String getInvokerFilterContent()

getInvokerFilterContent

public String getInvokerFilterContent(String dispatcher)

getPluginPackageLicensesXml

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

getPluginPackageLiferayVersionsXml

public String getPluginPackageLiferayVersionsXml(List<String> liferayVersions)

getPluginPackageProperties

public Properties getPluginPackageProperties(File srcFile)
                                      throws Exception

Throws:

Exception

getPluginPackageRequiredDeploymentContextsXml

public String getPluginPackageRequiredDeploymentContextsXml(List<String> requiredDeploymentContexts)

getPluginPackageTagsXml

public String getPluginPackageTagsXml(List<String> tags)

getPluginPackageXmlFilterMap

public Map<String,String> getPluginPackageXmlFilterMap(com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)

getPluginType

public String getPluginType()

getServletContextIncludeFiltersContent

public String getServletContextIncludeFiltersContent(double webXmlVersion,
                                                     File srcFile)
                                              throws Exception

Throws:

Exception

getSessionFiltersContent

public String getSessionFiltersContent()
                                throws Exception

Throws:

Exception

getSpeedFiltersContent

public String getSpeedFiltersContent(File srcFile)
                              throws Exception

Throws:

Exception

isJEEDeploymentEnabled

public boolean isJEEDeploymentEnabled()

mergeDirectory

public void mergeDirectory(File mergeDir,
                           File targetDir)

postDeploy

public void postDeploy(String destDir,
                       String deployDir)
                throws Exception

Throws:

Exception

postDeployGlassfish

public void postDeployGlassfish(String destDir,
                                String deployDir)
                         throws Exception

Throws:

Exception

postDeployJBoss

public void postDeployJBoss(String destDir,
                            String deployDir)
                     throws Exception

Throws:

Exception

postDeployWildfly

public void postDeployWildfly(String destDir,
                              String deployDir)
                       throws Exception

Throws:

Exception

processPluginPackageProperties

public Map<String,String> processPluginPackageProperties(File srcFile,
                                                         String displayName,
                                                         com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
                                                  throws Exception

Specified by:

processPluginPackageProperties in interface com.liferay.portal.kernel.deploy.Deployer

Throws:

Exception

readPluginPackage

public com.liferay.portal.kernel.plugin.PluginPackage readPluginPackage(File file)

Specified by:

readPluginPackage in interface com.liferay.portal.kernel.deploy.Deployer

See Also:

PluginPackageUtil._readPluginPackageServletContext( javax.servlet.ServletContext)

rewriteFiles

public void rewriteFiles(File srcDir)
                  throws Exception

Throws:

Exception

secureWebXml

public String secureWebXml(String content,
                           boolean hasCustomServletListener,
                           boolean securityManagerEnabled)
                    throws Exception

Throws:

Exception

setAppServerType

public void setAppServerType(String appServerType)

Specified by:

setAppServerType in interface com.liferay.portal.kernel.deploy.Deployer

setAuiTaglibDTD

public void setAuiTaglibDTD(String auiTaglibDTD)

Specified by:

setAuiTaglibDTD in interface com.liferay.portal.kernel.deploy.Deployer

setBaseDir

public void setBaseDir(String baseDir)

Specified by:

setBaseDir in interface com.liferay.portal.kernel.deploy.Deployer

setDestDir

public void setDestDir(String destDir)

Specified by:

setDestDir in interface com.liferay.portal.kernel.deploy.Deployer

setFilePattern

public void setFilePattern(String filePattern)

Specified by:

setFilePattern in interface com.liferay.portal.kernel.deploy.Deployer

setJars

public void setJars(List<String> jars)

Specified by:

setJars in interface com.liferay.portal.kernel.deploy.Deployer

setJbossPrefix

public void setJbossPrefix(String jbossPrefix)

Specified by:

setJbossPrefix in interface com.liferay.portal.kernel.deploy.Deployer

setPortletExtTaglibDTD

public void setPortletExtTaglibDTD(String portletExtTaglibDTD)

Specified by:

setPortletExtTaglibDTD in interface com.liferay.portal.kernel.deploy.Deployer

setPortletTaglibDTD

public void setPortletTaglibDTD(String portletTaglibDTD)

Specified by:

setPortletTaglibDTD in interface com.liferay.portal.kernel.deploy.Deployer

setSecurityTaglibDTD

public void setSecurityTaglibDTD(String securityTaglibDTD)

Specified by:

setSecurityTaglibDTD in interface com.liferay.portal.kernel.deploy.Deployer

setThemeTaglibDTD

public void setThemeTaglibDTD(String themeTaglibDTD)

Specified by:

setThemeTaglibDTD in interface com.liferay.portal.kernel.deploy.Deployer

setTomcatLibDir

public void setTomcatLibDir(String tomcatLibDir)

Specified by:

setTomcatLibDir in interface com.liferay.portal.kernel.deploy.Deployer

setUiTaglibDTD

public void setUiTaglibDTD(String uiTaglibDTD)

Specified by:

setUiTaglibDTD in interface com.liferay.portal.kernel.deploy.Deployer

setUnpackWar

public void setUnpackWar(boolean unpackWar)

Specified by:

setUnpackWar in interface com.liferay.portal.kernel.deploy.Deployer

setUtilTaglibDTD

public void setUtilTaglibDTD(String utilTaglibDTD)

Specified by:

setUtilTaglibDTD in interface com.liferay.portal.kernel.deploy.Deployer

setWars

public void setWars(List<String> wars)

Specified by:

setWars in interface com.liferay.portal.kernel.deploy.Deployer

setWildflyPrefix

public void setWildflyPrefix(String wildflyPrefix)

Specified by:

setWildflyPrefix in interface com.liferay.portal.kernel.deploy.Deployer

updateDeployDirectory

public void updateDeployDirectory(File srcFile)
                           throws Exception

Throws:

Exception

updateLiferayWebXml

public String updateLiferayWebXml(double webXmlVersion,
                                  File srcFile,
                                  String webXmlContent)
                           throws Exception

Throws:

Exception

updateWebXml

public void updateWebXml(File webXml,
                         File srcFile,
                         String displayName,
                         com.liferay.portal.kernel.plugin.PluginPackage pluginPackage)
                  throws Exception

Specified by:

updateWebXml in interface com.liferay.portal.kernel.deploy.Deployer

Throws:

Exception

wrapCDATA

public String wrapCDATA(String string)

Specified by:

wrapCDATA in interface com.liferay.portal.kernel.deploy.Deployer