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

Interface ControllerOperations

All Superinterfaces:

org.springframework.roo.project.Feature

All Known Implementing Classes:

ControllerOperationsImpl

public interface ControllerOperations
extends org.springframework.roo.project.Feature

Provides an API with the available Operations to include Spring MVC on generated project and generate new controllers.

Author:

Ben Alex, Stefan Schmidt, Juan Carlos García, Paula Navarro

Field Summary

Fields

Modifier and Type	Field and Description
static String	FEATURE_NAME

Method Summary

Methods

Modifier and Type	Method and Description
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.
boolean	isAddControllerAvailable() This operation will check if add controllers operation is available
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 interface org.springframework.roo.project.Feature

getName, isInstalledInModule

Field Detail

FEATURE_NAME

static final String FEATURE_NAME

See Also:

Constant Field Values

Method Detail

isSetupAvailable

boolean isSetupAvailable()

This operation will check if setup operation is available

Returns:

true if setup operation is available. false if not.

setup

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

This operation will setup Spring MVC on generated project.

Parameters:

module - Pom module where Spring MVC should be included

appServer - Server where application should be deployed

isAddControllerAvailable

boolean isAddControllerAvailable()

This operation will check if add controllers operation is available

Returns:

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

createControllerForAllEntities

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.

Parameters:

controllersPackage -

responseType -

formattersPackage -

createController

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

Parameters:

controller -

entity -

service -

path -

responseType -

formattersPackage -

updateController

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

Adds provided response type to existing controller

Parameters:

controller -

controllerMVCResponseService -