fr.gouv.education.tribu.api.controller

Class AbstractWsController

java.lang.Object

fr.gouv.education.tribu.api.controller.AbstractWsController

Direct Known Subclasses:

DownloadController, SearchController

public abstract class AbstractWsController
extends Object

Generic controller for logging and process json response

Author:

Loïc Billon

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.ApplicationContext	context
protected static String	LOG_SEPARATOR
protected static org.apache.commons.logging.Log	LOGGER
protected static org.apache.commons.logging.Log	STK_LOGGER

Constructor Summary

Constructors

Constructor and Description
AbstractWsController()

Method Summary

Modifier and Type	Method and Description
protected org.springframework.http.ResponseEntity<String>	logAndReturn(AbstractResponse result, String query, String user, Long startTime, ContentErrorCode error, Object... args) Default return method If docs is null, return an empty response
protected org.springframework.http.ResponseEntity<String>	logStackAndReturn(Exception e, String query, String user, Long startTime, ContentErrorCode error, Object... args) Return method with stacktrace

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.apache.commons.logging.Log LOGGER

STK_LOGGER

protected static final org.apache.commons.logging.Log STK_LOGGER

LOG_SEPARATOR

protected static final String LOG_SEPARATOR

See Also:

Constant Field Values

context

@Autowired
protected org.springframework.context.ApplicationContext context

Constructor Detail

AbstractWsController

public AbstractWsController()

Method Detail

logAndReturn

protected org.springframework.http.ResponseEntity<String> logAndReturn(AbstractResponse result,
                                                                       String query,
                                                                       String user,
                                                                       Long startTime,
                                                                       ContentErrorCode error,
                                                                       Object... args)

Default return method If docs is null, return an empty response

Parameters:

contents - some docs

query - method paramaters (for logging)

startTime - start time

error - the error code

args - the error code args

Returns:

json

logStackAndReturn

protected org.springframework.http.ResponseEntity<String> logStackAndReturn(Exception e,
                                                                            String query,
                                                                            String user,
                                                                            Long startTime,
                                                                            ContentErrorCode error,
                                                                            Object... args)

Return method with stacktrace

Parameters:

e - the exception

params - method paramaters (for logging)

startTime - start time

error - the error code

args - the error code args

Returns:

json