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, Jose Manuel Vivó

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

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	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) 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) 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
Map<String,ControllerMVCResponseService>	getInstalledControllerMVCResponseTypes() This method gets all implementations of ControllerMVCResponseService interface to be able to locate all installed ControllerMVCResponseService
String	getName()
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 entityMetadata, 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	isInstalledInModule(String moduleName)
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, ServerProvider appServer) This operation will setup Spring MVC on generated project.

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.

isAddDetailControllerAvailable

public boolean isAddDetailControllerAvailable()

This operation will check if add detail controllers operation is available

Specified by:

isAddDetailControllerAvailable in interface ControllerOperations

Returns:

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

isPublishOperationsAvailable

public boolean isPublishOperationsAvailable()

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

Specified by:

isPublishOperationsAvailable in interface ControllerOperations

Returns:

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

createOrUpdateControllerForAllEntities

public 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

Specified by:

createOrUpdateControllerForAllEntities in interface ControllerOperations

Parameters:

responseType - View provider to use

controllerPackage - Package where is situated the controller

pathPrefix - Prefix to use in RequestMapping

createOrUpdateControllerForEntity

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

Description copied from interface: ControllerOperations

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

Specified by:

createOrUpdateControllerForEntity in interface ControllerOperations

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

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

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

createOrUpdateDetailControllersForAllEntities

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

Description copied from interface: ControllerOperations

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

Specified by:

createOrUpdateDetailControllersForAllEntities in interface ControllerOperations

Parameters:

responseType - View provider to use

controllerPackage - Package where is situated the controller

createOrUpdateDetailControllerForEntity

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

Description copied from interface: ControllerOperations

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

Specified by:

createOrUpdateDetailControllerForEntity in interface ControllerOperations

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

getAllMethodsToPublish

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

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

Specified by:

getAllMethodsToPublish in interface ControllerOperations

Parameters:

currentService - Service from which obtain methods

currentController - Controller from which obtain methods

Returns:

methods names list

exportOperation

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

Generate the operations selected in the controller indicated

Specified by:

exportOperation in interface ControllerOperations

Parameters:

controller - Controller where the operations will be created

operations - Service operations names that will be created

getRelationInfoFor

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

Description copied from interface: ControllerOperations

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"

Specified by:

getRelationInfoFor in interface ControllerOperations

Returns:

list of infos

getRelationInfoFor

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

Description copied from interface: ControllerOperations

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"

Specified by:

getRelationInfoFor in interface ControllerOperations

Returns:

getBaseUrlForController

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

Description copied from interface: ControllerOperations

Gets base URL for referenced controller

Specified by:

getBaseUrlForController in interface ControllerOperations

Parameters:

controller - details correctly annotated with RooController

Returns:

getBaseUrlForController

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

Description copied from interface: ControllerOperations

Gets base URL for referenced controller

Specified by:

getBaseUrlForController in interface ControllerOperations

Parameters:

controller - JavaType correctly annotated with RooController

Returns:

getBaseUrlControllerForFinder

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

Description copied from interface: ControllerOperations

Gets finder base URL for referenced controller

Specified by:

getBaseUrlControllerForFinder in interface ControllerOperations

Parameters:

controller - details correctly annotated with RooController and RooSearch

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

Returns:

getBaseUrlControllerForFinder

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

Description copied from interface: ControllerOperations

Gets finder base URL for referenced controller

Specified by:

getBaseUrlControllerForFinder in interface ControllerOperations

Parameters:

controller - JavaType correctly annotated with RooController and RooSearch

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

Returns:

getBasePathForController

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

Description copied from interface: ControllerOperations

Gets base Path for referenced controller

Specified by:

getBasePathForController in interface ControllerOperations

Parameters:

controller - details correctly annotated with RooController

Returns:

getBasePathForController

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

Description copied from interface: ControllerOperations

Gets base Path for referenced controller

Specified by:

getBasePathForController in interface ControllerOperations

Parameters:

controller - JavaType correctly annotated with RooController

Returns: