com.communote.server.web.api.service

Class BaseApiController

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

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:

ApiResultApiController, AttachmentDownloadApiController, BinaryApiController

Deprecated.

Use new generated REST-API instead

@Deprecated
public abstract class BaseApiController
extends org.springframework.web.servlet.mvc.BaseCommandController

BaseApiController is the base class for all API calls. It does the error handling and conversion to json or other formats. If inheriting from this controller overwrite #execute(HttpServletRequest, HttpServletResponse)

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
BaseApiController() Deprecated.

Method Summary

Modifier and Type	Method and Description
protected int	compareVersions(javax.servlet.http.HttpServletRequest request, String version) Deprecated. Compares the version.
protected Boolean	getBooleanParameter(javax.servlet.http.HttpServletRequest request, String parameter) Deprecated.
protected Integer	getIntegerParameter(javax.servlet.http.HttpServletRequest request, String parameter) Deprecated.
protected Long	getLongParameter(javax.servlet.http.HttpServletRequest request, String parameter) Deprecated.
protected String	getNonEmptyParameter(javax.servlet.http.HttpServletRequest request, String parameter) Deprecated.
protected Long	getResourceId(javax.servlet.http.HttpServletRequest request, boolean throwOnError) Deprecated. Get the resource id out of the request uri.
protected String	getResourceType() Deprecated.

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, handleRequestInternal, 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

BaseApiController

public BaseApiController()

Deprecated.

Method Detail

compareVersions

protected int compareVersions(javax.servlet.http.HttpServletRequest request,
                              String version)

Deprecated.

Compares the version. If compareVersion(request, 1.0.1) returns a value >=0 than the request supports this version.

Parameters:

request - the request to get the requested version from

version - the version to compare (e.g. 1.0.1)

Returns:

a value greater 0 if the given version is lower than the one out of the request
0 if the given version is equal to the one out of the request
a value less 0 if the given version is greater than the one out of the request

getBooleanParameter

protected Boolean getBooleanParameter(javax.servlet.http.HttpServletRequest request,
                                      String parameter)
                               throws IllegalRequestParameterException

Deprecated.

Parameters:

request - the http request

parameter - the parameter to get

Returns:

the boolean

Throws:

IllegalRequestParameterException - in case a request parameter has an illegal value

getIntegerParameter

protected Integer getIntegerParameter(javax.servlet.http.HttpServletRequest request,
                                      String parameter)
                               throws IllegalRequestParameterException

Deprecated.

Parameters:

request - the http request

parameter - the parameter to get

Returns:

the integer

Throws:

IllegalRequestParameterException - in case a request parameter has an illegal value

getLongParameter

protected Long getLongParameter(javax.servlet.http.HttpServletRequest request,
                                String parameter)
                         throws IllegalRequestParameterException

Deprecated.

Parameters:

request - the http request

parameter - the parameter to get

Returns:

the long

Throws:

IllegalRequestParameterException - in case a request parameter has an illegal value

getNonEmptyParameter

protected String getNonEmptyParameter(javax.servlet.http.HttpServletRequest request,
                                      String parameter)
                               throws IllegalRequestParameterException

Deprecated.

Parameters:

request - the http request

parameter - the parameter to get

Returns:

the parameter value

Throws:

IllegalRequestParameterException - in case a request parameter has an illegal value

getResourceId

protected Long getResourceId(javax.servlet.http.HttpServletRequest request,
                             boolean throwOnError)
                      throws RequestedResourceNotFoundException

Deprecated.

Get the resource id out of the request uri. E.g. if the uri is /api/v1.0/posts/12.json?filterHtml=true the method will return 12

Parameters:

request - the request

throwOnError - if true a RequestedResourceNotFoundException will be thrown if the id is not parseable

Returns:

the id of the requested resource

Throws:

RequestedResourceNotFoundException - in case the uri is not parseable to a resource id

getResourceType

protected String getResourceType()

Deprecated.

Returns:

the resource type, use for getResourceId(HttpServletRequest, boolean) exceptions