Package org.alfresco.rest.api.search

Class SearchSQLApiWebscript

java.lang.Object

org.springframework.extensions.webscripts.AbstractWebScript

org.alfresco.rest.api.search.SearchSQLApiWebscript

All Implemented Interfaces:

RecognizedParamsExtractor, RequestReader, ResponseWriter, org.springframework.beans.factory.InitializingBean, org.springframework.extensions.webscripts.WebScript

public class SearchSQLApiWebscript
extends org.springframework.extensions.webscripts.AbstractWebScript
implements RecognizedParamsExtractor, RequestReader, ResponseWriter, org.springframework.beans.factory.InitializingBean

Search SQL API end point. An implementation of the {{baseUrl}}/{{networkId}}/public/search/versions/1/sql

Author:

Michael Suzuki

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.extensions.webscripts.AbstractWebScript

org.springframework.extensions.webscripts.AbstractWebScript.ScriptDetails

Field Summary

Fields

Modifier and Type	Field	Description
protected ApiAssistant	assistant
protected ResourceWebScriptHelper	helper

Fields inherited from interface org.alfresco.rest.framework.tools.RecognizedParamsExtractor

KNOWN_PARAMS, PARAM_FILTER_FIELDS, PARAM_FILTER_PROPERTIES, PARAM_INCLUDE, PARAM_INCLUDE_SOURCE_ENTITY, PARAM_ORDERBY, PARAM_PAGING_MAX, PARAM_PAGING_SKIP, PARAM_RELATIONS, PARAM_SELECT, PARAM_WHERE

Fields inherited from interface org.alfresco.rest.framework.tools.ResponseWriter

CACHE_NEVER, DEFAULT_JSON_CONTENT, DEFAULT_SUCCESS, UTF8

Constructor Summary

Constructors

Constructor	Description
SearchSQLApiWebscript()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
SearchParameters	buildSearchParameters(SearchSQLQuery searchQuery)
void	execute(org.springframework.extensions.webscripts.WebScriptRequest webScriptRequest, org.springframework.extensions.webscripts.WebScriptResponse res)
void	setAssistant(ApiAssistant assistant)
void	setHelper(ResourceWebScriptHelper helper)
void	setResultMapper(ResultMapper resultMapper)
void	setSearchMapper(SearchMapper searchMapper)
void	setSearchService(SearchService searchService)
void	setServiceRegistry(ServiceRegistry serviceRegistry)

Methods inherited from class org.springframework.extensions.webscripts.AbstractWebScript

addModuleBundleToCache, checkModuleBundleCache, createArgs, createArgsM, createHeaders, createHeadersM, createScriptParameters, createStatusException, createTemplateParameters, executeScript, getContainer, getDescription, getExecuteScript, getResources, getStatusTemplate, init, renderString, renderString, renderTemplate, sendStatus, setURLModelFactory, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.alfresco.rest.framework.tools.RecognizedParamsExtractor

findPaging, getClause, getFilter, getFilter, getIncludeClause, getPaging, getRecognizedParams, getRelationFilter, getRequestParameters, getSelectClause, getSort, getWhereClause, rpeLogger

Methods inherited from interface org.alfresco.rest.framework.tools.RequestReader

extractJsonContent, extractJsonContentAsList, rrLogger

Methods inherited from interface org.alfresco.rest.framework.tools.ResponseWriter

renderErrorResponse, renderErrorResponse, renderException, renderException, renderJsonResponse, resWriterLogger, setContentInfoOnResponse, setResponse, setResponse

Field Details

assistant

protected ApiAssistant assistant

helper

protected ResourceWebScriptHelper helper

Constructor Details

SearchSQLApiWebscript

public SearchSQLApiWebscript()

Method Details

execute

public void execute(org.springframework.extensions.webscripts.WebScriptRequest webScriptRequest,
 org.springframework.extensions.webscripts.WebScriptResponse res)
             throws IOException

Specified by:

execute in interface org.springframework.extensions.webscripts.WebScript

Throws:

IOException

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

buildSearchParameters

public SearchParameters buildSearchParameters(SearchSQLQuery searchQuery)

setServiceRegistry

public void setServiceRegistry(ServiceRegistry serviceRegistry)

setSearchService

public void setSearchService(SearchService searchService)

setSearchMapper

public void setSearchMapper(SearchMapper searchMapper)

setResultMapper

public void setResultMapper(ResultMapper resultMapper)

setAssistant

public void setAssistant(ApiAssistant assistant)

setHelper

public void setHelper(ResourceWebScriptHelper helper)