org.springframework.roo.addon.surf
Class SurfOperations

java.lang.Object
  org.springframework.roo.addon.surf.SurfOperations

public class SurfOperations
extends Object

Provides Surf related operations.

Since:

1.0

Author:

Yong Qu

Constructor Summary

SurfOperations(org.springframework.roo.process.manager.FileManager fileManager, org.springframework.roo.project.PathResolver pathResolver, org.springframework.roo.metadata.MetadataService metadataService, org.springframework.roo.project.ProjectOperations projectOperations)

Method Summary

void	addPOMDependenciesFromFile(String filePath) Injects additional dependencies into Maven's pom.xml file.
void	installSurf(String siteName) Installs Surf.
void	installSurfAlfrescoSamples() Installs Alfresco sample components for Surf.
void	installSurfCmisSamples() Installs CMIS sample components for Surf.
void	installSurfGroovy() Installs Groovy scripting support into the Surf web application.
void	installSurfPackage(String packageName) Installs the Surf package with the given name into the current web application
void	installSurfPackageLocal(String packageName, boolean deleteOnFinish) Installs a Surf site package from a file path in the current web application.
void	installSurfPHP() Installs PHP template support into the Surf web application.
void	installSurfSampleSite() Installs the default Surf sample site (Roo included)
void	installSurfStudio() Installs Web Studio into the Surf web application.
boolean	isInstallSurfAvailable() Returns whether Surf is installed or not.
boolean	isManageSurfAvailable() Returns whether Surf is available.

Methods inherited from class java.lang.Object

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

Constructor Detail

SurfOperations

public SurfOperations(org.springframework.roo.process.manager.FileManager fileManager,
                      org.springframework.roo.project.PathResolver pathResolver,
                      org.springframework.roo.metadata.MetadataService metadataService,
                      org.springframework.roo.project.ProjectOperations projectOperations)

Parameters:

fileManager -

pathResolver -

metadataService -

projectOperations -

Method Detail

isInstallSurfAvailable

public boolean isInstallSurfAvailable()

Returns whether Surf is installed or not.

Returns:

True if Surf has not been installed. False if Surf has been installed.

isManageSurfAvailable

public boolean isManageSurfAvailable()

Returns whether Surf is available.

Returns:

True if Surf has been installed. False if Surf has not been installed.

installSurf

public void installSurf(String siteName)

Installs Surf.

Parameters:

siteName - Surf site name. The project name will be used as the default if the site name is not specified.

installSurfSampleSite

public void installSurfSampleSite()

Installs the default Surf sample site (Roo included)

installSurfPackage

public void installSurfPackage(String packageName)

Installs the Surf package with the given name into the current web application

Parameters:

packageName - Package name.

installSurfPackageLocal

public void installSurfPackageLocal(String packageName,
                                    boolean deleteOnFinish)

Installs a Surf site package from a file path in the current web application.

Parameters:

zipFilePath - the path to the file relative to the web application root

deleteOnFinish - whether to delete the file when finished

installSurfPHP

public void installSurfPHP()

Installs PHP template support into the Surf web application.

installSurfGroovy

public void installSurfGroovy()

Installs Groovy scripting support into the Surf web application.

installSurfStudio

public void installSurfStudio()

Installs Web Studio into the Surf web application.

installSurfCmisSamples

public void installSurfCmisSamples()

Installs CMIS sample components for Surf.

installSurfAlfrescoSamples

public void installSurfAlfrescoSamples()

Installs Alfresco sample components for Surf.

addPOMDependenciesFromFile

public void addPOMDependenciesFromFile(String filePath)

Injects additional dependencies into Maven's pom.xml file.

Parameters:

filePath - Dependency template file name.