windntrees

Class BasicController

java.lang.Object

windntrees.BasicController

Direct Known Subclasses:

ContentController

@Controller
public class BasicController
extends Object

WindnTrees basic controller that adds standard locale messages with locale messages resolution mechanism required by subsequent controllers.

Author:

shams

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.core.env.Environment	env Environment variable reference to obtain environment specific attributes and configurational information.
protected static org.slf4j.Logger	logger Messages and exception logging class instance.
protected org.springframework.context.support.ReloadableResourceBundleMessageSource	messageSource Locale messages resolver based on shared locale resource.
protected javax.servlet.http.HttpServletRequest	request
protected javax.servlet.http.HttpSession	session HttpSession reference object scoped for a user session.

Constructor Summary

Constructors

Constructor and Description
BasicController()

Method Summary

Modifier and Type	Method and Description
protected String	getFolderPath() Gets standard files upload path based on 'uploadType' request parameter that may be overridden as per requirements.
protected org.springframework.http.HttpHeaders	getHtmlResponseHeaders() Gets HTTP response headers with defined TEXT_HTML configuration.
protected Locale	getLocale() Gets locale reference instance.
protected org.springframework.http.HttpHeaders	getResponseHeaders() Gets HTTP response headers with defined APPLICATION_JSON_UTF8 configuration.
protected String	getStandardErrMessage() Gets 'Err' locale message defined in a shared locale resource file based on 'standard.err.text' key value.
protected String	getStandardExceptionMessage() Gets 'Exception' locale message defined in a shared locale resource file based on 'standard.exception.text' key value.
protected String	getStandardOkMessage() Gets 'Ok' locale message defined in a shared locale resource file based on 'standard.ok.text' key value.
protected String	getValidationLocaleMessage(String code) Gets 'Validation' locale message defined in a shared locale resource file based on locale codes ('Size', 'Min', 'Max', 'NotNull') and key values ('validate.size.text', 'validate.min.text', 'validate.max.text', 'validate.required.text').
protected WebAppProperties	getWebAppProperties() Gets application specific properties that can be extended or customized as per requirements.
protected String	getWelcomeMessage() Gets 'Welcome' locale message defined in a shared locale resource file based on 'pages.all.welcome' key value.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

Messages and exception logging class instance.

env

@Autowired
protected org.springframework.core.env.Environment env

Environment variable reference to obtain environment specific attributes and configurational information.

messageSource

@Autowired
protected org.springframework.context.support.ReloadableResourceBundleMessageSource messageSource

Locale messages resolver based on shared locale resource.

request

@Autowired
protected javax.servlet.http.HttpServletRequest request

session

@Autowired
protected javax.servlet.http.HttpSession session

HttpSession reference object scoped for a user session.

Constructor Detail

BasicController

public BasicController()

Method Detail

getLocale

protected Locale getLocale()

Gets locale reference instance.

Returns:

getResponseHeaders

protected org.springframework.http.HttpHeaders getResponseHeaders()

Gets HTTP response headers with defined APPLICATION_JSON_UTF8 configuration.

Returns:

getHtmlResponseHeaders

protected org.springframework.http.HttpHeaders getHtmlResponseHeaders()

Gets HTTP response headers with defined TEXT_HTML configuration.

Returns:

getWelcomeMessage

protected String getWelcomeMessage()

Gets 'Welcome' locale message defined in a shared locale resource file based on 'pages.all.welcome' key value. Note: User must provide or configure locale messages resources.

Returns:

getStandardOkMessage

protected String getStandardOkMessage()

Gets 'Ok' locale message defined in a shared locale resource file based on 'standard.ok.text' key value. Note: User must provide or configure locale messages resources.

Returns:

getStandardErrMessage

protected String getStandardErrMessage()

Gets 'Err' locale message defined in a shared locale resource file based on 'standard.err.text' key value. Note: User must provide or configure locale messages resources.

Returns:

getStandardExceptionMessage

protected String getStandardExceptionMessage()

Gets 'Exception' locale message defined in a shared locale resource file based on 'standard.exception.text' key value. Note: User must provide or configure locale messages resources.

Returns:

getValidationLocaleMessage

protected String getValidationLocaleMessage(String code)

Gets 'Validation' locale message defined in a shared locale resource file based on locale codes ('Size', 'Min', 'Max', 'NotNull') and key values ('validate.size.text', 'validate.min.text', 'validate.max.text', 'validate.required.text'). Note: User must provide or configure locale messages resources.

Parameters:

code -

Returns:

getFolderPath

protected String getFolderPath()

Gets standard files upload path based on 'uploadType' request parameter that may be overridden as per requirements.

Returns:

getWebAppProperties

protected WebAppProperties getWebAppProperties()

Gets application specific properties that can be extended or customized as per requirements.

Returns: