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

Modifier and Type	Method and Description
void	createLinkFactoryClass(org.springframework.roo.model.JavaType controller) Method that creates a new LinkFactory class related to the provided controller
void	createOrUpdateControllerForAllEntities(ControllerMVCResponseService responseType, org.springframework.roo.model.JavaPackage controllerPackage, String pathPrefix) This operation will generate or update a controller for every class annotated with @RooJpaEntity
void	createOrUpdateControllerForEntity(org.springframework.roo.model.JavaType entity, ControllerMVCResponseService responseType, org.springframework.roo.model.JavaPackage controllerPackage, String pathPrefix) This operation will generate or update a controller for a specified entity
void	createOrUpdateDetailControllerForEntity(org.springframework.roo.model.JavaType entity, String relationField, ControllerMVCResponseService responseType, org.springframework.roo.model.JavaPackage controllerPackage, String viewsList) This operation will generate or update a level detail controller for a specified field located in specified entity
void	createOrUpdateDetailControllersForAllEntities(ControllerMVCResponseService responseType, org.springframework.roo.model.JavaPackage controllerPackage, String viewsList) This operation will generate or update a first level detail controller for every class annotated with @RooJpaEntity that has defined a @RooController
void	exportOperation(org.springframework.roo.model.JavaType controller, List<String> operations) Generate the operations selected in the controller indicated
List<String>	getAllMethodsToPublish(String currentService, String currentController) Get all the methods that can be published from the service or the controller established by parameter
String	getBasePathForController(org.springframework.roo.classpath.details.ClassOrInterfaceTypeDetails controller) Gets base Path for referenced controller
String	getBasePathForController(org.springframework.roo.model.JavaType controller) Gets base Path for referenced controller
String	getBaseUrlControllerForFinder(org.springframework.roo.classpath.details.ClassOrInterfaceTypeDetails controller, String finder) Gets finder base URL for referenced controller
String	getBaseUrlControllerForFinder(org.springframework.roo.model.JavaType controller, String finder) Gets finder base URL for referenced controller
String	getBaseUrlForController(org.springframework.roo.classpath.details.ClassOrInterfaceTypeDetails controller) Gets base URL for referenced controller
String	getBaseUrlForController(org.springframework.roo.model.JavaType controller) Gets base URL for referenced controller
List<RelationInfoExtended>	getRelationInfoFor(org.springframework.roo.model.JavaType entity, String path) Return a list of RelationInfoExtended for a field relation path of a entity.
List<RelationInfoExtended>	getRelationInfoFor(org.springframework.roo.addon.jpa.addon.entity.JpaEntityMetadata entity, String path) Return a list of RelationInfoExtended for a field relation path of a entity.
boolean	isAddControllerAvailable() This operation will check if add controllers operation is available
boolean	isAddDetailControllerAvailable() This operation will check if add detail controllers operation is available
boolean	isPublishOperationsAvailable() This operation will check if the operation publish services methods is available
boolean	isSetupAvailable() This operation will check if setup operation is available
void	setup(org.springframework.roo.project.maven.Pom module, boolean usesDefaultModule) This operation will setup Spring MVC on generated project.

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,
           boolean usesDefaultModule)

This operation will setup Spring MVC on generated project.

Parameters:

module - Pom module where Spring MVC should be included

usesDefaultModule - boolean that indicates if the setup command is using the default application module

isAddControllerAvailable

boolean isAddControllerAvailable()

This operation will check if add controllers operation is available

Returns:

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

isAddDetailControllerAvailable

boolean isAddDetailControllerAvailable()

This operation will check if add detail controllers operation is available

Returns:

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

isPublishOperationsAvailable

boolean isPublishOperationsAvailable()

This operation will check if the operation publish services methods is available

Returns:

true if publish services methods is available. false if not.

createOrUpdateControllerForAllEntities

void createOrUpdateControllerForAllEntities(ControllerMVCResponseService responseType,
                                            org.springframework.roo.model.JavaPackage controllerPackage,
                                            String pathPrefix)

This operation will generate or update a controller for every class annotated with @RooJpaEntity

Parameters:

responseType - View provider to use

controllerPackage - Package where is situated the controller

pathPrefix - Prefix to use in RequestMapping

createOrUpdateControllerForEntity

void createOrUpdateControllerForEntity(org.springframework.roo.model.JavaType entity,
                                       ControllerMVCResponseService responseType,
                                       org.springframework.roo.model.JavaPackage controllerPackage,
                                       String pathPrefix)

This operation will generate or update a controller for a specified entity

Parameters:

entity - Entity over which create the controller

responseType - View provider to use

controllerPackage - Package where is situated the controller

pathPrefix - Prefix to use in RequestMapping

createOrUpdateDetailControllersForAllEntities

void createOrUpdateDetailControllersForAllEntities(ControllerMVCResponseService responseType,
                                                   org.springframework.roo.model.JavaPackage controllerPackage,
                                                   String viewsList)

This operation will generate or update a first level detail controller for every class annotated with @RooJpaEntity that has defined a @RooController

Parameters:

responseType - View provider to use

controllerPackage - Package where is situated the controller

viewsList - Separated comma list of all parent views where the new detail will be displayed

createOrUpdateDetailControllerForEntity

void createOrUpdateDetailControllerForEntity(org.springframework.roo.model.JavaType entity,
                                             String relationField,
                                             ControllerMVCResponseService responseType,
                                             org.springframework.roo.model.JavaPackage controllerPackage,
                                             String viewsList)

This operation will generate or update a level detail controller for a specified field located in specified entity

Parameters:

entity - Entity over which create the controller

relationField - Field that set the relationship

responseType - View provider to use

controllerPackage - Package where is situated the controller

viewsList - Separated comma list of all parent views where the new detail will be displayed

getAllMethodsToPublish

List<String> getAllMethodsToPublish(String currentService,
                                    String currentController)

Get all the methods that can be published from the service or the controller established by parameter

Parameters:

currentService - Service from which obtain methods

currentController - Controller from which obtain methods

Returns:

methods names list

exportOperation

void exportOperation(org.springframework.roo.model.JavaType controller,
                     List<String> operations)

Generate the operations selected in the controller indicated

Parameters:

controller - Controller where the operations will be created

operations - Service operations names that will be created

getRelationInfoFor

List<RelationInfoExtended> getRelationInfoFor(org.springframework.roo.model.JavaType entity,
                                              String path)

Return a list of RelationInfoExtended for a field relation path of a entity. path is split by dot char and every return item is information for every path element. by example: entity could be Customer and path "order.details"

Parameters:

entity -

path -

Returns:

list of infos

Throws:

NullPointerException - if entity is null

IllegalArgumentException - if path is incorrect

getRelationInfoFor

List<RelationInfoExtended> getRelationInfoFor(org.springframework.roo.addon.jpa.addon.entity.JpaEntityMetadata entity,
                                              String path)

Return a list of RelationInfoExtended for a field relation path of a entity. path is split by dot char and every return item is information for every path element. by example: entity could be Customer and path "order.details"

Parameters:

entity -

path -

Returns:

getBasePathForController

String getBasePathForController(org.springframework.roo.model.JavaType controller)

Gets base Path for referenced controller

Parameters:

controller - JavaType correctly annotated with RooController

Returns:

getBasePathForController

String getBasePathForController(org.springframework.roo.classpath.details.ClassOrInterfaceTypeDetails controller)

Gets base Path for referenced controller

Parameters:

controller - details correctly annotated with RooController

Returns:

getBaseUrlForController

String getBaseUrlForController(org.springframework.roo.model.JavaType controller)

Gets base URL for referenced controller

Parameters:

controller - JavaType correctly annotated with RooController

Returns:

getBaseUrlForController

String getBaseUrlForController(org.springframework.roo.classpath.details.ClassOrInterfaceTypeDetails controller)

Gets base URL for referenced controller

Parameters:

controller - details correctly annotated with RooController

Returns:

getBaseUrlControllerForFinder

String getBaseUrlControllerForFinder(org.springframework.roo.model.JavaType controller,
                                     String finder)

Gets finder base URL for referenced controller

Parameters:

controller - JavaType correctly annotated with RooController and RooSearch

finder - target. Should be one of RooSearch.finders()

Returns:

getBaseUrlControllerForFinder

String getBaseUrlControllerForFinder(org.springframework.roo.classpath.details.ClassOrInterfaceTypeDetails controller,
                                     String finder)

Gets finder base URL for referenced controller

Parameters:

controller - details correctly annotated with RooController and RooSearch

finder - target. Should be one of RooSearch.finders()

Returns:

createLinkFactoryClass

void createLinkFactoryClass(org.springframework.roo.model.JavaType controller)

Method that creates a new LinkFactory class related to the provided controller

Parameters:

controller -