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

Class JSONMVCResponseService

java.lang.Object

org.springframework.roo.addon.web.mvc.controller.addon.responses.json.JSONMVCResponseService

All Implemented Interfaces:

ControllerMVCResponseService, org.springframework.roo.project.Feature

@Service
public class JSONMVCResponseService
extends Object
implements ControllerMVCResponseService

Implementation of ControllerMVCResponseService that provides JSON Response types. With this implementation, Spring Roo will be able to provide JSON response types during controller generations.

Since:

2.0

Author:

Juan Carlos García, Paula Navarro

Constructor Summary

Constructors

Constructor and Description
JSONMVCResponseService()

Method Summary

Modifier and Type	Method and Description
protected void	activate(org.osgi.service.component.ComponentContext context)
void	annotate(org.springframework.roo.model.JavaType controller) This operation annotates a controller with the JSON annotation
org.springframework.roo.model.JavaType	getAnnotation() This operation returns the annotation type @RooJSON
String	getControllerNameModifier() Return a string which should be added to controller name to identify this kind of Response.
org.springframework.roo.model.JavaType	getMainController() This operation returns the main controller generated by implementation.
org.springframework.roo.model.JavaType	getMainControllerAnnotation() This operation returns the annotation type that identifies the main controller generated by implementation
String	getName() This operation returns the Feature name.
String	getResponseType() This operation returns the JSON response type.
boolean	hasResponseType(org.springframework.roo.model.JavaType controller) This operation will check if some controller has the @RooJSON annotation
void	install(org.springframework.roo.project.maven.Pom module) This operation will install all the necessary items to be able to use JSON response type.
boolean	isInstalledInModule(String moduleName) This operation checks if this feature is installed in module.
boolean	providesViews() Informs if this response type will provide views
boolean	requiresJsonDeserializer() Informs if response type requires Json Deserializer classes
boolean	requiresJsonMixin() Informs if response type requires Json Mixin classes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JSONMVCResponseService

public JSONMVCResponseService()

Method Detail

activate

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

getName

public String getName()

This operation returns the Feature name. In this case, the Feature name is the same as the response type.

Specified by:

getName in interface org.springframework.roo.project.Feature

Returns:

String with JSON as Feature name

isInstalledInModule

public boolean isInstalledInModule(String moduleName)

This operation checks if this feature is installed in module. JSON is installed in module if Spring MVC has been installed before.

Specified by:

isInstalledInModule in interface org.springframework.roo.project.Feature

Returns:

true if Spring MVC has been installed, if not return false.

getResponseType

public String getResponseType()

This operation returns the JSON response type.

Specified by:

getResponseType in interface ControllerMVCResponseService

Returns:

String with JSON as response type

getAnnotation

public org.springframework.roo.model.JavaType getAnnotation()

This operation returns the annotation type @RooJSON

Specified by:

getAnnotation in interface ControllerMVCResponseService

Returns:

JavaType with the JSON annotation type

annotate

public void annotate(org.springframework.roo.model.JavaType controller)

This operation annotates a controller with the JSON annotation

Specified by:

annotate in interface ControllerMVCResponseService

Parameters:

controller - JavaType with the controller to be annotated.

hasResponseType

public boolean hasResponseType(org.springframework.roo.model.JavaType controller)

This operation will check if some controller has the @RooJSON annotation

Specified by:

hasResponseType in interface ControllerMVCResponseService

Parameters:

controller - JavaType with controller to check

Returns:

true if provided controller has the JSON responseType. If not, return false.

install

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

This operation will install all the necessary items to be able to use JSON response type.

Specified by:

install in interface ControllerMVCResponseService

Parameters:

module - Pom with the module where this response type should be installed.

getMainControllerAnnotation

public org.springframework.roo.model.JavaType getMainControllerAnnotation()

Description copied from interface: ControllerMVCResponseService

This operation returns the annotation type that identifies the main controller generated by implementation

Specified by:

getMainControllerAnnotation in interface ControllerMVCResponseService

Returns:

JavaType with the annotation managed by the implementation. Maybe, this operation will return null if the implementation doesn't provide any main controller.

getMainController

public org.springframework.roo.model.JavaType getMainController()

Description copied from interface: ControllerMVCResponseService

This operation returns the main controller generated by implementation.

Specified by:

getMainController in interface ControllerMVCResponseService

Returns:

JavaType with the main controller generated by the implementation. Maybe, this operation will return null if the implementation doesn't provide any main controller.

getControllerNameModifier

public String getControllerNameModifier()

Description copied from interface: ControllerMVCResponseService

Return a string which should be added to controller name to identify this kind of Response. (By example 'Json', 'Jsp', etc)

Specified by:

getControllerNameModifier in interface ControllerMVCResponseService

Returns:

requiresJsonDeserializer

public boolean requiresJsonDeserializer()

Description copied from interface: ControllerMVCResponseService

Informs if response type requires Json Deserializer classes

Specified by:

requiresJsonDeserializer in interface ControllerMVCResponseService

Returns:

true if requires class

See Also:

RooDeserializer

requiresJsonMixin

public boolean requiresJsonMixin()

Description copied from interface: ControllerMVCResponseService

Informs if response type requires Json Mixin classes

Specified by:

requiresJsonMixin in interface ControllerMVCResponseService

Returns:

true if requires class

See Also:

RooJsonMixin

providesViews

public boolean providesViews()

Description copied from interface: ControllerMVCResponseService

Informs if this response type will provide views

Specified by:

providesViews in interface ControllerMVCResponseService

Returns:

true if provides views