org.n52.web.ctrl

Class BaseController

java.lang.Object

org.n52.web.ctrl.BaseController

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.web.context.ServletConfigAware

Direct Known Subclasses:

DataController, ParameterController, SearchController, StationsParameterController, TimeseriesDataController

@RestController
public abstract class BaseController
extends Object
implements org.springframework.web.context.ServletConfigAware

Serves as central ExceptionHandler for all Web bindings inheriting from this class. WebExceptions indicate an expected workflows while unexpected exceptions are automatically wrapped to InternalServerExceptions as fallback.

Developers should consider to add hints via WebException.addHint(String) so that as much information is communicated to the caller as possible.

Constructor Summary

Constructors

Constructor and Description
BaseController()

Method Summary

Modifier and Type	Method and Description
protected com.fasterxml.jackson.databind.ObjectMapper	createObjectMapper()
protected IoParameters	createParameters(Map<String,String> query, String locale)
protected IoParameters	createParameters(org.springframework.util.MultiValueMap<String,String> query, String locale)
protected IoParameters	createParameters(RequestSimpleParameterSet query, String locale)
protected IoParameters	createParameters(RequestStyledParameterSet query, String locale)
protected IoParameters	createParameters(String datasetId, Map<String,String> query, String locale)
protected IoParameters	createParameters(String datasetId, org.springframework.util.MultiValueMap<String,String> query, String locale)
protected BiConsumer<String,IoParseException>	getExceptionHandle()
javax.servlet.ServletConfig	getServletConfig()
void	handle400(Exception e, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	handle404(Exception e, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	handle500(Exception e, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	handleException(Exception e, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected boolean	isRequestingJsonData(javax.servlet.http.HttpServletRequest request)
protected boolean	isRequestingPdfData(javax.servlet.http.HttpServletRequest request)
protected boolean	isRequestingPngData(javax.servlet.http.HttpServletRequest request)
void	setServletConfig(javax.servlet.ServletConfig servletConfig)

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseController

public BaseController()

Method Detail

getExceptionHandle

protected BiConsumer<String,IoParseException> getExceptionHandle()

createParameters

protected IoParameters createParameters(RequestSimpleParameterSet query,
                                        String locale)

createParameters

protected IoParameters createParameters(RequestStyledParameterSet query,
                                        String locale)

createParameters

protected IoParameters createParameters(org.springframework.util.MultiValueMap<String,String> query,
                                        String locale)

createParameters

protected IoParameters createParameters(String datasetId,
                                        org.springframework.util.MultiValueMap<String,String> query,
                                        String locale)

createParameters

protected IoParameters createParameters(Map<String,String> query,
                                        String locale)

createParameters

protected IoParameters createParameters(String datasetId,
                                        Map<String,String> query,
                                        String locale)

setServletConfig

public void setServletConfig(javax.servlet.ServletConfig servletConfig)

Specified by:

setServletConfig in interface org.springframework.web.context.ServletConfigAware

getServletConfig

public javax.servlet.ServletConfig getServletConfig()

isRequestingJsonData

protected boolean isRequestingJsonData(javax.servlet.http.HttpServletRequest request)

isRequestingPdfData

protected boolean isRequestingPdfData(javax.servlet.http.HttpServletRequest request)

isRequestingPngData

protected boolean isRequestingPngData(javax.servlet.http.HttpServletRequest request)

handle400

@ExceptionHandler(value={BadRequestException.class,BadQueryParameterException.class})
public void handle400(Exception e,
                                                                                                             javax.servlet.http.HttpServletRequest request,
                                                                                                             javax.servlet.http.HttpServletResponse response)

handle404

@ExceptionHandler(value=ResourceNotFoundException.class)
public void handle404(Exception e,
                                                                                javax.servlet.http.HttpServletRequest request,
                                                                                javax.servlet.http.HttpServletResponse response)

handle500

@ExceptionHandler(value=InternalServerException.class)
public void handle500(Exception e,
                                                                              javax.servlet.http.HttpServletRequest request,
                                                                              javax.servlet.http.HttpServletResponse response)

handleException

@ExceptionHandler(value={java.lang.RuntimeException.class,java.lang.Exception.class,java.lang.Throwable.class})
public void handleException(Exception e,
                                                                                                                                             javax.servlet.http.HttpServletRequest request,
                                                                                                                                             javax.servlet.http.HttpServletResponse response)

createObjectMapper

protected com.fasterxml.jackson.databind.ObjectMapper createObjectMapper()