com.communote.server.web.api.service

Class ApiResultApiController

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.support.WebContentGenerator

org.springframework.web.servlet.mvc.AbstractController

org.springframework.web.servlet.mvc.BaseCommandController

com.communote.server.web.api.service.BaseApiController

com.communote.server.web.api.service.ApiResultApiController

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.mvc.Controller

Direct Known Subclasses:

BaseFilterApiController, BaseRestApiController, LoginApiController

Deprecated.

Use new generated REST-API instead.

@Deprecated
public abstract class ApiResultApiController
extends BaseApiController

ApiResultApiController is the base class for all API calls returning a ApiResult

Author:

Communote GmbH - http://www.communote.com/

Field Summary

Fields inherited from class org.springframework.web.servlet.mvc.BaseCommandController

DEFAULT_COMMAND_NAME

Fields inherited from class org.springframework.web.servlet.support.WebContentGenerator

METHOD_GET, METHOD_HEAD, METHOD_POST

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Constructor Summary

Constructors

Constructor and Description
ApiResultApiController() Deprecated.

Method Summary

Modifier and Type	Method and Description
protected void	convert(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, ApiResult result) Deprecated. Convert the result into the request format, e.g.
protected abstract Object	execute(ApiResult apiResult, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deprecated. This methods executes the main API action and returns the object to be sent back.
protected String	getRequestUriName(javax.servlet.http.HttpServletRequest request) Deprecated.
protected org.springframework.web.servlet.ModelAndView	handleRequestInternal(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deprecated.

Methods inherited from class com.communote.server.web.api.service.BaseApiController

compareVersions, getBooleanParameter, getIntegerParameter, getLongParameter, getNonEmptyParameter, getResourceId, getResourceType

Methods inherited from class org.springframework.web.servlet.mvc.BaseCommandController

bindAndValidate, checkCommand, createBinder, createCommand, getBindingErrorProcessor, getCommand, getCommandClass, getCommandName, getMessageCodesResolver, getPropertyEditorRegistrars, getValidator, getValidators, getWebBindingInitializer, initApplicationContext, initBinder, isValidateOnBinding, onBind, onBind, onBindAndValidate, prepareBinder, setBindingErrorProcessor, setCommandClass, setCommandName, setMessageCodesResolver, setPropertyEditorRegistrar, setPropertyEditorRegistrars, setValidateOnBinding, setValidator, setValidators, setWebBindingInitializer, suppressBinding, suppressValidation, suppressValidation, suppressValidation, useDirectFieldAccess

Methods inherited from class org.springframework.web.servlet.mvc.AbstractController

handleRequest, isSynchronizeOnSession, setSynchronizeOnSession

Methods inherited from class org.springframework.web.servlet.support.WebContentGenerator

applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, getCacheSeconds, getSupportedMethods, isAlwaysMustRevalidate, isRequireSession, isUseCacheControlHeader, isUseCacheControlNoStore, isUseExpiresHeader, preventCaching, setAlwaysMustRevalidate, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseCacheControlNoStore, setUseExpiresHeader

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiResultApiController

public ApiResultApiController()

Deprecated.

Method Detail

convert

protected void convert(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response,
                       ApiResult result)
                throws Exception

Deprecated.

Convert the result into the request format, e.g. json

Parameters:

request - the http request

response - the http response

result - the result object to be returned to the response

Throws:

Exception - in case of an error

execute

protected abstract Object execute(ApiResult apiResult,
                                  javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)
                           throws javax.servlet.ServletException,
                                  ApiException

Deprecated.

This methods executes the main API action and returns the object to be sent back.

Parameters:

apiResult - the apiResult

request - the http request

response - the http resptonse

Returns:

the result object

Throws:

ApiException - in case of an illegal use of the api (wrong parameters, invalid resources)

javax.servlet.ServletException - in case of an request error

getRequestUriName

protected String getRequestUriName(javax.servlet.http.HttpServletRequest request)

Deprecated.

Parameters:

request - the http request

Returns:

the request uri without '.json'

handleRequestInternal

protected org.springframework.web.servlet.ModelAndView handleRequestInternal(javax.servlet.http.HttpServletRequest request,
                                                                             javax.servlet.http.HttpServletResponse response)
                                                                      throws Exception

Deprecated.

Specified by:

handleRequestInternal in class org.springframework.web.servlet.mvc.AbstractController

Throws:

Exception