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

Class ControllerCommands

java.lang.Object

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

All Implemented Interfaces:

org.springframework.roo.shell.CommandMarker

@Service
public class ControllerCommands
extends Object
implements org.springframework.roo.shell.CommandMarker

This class provides necessary commands to be able to include Spring MVC on generated project and generate new controllers.

Since:

1.0

Author:

Stefan Schmidt, Juan Carlos García, Paula Navarro

Constructor Summary

Constructors

Constructor and Description
ControllerCommands()

Method Summary

Modifier and Type	Method and Description
protected void	activate(org.osgi.service.component.ComponentContext context)
void	addController(boolean all, org.springframework.roo.model.JavaType entity, String responseType, org.springframework.roo.model.JavaPackage controllersPackage, String pathPrefix) This method provides the Command definition to be able to generate new Controllers on current project.
void	addDetailController(boolean all, org.springframework.roo.model.JavaType entity, String field, org.springframework.roo.model.JavaPackage controllersPackage, String responseType) This method provides the Command definition to be able to generate new Controllers on current project.
boolean	areDetailParametersVisibles(org.springframework.roo.shell.ShellContext context)
boolean	areParametersVisibles(org.springframework.roo.shell.ShellContext context) This indicator says if --package, --pathPrefix and --responseType parameters should be visible or not If --all or --entity parameters have not been specified, --package, --pathPrefix and --responseType parameters will not be visible.
List<String>	getAllAppServers(org.springframework.roo.shell.ShellContext context) This indicator returns the servers where the application can be deployed
List<String>	getAllControllerForOperationCommandValues(org.springframework.roo.shell.ShellContext context)
List<String>	getAllEntities(org.springframework.roo.shell.ShellContext shellContext) Find entities in project and returns a list with their fully qualified names.
List<String>	getAllEntitiesForDetailCommands(org.springframework.roo.shell.ShellContext shellContext)
List<String>	getAllOperationsForOperationCommandValues(org.springframework.roo.shell.ShellContext context)
List<String>	getAllResponseTypeForDetailCommandValues(org.springframework.roo.shell.ShellContext context)
List<String>	getAllResponseTypeValues(org.springframework.roo.shell.ShellContext context) This indicator returns all possible values for --responseType parameter.
List<String>	getAllServiceForOperationCommandValues(org.springframework.roo.shell.ShellContext context)
org.springframework.roo.classpath.operations.ClasspathOperations	getClasspathOperations()
ControllerOperations	getControllerOperations() This method provides the Command definition to be able to publish service operations in controllers.
List<String>	getDetailFieldsRelatedToEntity(org.springframework.roo.shell.ShellContext shellContext)
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
org.springframework.roo.classpath.scanner.MemberDetailsScanner	getMemberDetailsScanner()
org.springframework.roo.project.PathResolver	getPathResolver()
org.springframework.roo.project.ProjectOperations	getProjectOperations()
Map<String,ServerProvider>	getServerProviders() This method gets all implementations of ServerProvider interface to be able to locate all availbale appServers
org.springframework.roo.classpath.TypeLocationService	getTypeLocationService()
boolean	isAddControllerAvailable() This indicator checks if is possible to add new controllers.
boolean	isAddDetailControllerAvailable() This indicator checks if is possible to add new detail controllers.
boolean	isAllParameterOfDetailCommandVisible(org.springframework.roo.shell.ShellContext context)
boolean	isAllParameterOperationVisible(org.springframework.roo.shell.ShellContext context)
boolean	isAllParameterVisible(org.springframework.roo.shell.ShellContext context) This indicator says if --all parameter should be visible or not If --entity parameter has been specified, --all parameter will not be visible to prevent conflicts.
boolean	isEntityParameterOfDetailCommandVisible(org.springframework.roo.shell.ShellContext context)
boolean	isEntityParameterVisible(org.springframework.roo.shell.ShellContext context) This indicator says if --entity parameter should be visible or not If --all parameter has been specified, --entity parameter will not be visible to prevent conflicts.
boolean	isFieldParameterVisible(org.springframework.roo.shell.ShellContext context)
boolean	isModuleRequired(org.springframework.roo.shell.ShellContext shellContext) This indicator checks if --module parameter should be mandatory or not.
boolean	isModuleVisible(org.springframework.roo.shell.ShellContext shellContext) This indicator checks if --module parameter should be visible or not.
boolean	isOperationParameterOperationVisible(org.springframework.roo.shell.ShellContext context)
boolean	isPublishOperationsAvailable() This indicator checks if is possible to publish own operations in controllers.
boolean	isServiceParameterOperationVisible(org.springframework.roo.shell.ShellContext context)
boolean	isSetupAvailable() This indicator checks if Spring MVC setup is available If a valid project has been generated and Spring MVC has not been installed yet, this command will be available.
void	setup(org.springframework.roo.project.maven.Pom module) This method provides the Command definition to be able to include 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

ControllerCommands

public ControllerCommands()

Method Detail

activate

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

isModuleVisible

public boolean isModuleVisible(org.springframework.roo.shell.ShellContext shellContext)

This indicator checks if --module parameter should be visible or not. If exists more than one module that match with the properties of ModuleFeature APPLICATION, --module parameter should be mandatory.

Parameters:

shellContext -

Returns:

isModuleRequired

public boolean isModuleRequired(org.springframework.roo.shell.ShellContext shellContext)

This indicator checks if --module parameter should be mandatory or not. If focused module doesn't match with the properties of ModuleFeature APPLICATION, --module parameter should be mandatory.

Parameters:

shellContext -

Returns:

getAllAppServers

public List<String> getAllAppServers(org.springframework.roo.shell.ShellContext context)

This indicator returns the servers where the application can be deployed

Parameters:

context -

Returns:

isSetupAvailable

public boolean isSetupAvailable()

This indicator checks if Spring MVC setup is available If a valid project has been generated and Spring MVC has not been installed yet, this command will be available.

Returns:

setup

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

This method provides the Command definition to be able to include Spring MVC on generated project.

Parameters:

module -

appServer -

isAllParameterVisible

public boolean isAllParameterVisible(org.springframework.roo.shell.ShellContext context)

This indicator says if --all parameter should be visible or not If --entity parameter has been specified, --all parameter will not be visible to prevent conflicts.

Returns:

isEntityParameterVisible

public boolean isEntityParameterVisible(org.springframework.roo.shell.ShellContext context)

This indicator says if --entity parameter should be visible or not If --all parameter has been specified, --entity parameter will not be visible to prevent conflicts.

Returns:

areParametersVisibles

public boolean areParametersVisibles(org.springframework.roo.shell.ShellContext context)

This indicator says if --package, --pathPrefix and --responseType parameters should be visible or not If --all or --entity parameters have not been specified, --package, --pathPrefix and --responseType parameters will not be visible.

Returns:

getAllEntities

public List<String> getAllEntities(org.springframework.roo.shell.ShellContext shellContext)

Find entities in project and returns a list with their fully qualified names.

Parameters:

shellContext -

Returns:

List with available entity full qualified names.

getAllResponseTypeValues

public List<String> getAllResponseTypeValues(org.springframework.roo.shell.ShellContext context)

This indicator returns all possible values for --responseType parameter. Depends of the specified --controller, responseTypes will be filtered to provide only that responseTypes that doesn't exists on current controller. Also, only installed response types will be provided.

Parameters:

context -

Returns:

isAddControllerAvailable

public boolean isAddControllerAvailable()

This indicator checks if is possible to add new controllers. If a valid project has been generated and Spring MVC has been installed, this command will be available.

Returns:

addController

public void addController(boolean all,
                          org.springframework.roo.model.JavaType entity,
                          String responseType,
                          org.springframework.roo.model.JavaPackage controllersPackage,
                          String pathPrefix)

This method provides the Command definition to be able to generate new Controllers on current project.

Parameters:

all -

entity -

responseType -

package -

pathPrefix -

getServerProviders

public Map<String,ServerProvider> getServerProviders()

This method gets all implementations of ServerProvider interface to be able to locate all availbale appServers

Returns:

Map with appServer identifier and the ServerProvider implementation

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

isAddDetailControllerAvailable

public boolean isAddDetailControllerAvailable()

This indicator checks if is possible to add new detail controllers. If a valid project has been generated and Spring MVC has been installed, this command will be available.

Returns:

isAllParameterOfDetailCommandVisible

public boolean isAllParameterOfDetailCommandVisible(org.springframework.roo.shell.ShellContext context)

isEntityParameterOfDetailCommandVisible

public boolean isEntityParameterOfDetailCommandVisible(org.springframework.roo.shell.ShellContext context)

getAllEntitiesForDetailCommands

public List<String> getAllEntitiesForDetailCommands(org.springframework.roo.shell.ShellContext shellContext)

isFieldParameterVisible

public boolean isFieldParameterVisible(org.springframework.roo.shell.ShellContext context)

getDetailFieldsRelatedToEntity

public List<String> getDetailFieldsRelatedToEntity(org.springframework.roo.shell.ShellContext shellContext)

getAllResponseTypeForDetailCommandValues

public List<String> getAllResponseTypeForDetailCommandValues(org.springframework.roo.shell.ShellContext context)

areDetailParametersVisibles

public boolean areDetailParametersVisibles(org.springframework.roo.shell.ShellContext context)

addDetailController

public void addDetailController(boolean all,
                                org.springframework.roo.model.JavaType entity,
                                String field,
                                org.springframework.roo.model.JavaPackage controllersPackage,
                                String responseType)

This method provides the Command definition to be able to generate new Controllers on current project.

Parameters:

all -

entity -

responseType -

package -

pathPrefix -

getAllControllerForOperationCommandValues

public List<String> getAllControllerForOperationCommandValues(org.springframework.roo.shell.ShellContext context)

getAllServiceForOperationCommandValues

public List<String> getAllServiceForOperationCommandValues(org.springframework.roo.shell.ShellContext context)

getAllOperationsForOperationCommandValues

public List<String> getAllOperationsForOperationCommandValues(org.springframework.roo.shell.ShellContext context)

isAllParameterOperationVisible

public boolean isAllParameterOperationVisible(org.springframework.roo.shell.ShellContext context)

isOperationParameterOperationVisible

public boolean isOperationParameterOperationVisible(org.springframework.roo.shell.ShellContext context)

isServiceParameterOperationVisible

public boolean isServiceParameterOperationVisible(org.springframework.roo.shell.ShellContext context)

isPublishOperationsAvailable

public boolean isPublishOperationsAvailable()

This indicator checks if is possible to publish own operations in controllers. If a valid project has been generated and Spring MVC has been installed, this command will be available.

Returns:

getControllerOperations

public ControllerOperations getControllerOperations()

This method provides the Command definition to be able to publish service operations in controllers.

Parameters:

controller -

service -

operation -

all -

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()

getTypeLocationService

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

getClasspathOperations

public org.springframework.roo.classpath.operations.ClasspathOperations getClasspathOperations()

getMemberDetailsScanner

public org.springframework.roo.classpath.scanner.MemberDetailsScanner getMemberDetailsScanner()