org.springframework.roo.addon.web.mvc.controller.addon

Class ControllerOperationsImpl

java.lang.Object

org.springframework.roo.addon.web.mvc.controller.addon.ControllerOperationsImpl

All Implemented Interfaces:

ControllerOperations, org.springframework.roo.project.Feature

@Service
public class ControllerOperationsImpl
extends Object
implements ControllerOperations

Implementation of ControllerOperations.

Since:

1.0

Author:

Stefan Schmidt, Juan Carlos García, Paula Navarro, Sergio Clares

Field Summary

Fields inherited from interface org.springframework.roo.addon.web.mvc.controller.addon.ControllerOperations

FEATURE_NAME

Constructor Summary

Constructors

Constructor and Description
ControllerOperationsImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	activate(org.osgi.service.component.ComponentContext context)
void	createClassFromTemplate(org.springframework.roo.project.maven.Pom module, String templateName, String className, String packageLastElement) Creates a class from a template
void	createController(org.springframework.roo.model.JavaType controller, org.springframework.roo.model.JavaType entity, org.springframework.roo.model.JavaType service, String path, ControllerMVCResponseService responseType, org.springframework.roo.model.JavaPackage formattersPackage) This operation will generate a new controller with the specified information
void	createControllerForAllEntities(org.springframework.roo.model.JavaPackage controllersPackage, ControllerMVCResponseService responseType, org.springframework.roo.model.JavaPackage formattersPackage) This operation will generate a new controller for every class annotated with @RooJpaEntity on current project.
org.springframework.roo.application.config.ApplicationConfigService	getApplicationConfigService()
org.springframework.roo.process.manager.FileManager	getFileManager()
Map<String,ControllerMVCResponseService>	getInstalledControllerMVCResponseTypes() This method gets all implementations of ControllerMVCResponseService interface to be able to locate all installed ControllerMVCResponseService
String	getName()
org.springframework.roo.project.PathResolver	getPathResolver()
org.springframework.roo.shell.Converter<org.springframework.roo.project.maven.Pom>	getPomConverter() This method obtains Pom converter to be able to obtain Pom module from strings
org.springframework.roo.project.ProjectOperations	getProjectOperations()
org.springframework.roo.classpath.TypeLocationService	getTypeLocationService()
org.springframework.roo.classpath.TypeManagementService	getTypeManagementService()
boolean	isAddControllerAvailable() This operation will check if add controllers operation is available
boolean	isInstalledInModule(String moduleName)
boolean	isSetupAvailable() This operation will check if setup operation is available
void	setup(org.springframework.roo.project.maven.Pom module, ServerProvider appServer) This operation will setup Spring MVC on generated project.
void	updateController(org.springframework.roo.model.JavaType controller, ControllerMVCResponseService responseType) Adds provided response type to existing controller

Methods inherited from class java.lang.Object

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

Constructor Detail

ControllerOperationsImpl

public ControllerOperationsImpl()

Method Detail

activate

protected void activate(org.osgi.service.component.ComponentContext context)

isSetupAvailable

public boolean isSetupAvailable()

This operation will check if setup operation is available

Specified by:

isSetupAvailable in interface ControllerOperations

Returns:

true if setup operation is available. false if not.

setup

public void setup(org.springframework.roo.project.maven.Pom module,
         ServerProvider appServer)

This operation will setup Spring MVC on generated project.

Specified by:

setup in interface ControllerOperations

Parameters:

module - Pom module where Spring MVC should be included

appServer - Server where application should be deployed

isAddControllerAvailable

public boolean isAddControllerAvailable()

This operation will check if add controllers operation is available

Specified by:

isAddControllerAvailable in interface ControllerOperations

Returns:

true if add controller operation is available. false if not.

createControllerForAllEntities

public void createControllerForAllEntities(org.springframework.roo.model.JavaPackage controllersPackage,
                                  ControllerMVCResponseService responseType,
                                  org.springframework.roo.model.JavaPackage formattersPackage)

This operation will generate a new controller for every class annotated with @RooJpaEntity on current project.

Specified by:

createControllerForAllEntities in interface ControllerOperations

Parameters:

controllersPackage -

responseType -

formattersPackage -

createController

public void createController(org.springframework.roo.model.JavaType controller,
                    org.springframework.roo.model.JavaType entity,
                    org.springframework.roo.model.JavaType service,
                    String path,
                    ControllerMVCResponseService responseType,
                    org.springframework.roo.model.JavaPackage formattersPackage)

This operation will generate a new controller with the specified information

Specified by:

createController in interface ControllerOperations

Parameters:

controller -

entity -

service -

path -

responseType -

formattersPackage -

updateController

public void updateController(org.springframework.roo.model.JavaType controller,
                    ControllerMVCResponseService responseType)

Description copied from interface: ControllerOperations

Adds provided response type to existing controller

Specified by:

updateController in interface ControllerOperations

createClassFromTemplate

public void createClassFromTemplate(org.springframework.roo.project.maven.Pom module,
                           String templateName,
                           String className,
                           String packageLastElement)

Creates a class from a template

Parameters:

module - the Pom related to modeule where the class should be created

templateName - the String with the template name

className - the String with the class name to create

packageLastElement - the String (optional) with the last element of the package, which will be appended to module artifactId. If null, package will be module artifactId

getTypeLocationService

public org.springframework.roo.classpath.TypeLocationService getTypeLocationService()

getProjectOperations

public org.springframework.roo.project.ProjectOperations getProjectOperations()

getPathResolver

public org.springframework.roo.project.PathResolver getPathResolver()

getFileManager

public org.springframework.roo.process.manager.FileManager getFileManager()

getTypeManagementService

public org.springframework.roo.classpath.TypeManagementService getTypeManagementService()

getApplicationConfigService

public org.springframework.roo.application.config.ApplicationConfigService getApplicationConfigService()

getPomConverter

public org.springframework.roo.shell.Converter<org.springframework.roo.project.maven.Pom> getPomConverter()

This method obtains Pom converter to be able to obtain Pom module from strings

Returns:

getInstalledControllerMVCResponseTypes

public Map<String,ControllerMVCResponseService> getInstalledControllerMVCResponseTypes()

This method gets all implementations of ControllerMVCResponseService interface to be able to locate all installed ControllerMVCResponseService

Returns:

Map with responseTypes identifier and the ControllerMVCResponseService implementation

getName

public String getName()

Specified by:

getName in interface org.springframework.roo.project.Feature

isInstalledInModule

public boolean isInstalledInModule(String moduleName)

Specified by:

isInstalledInModule in interface org.springframework.roo.project.Feature