org.springframework.roo.addon.web.mvc.thymeleaf.addon

Class ThymeleafMVCViewResponseService

java.lang.Object

org.springframework.roo.classpath.operations.AbstractOperations

org.springframework.roo.addon.web.mvc.thymeleaf.addon.ThymeleafMVCViewResponseService

All Implemented Interfaces:

org.springframework.roo.addon.web.mvc.controller.addon.responses.ControllerMVCResponseService, org.springframework.roo.project.Feature

@Service
public class ThymeleafMVCViewResponseService
extends org.springframework.roo.classpath.operations.AbstractOperations
implements org.springframework.roo.addon.web.mvc.controller.addon.responses.ControllerMVCResponseService

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

Since:

2.0

Author:

Juan Carlos García

Field Summary

Fields inherited from class org.springframework.roo.classpath.operations.AbstractOperations

context, fileManager, LOGGER

Constructor Summary

Constructors

Constructor and Description
ThymeleafMVCViewResponseService()

Method Summary

Modifier and Type	Method and Description
protected void	activate(org.osgi.service.component.ComponentContext cContext)
void	annotate(org.springframework.roo.model.JavaType controller) This operation annotates a controller with the THYMELEAF annotation
void	completeCollectionController(org.springframework.roo.model.JavaType collectionController, org.springframework.roo.addon.jpa.addon.entity.JpaEntityMetadata entityMetadata, org.springframework.roo.classpath.details.ClassOrInterfaceTypeDetails serviceDetails, org.springframework.roo.classpath.details.ClassOrInterfaceTypeDetailsBuilder cidBuilder)
void	completeItemController(org.springframework.roo.model.JavaType itemController, org.springframework.roo.addon.jpa.addon.entity.JpaEntityMetadata entityMetadata, org.springframework.roo.classpath.details.ClassOrInterfaceTypeDetails serviceDetails, org.springframework.roo.classpath.details.ClassOrInterfaceTypeDetailsBuilder cidBuilder)
void	createJasperReportsClassFromTemplate(org.springframework.roo.project.maven.Pom module, String templateName, String className) Creates a class from a template, replacing its package.
boolean	generateLinkFactory()
org.springframework.roo.model.JavaType	getAnnotation() This operation returns the annotation type @RooThymeleaf
String	getControllerNameModifier()
org.springframework.roo.addon.web.mvc.i18n.I18nOperations	getI18nOperations()
org.springframework.roo.model.JavaType	getMainController() This operation returns the main controller generated by THYMELEAF response type.
org.springframework.roo.model.JavaType	getMainControllerAnnotation() This operation returns the annotation type that identifies the main controller generated by THYMELEAF response type.
String	getName() This operation returns the Feature name.
String	getResponseType() This operation returns the THYMELEAF response type.
boolean	hasResponseType(org.springframework.roo.model.JavaType controller) This operation will check if some controller has the @RooThymeleaf annotation
void	install(org.springframework.roo.project.maven.Pom module)
boolean	isInstalledInModule(String moduleName) This operation checks if this feature is installed in module.
boolean	providesViews()
boolean	requiresJsonDeserializer()
boolean	requiresJsonMixin()

Methods inherited from class org.springframework.roo.classpath.operations.AbstractOperations

bindFileManager, copyDirectoryContents, getDocumentTemplate, unbindFileManager

Methods inherited from class java.lang.Object

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

Constructor Detail

ThymeleafMVCViewResponseService

public ThymeleafMVCViewResponseService()

Method Detail

activate

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

Overrides:

activate in class org.springframework.roo.classpath.operations.AbstractOperations

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 TYHMELEAF as Feature name

isInstalledInModule

public boolean isInstalledInModule(String moduleName)

This operation checks if this feature is installed in module. THYMELEAF is installed in module if thymeleaf dependencies has been installed before.

Specified by:

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

Returns:

true if thymeleaf dependencies has been installed, if not return false.

getResponseType

public String getResponseType()

This operation returns the THYMELEAF response type.

Specified by:

getResponseType in interface org.springframework.roo.addon.web.mvc.controller.addon.responses.ControllerMVCResponseService

Returns:

String with THYMELEAF as response type

getAnnotation

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

This operation returns the annotation type @RooThymeleaf

Specified by:

getAnnotation in interface org.springframework.roo.addon.web.mvc.controller.addon.responses.ControllerMVCResponseService

Returns:

JavaType with the THYMELEAF annotation type

annotate

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

This operation annotates a controller with the THYMELEAF annotation

Specified by:

annotate in interface org.springframework.roo.addon.web.mvc.controller.addon.responses.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 @RooThymeleaf annotation

Specified by:

hasResponseType in interface org.springframework.roo.addon.web.mvc.controller.addon.responses.ControllerMVCResponseService

Parameters:

controller - JavaType with controller to check

Returns:

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

install

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

Specified by:

install in interface org.springframework.roo.addon.web.mvc.controller.addon.responses.ControllerMVCResponseService

getMainControllerAnnotation

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

This operation returns the annotation type that identifies the main controller generated by THYMELEAF response type.

Specified by:

getMainControllerAnnotation in interface org.springframework.roo.addon.web.mvc.controller.addon.responses.ControllerMVCResponseService

Returns:

JavaType with the annotation managed by the implementation. This method never returns null.

getMainController

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

This operation returns the main controller generated by THYMELEAF response type.

Specified by:

getMainController in interface org.springframework.roo.addon.web.mvc.controller.addon.responses.ControllerMVCResponseService

Returns:

JavaType with the main controller generated by the implementation. Maybe returns null if main controller has not been generated yet.

createJasperReportsClassFromTemplate

public void createJasperReportsClassFromTemplate(org.springframework.roo.project.maven.Pom module,
                                                 String templateName,
                                                 String className)

Creates a class from a template, replacing its package.

Parameters:

module - the Pom related to module where the class should be created

templateName - the String with the template name

className - the String with the class name to create

getI18nOperations

public org.springframework.roo.addon.web.mvc.i18n.I18nOperations getI18nOperations()

getControllerNameModifier

public String getControllerNameModifier()

Specified by:

getControllerNameModifier in interface org.springframework.roo.addon.web.mvc.controller.addon.responses.ControllerMVCResponseService

requiresJsonDeserializer

public boolean requiresJsonDeserializer()

Specified by:

requiresJsonDeserializer in interface org.springframework.roo.addon.web.mvc.controller.addon.responses.ControllerMVCResponseService

requiresJsonMixin

public boolean requiresJsonMixin()

Specified by:

requiresJsonMixin in interface org.springframework.roo.addon.web.mvc.controller.addon.responses.ControllerMVCResponseService

providesViews

public boolean providesViews()

Specified by:

providesViews in interface org.springframework.roo.addon.web.mvc.controller.addon.responses.ControllerMVCResponseService

generateLinkFactory

public boolean generateLinkFactory()

Specified by:

generateLinkFactory in interface org.springframework.roo.addon.web.mvc.controller.addon.responses.ControllerMVCResponseService

completeCollectionController

public void completeCollectionController(org.springframework.roo.model.JavaType collectionController,
                                         org.springframework.roo.addon.jpa.addon.entity.JpaEntityMetadata entityMetadata,
                                         org.springframework.roo.classpath.details.ClassOrInterfaceTypeDetails serviceDetails,
                                         org.springframework.roo.classpath.details.ClassOrInterfaceTypeDetailsBuilder cidBuilder)

Specified by:

completeCollectionController in interface org.springframework.roo.addon.web.mvc.controller.addon.responses.ControllerMVCResponseService

completeItemController

public void completeItemController(org.springframework.roo.model.JavaType itemController,
                                   org.springframework.roo.addon.jpa.addon.entity.JpaEntityMetadata entityMetadata,
                                   org.springframework.roo.classpath.details.ClassOrInterfaceTypeDetails serviceDetails,
                                   org.springframework.roo.classpath.details.ClassOrInterfaceTypeDetailsBuilder cidBuilder)

Specified by:

completeItemController in interface org.springframework.roo.addon.web.mvc.controller.addon.responses.ControllerMVCResponseService