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

Interface ControllerMVCResponseService

All Superinterfaces:

org.springframework.roo.project.Feature

All Known Implementing Classes:

JSONMVCResponseService

public interface ControllerMVCResponseService
extends org.springframework.roo.project.Feature

This interface provides some different operations that allow to manage controller response types.

Since:

2.0

Author:

Juan Carlos García

Method Summary

Modifier and Type	Method and Description
void	annotate(org.springframework.roo.model.JavaType controller) This operation annotates a controller with the annotation defined by getAnnotation() operation.
org.springframework.roo.model.JavaType	getAnnotation() This operation returns the annotation type that identifies the implementation response.
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	getResponseType() This operation returns the implementation response type.
boolean	hasResponseType(org.springframework.roo.model.JavaType controller) This operation will check if some controller has the implemented response type.
void	install(org.springframework.roo.project.maven.Pom module) This operation will install all the necessary items to be able to use the implemented responseType.
boolean	requiresJsonDeserializer() Informs if response type requires Json Deserializer classes
boolean	requiresJsonMixin() Informs if response type requires Json Mixin classes

Methods inherited from interface org.springframework.roo.project.Feature

getName, isInstalledInModule

Method Detail

getResponseType

String getResponseType()

This operation returns the implementation response type.

Returns:

String with an unique identifier of response type

getAnnotation

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

This operation returns the annotation type that identifies the implementation response.

Returns:

JavaType with the annotation managed by the implementation

annotate

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

This operation annotates a controller with the annotation defined by getAnnotation() operation.

Parameters:

controller - JavaType with the controller to be annotated.

hasResponseType

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

This operation will check if some controller has the implemented response type.

Parameters:

controller - JavaType with controller to check

Returns:

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

install

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

This operation will install all the necessary items to be able to use the implemented responseType.

Parameters:

module - Pom with the module where this responsetype should be installed.

getMainControllerAnnotation

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

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

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

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

This operation returns the main controller generated by implementation.

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

String getControllerNameModifier()

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

Returns:

requiresJsonDeserializer

boolean requiresJsonDeserializer()

Informs if response type requires Json Deserializer classes

Returns:

true if requires class

See Also:

RooDeserializer

requiresJsonMixin

boolean requiresJsonMixin()

Informs if response type requires Json Mixin classes

Returns:

true if requires class

See Also:

RooJsonMixin