com.communote.server.web.api.service

Class BaseRestApiController<GET,POST>

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

com.communote.server.web.api.service.BaseRestApiController<GET,POST>

Type Parameters:

GET - Return type of doGet

POST - Return type of doPost

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:

BlogApiController, BlogPublicAccessApiController, BlogRightApiController, BlogUserRoleApiController, ConfluenceExternalObjectsApiController, DeleteBlogApiController, DeleteExternalObjectsApiController, DeletePostApiController, FavoriteApiController, FollowApiController, InviteUserToBlogApiController, PostApiController, PostCounterApiController, UserApiController

Deprecated.

Use new generated REST-API instead

@Deprecated
public class BaseRestApiController<GET,POST>
extends ApiResultApiController

Base controller for api rest calls

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

Method Summary

Modifier and Type	Method and Description
protected GET	doGet(ApiResult apiResult, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deprecated. Do the get on a resource
protected POST	doPost(ApiResult apiResult, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deprecated. Do a a post resource
protected 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.

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

convert, getRequestUriName, handleRequestInternal

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

BaseRestApiController

public BaseRestApiController()

Deprecated.

Method Detail

doGet

protected GET doGet(ApiResult apiResult,
                    javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
             throws ApiException

Deprecated.

Do the get on a resource

Parameters:

apiResult - the apiResult

request - the request

response - the response

Returns:

the post resource

Throws:

ApiException - an error occured

doPost

protected POST doPost(ApiResult apiResult,
                      javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws org.springframework.web.HttpRequestMethodNotSupportedException,
                      ApiException

Deprecated.

Do a a post resource

Parameters:

apiResult - the apiResult

request - the request

response - the response

Returns:

null

Throws:

org.springframework.web.HttpRequestMethodNotSupportedException - if method not implemented

ApiException - in case of an error

Exception

execute

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

Deprecated.

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

Specified by:

execute in class ApiResultApiController

Parameters:

apiResult - the apiResult

request - the http request

response - the http resptonse

Returns:

the result object

Throws:

RequestedResourceNotFoundException

org.springframework.web.HttpRequestMethodNotSupportedException

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

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