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

Methods

Modifier and Type	Method and Description
protected void	activate(org.osgi.service.component.ComponentContext context)
void	addController(boolean all, org.springframework.roo.model.JavaPackage controllersPackage, org.springframework.roo.model.JavaType controller, org.springframework.roo.model.JavaType entity, org.springframework.roo.model.JavaType service, String path, String responseType, org.springframework.roo.model.JavaPackage formattersPackage) This method provides the Command definition to be able to generate new Controllers on current project.
List<String>	getAllAppServers(org.springframework.roo.shell.ShellContext context) This indicator returns the servers where the application can be deployed
List<String>	getAllResponseTypeValues(org.springframework.roo.shell.ShellContext context) This indicator returns all possible values for --responseType parameter.
ControllerOperations	getControllerOperations()
Map<String,ControllerMVCResponseService>	getInstalledControllerMVCResponseTypes() This method gets all implementations of ControllerMVCResponseService interface to be able to locate all installed ControllerMVCResponseService
org.springframework.roo.shell.Converter<org.springframework.roo.model.JavaType>	getJavaTypeConverter() This method obtains JavaType converter to be able to obtain JavaType from strings
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	isAllParameterVisible(org.springframework.roo.shell.ShellContext context) This indicator says if --all parameter should be visible or not If --controller parameter has been specified, --all parameter will not be visible to prevent conflicts.
boolean	isClassParameterVisible(org.springframework.roo.shell.ShellContext context) This indicator says if --controller parameter should be visible or not If --all parameter has been specified, --controller parameter will not be visible to prevent conflicts.
boolean	isEntityParameterMandatory(org.springframework.roo.shell.ShellContext context) This indicator says if --entity parameter should be mandatory or not If --controller parameter has not been specified, --entity parameter will be optional If --controller parameter has been specified with an existing controller, --entity parameter will be optional If --controller parameter has been specified with new controller to be generated, --entity parameter will be mandatory
boolean	isEntityParameterVisible(org.springframework.roo.shell.ShellContext context) This indicator says if --entity parameter should be visible or not If --controller parameter has not been specified, --entity parameter will not be visible If --controller parameter has been specified with an existing controller, --entity parameter will not be visible If --controller parameter has been specified with new controller to be generated, --entity parameter will be visible
boolean	isFormattersPackageParameterVisible(org.springframework.roo.shell.ShellContext context) This indicator says if --formattersPackage parameter should be visible or not If --controller parameter or --all parameter has been specified, --formattersPackage parameter will be visible to preserve order.
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	isPackageParameterMandatory(org.springframework.roo.shell.ShellContext context) This indicator says if --package parameter should be mandatory or not If --all parameter has been specified, --package parameter will be mandatory.
boolean	isPackageParameterVisible(org.springframework.roo.shell.ShellContext context) This indicator says if --package parameter should be visible or not If --all parameter has not been specified, --package parameter will not be visible to prevent conflicts.
boolean	isPathParameterMandatory(org.springframework.roo.shell.ShellContext context) This indicator says if --path parameter should be mandatory or not If --entity parameter has not been specified, --path parameter will be optional If --entity parameter has specified and exists yet some controller that manages that entity, --path parameter will be mandatory If --entity parameter has specified and doesn't exist other controller that manages that entity, --path parameter will be optional.
boolean	isPathParameterVisible(org.springframework.roo.shell.ShellContext context) This indicator says if --path parameter should be visible or not If --entity parameter has not been specified, --path parameter will not be visible to preserve order.
boolean	isResponseTypeParameterVisible(org.springframework.roo.shell.ShellContext context) This indicator says if --responseType parameter should be visible or not If --controller parameter has not been specified, --responseType parameter will not be visible to preserve order.
boolean	isServiceParameterMandatory(org.springframework.roo.shell.ShellContext context) This indicator says if --service parameter should be mandatory or not If --entity parameter has been specified, --service parameter will be mandatory
boolean	isServiceParameterVisible(org.springframework.roo.shell.ShellContext context) This indicator says if --service parameter should be visible or not If --entity parameter has not been specified, --service parameter will not be visible to preserve order.
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.
List<String>	returnControllerValues(org.springframework.roo.shell.ShellContext shellContext) Find controllers in project and returns a list with their fully qualified names.
List<String>	returnEntityValues(org.springframework.roo.shell.ShellContext shellContext) Find entities in project and returns a list with their fully qualified names.
List<String>	returnServiceValues(org.springframework.roo.shell.ShellContext shellContext) Find entities in project and returns a list with their fully qualified names.
void	setup(org.springframework.roo.project.maven.Pom module, String appServer) 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,
         String appServer)

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 --controller parameter has been specified, --all parameter will not be visible to prevent conflicts.

Returns:

isPackageParameterVisible

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

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

Returns:

isPackageParameterMandatory

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

This indicator says if --package parameter should be mandatory or not If --all parameter has been specified, --package parameter will be mandatory.

Returns:

isClassParameterVisible

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

This indicator says if --controller parameter should be visible or not If --all parameter has been specified, --controller 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 --controller parameter has not been specified, --entity parameter will not be visible If --controller parameter has been specified with an existing controller, --entity parameter will not be visible If --controller parameter has been specified with new controller to be generated, --entity parameter will be visible

Returns:

isEntityParameterMandatory

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

This indicator says if --entity parameter should be mandatory or not If --controller parameter has not been specified, --entity parameter will be optional If --controller parameter has been specified with an existing controller, --entity parameter will be optional If --controller parameter has been specified with new controller to be generated, --entity parameter will be mandatory

Returns:

isServiceParameterVisible

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

This indicator says if --service parameter should be visible or not If --entity parameter has not been specified, --service parameter will not be visible to preserve order.

Returns:

isServiceParameterMandatory

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

This indicator says if --service parameter should be mandatory or not If --entity parameter has been specified, --service parameter will be mandatory

Returns:

isPathParameterVisible

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

This indicator says if --path parameter should be visible or not If --entity parameter has not been specified, --path parameter will not be visible to preserve order.

Returns:

isPathParameterMandatory

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

This indicator says if --path parameter should be mandatory or not If --entity parameter has not been specified, --path parameter will be optional If --entity parameter has specified and exists yet some controller that manages that entity, --path parameter will be mandatory If --entity parameter has specified and doesn't exist other controller that manages that entity, --path parameter will be optional.

Returns:

isResponseTypeParameterVisible

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

This indicator says if --responseType parameter should be visible or not If --controller parameter has not been specified, --responseType parameter will not be visible to preserve order.

Returns:

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:

isFormattersPackageParameterVisible

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

This indicator says if --formattersPackage parameter should be visible or not If --controller parameter or --all parameter has been specified, --formattersPackage parameter will be visible to preserve order.

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:

returnEntityValues

public List<String> returnEntityValues(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.

returnControllerValues

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

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

Parameters:

shellContext -

Returns:

List with available controllers full qualified names.

returnServiceValues

public List<String> returnServiceValues(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.

addController

public void addController(boolean all,
                 org.springframework.roo.model.JavaPackage controllersPackage,
                 org.springframework.roo.model.JavaType controller,
                 org.springframework.roo.model.JavaType entity,
                 org.springframework.roo.model.JavaType service,
                 String path,
                 String responseType,
                 org.springframework.roo.model.JavaPackage formattersPackage)

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

Parameters:

all -

package -

controller -

entity -

service -

path -

responseType -

formattersPackage -

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

getTypeLocationService

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

getProjectOperations

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

getControllerOperations

public ControllerOperations getControllerOperations()

getJavaTypeConverter

public org.springframework.roo.shell.Converter<org.springframework.roo.model.JavaType> getJavaTypeConverter()

This method obtains JavaType converter to be able to obtain JavaType from strings

Returns: