Package org.alfresco.rest.framework.tools

Class ApiAssistant

java.lang.Object

org.alfresco.rest.framework.tools.ApiAssistant

public class ApiAssistant
extends Object

Assists you in creating a great Rest API.

Author:

Gethin James

Constructor Summary

Constructors

Constructor	Description
ApiAssistant()

Method Summary

Modifier and Type	Method	Description
static Api	determineApi(Map<String,String> templateVars)	Determines the api being used from the templateVars
JacksonHelper	getJsonHelper()
org.alfresco.metrics.rest.RestMetricsReporter	getRestMetricsReporter()
ErrorResponse	resolveException(Exception ex)	Resolves an exception as a json error.
void	setDefaultResolver(ExceptionResolver<Exception> defaultResolver)
void	setJsonHelper(JacksonHelper jsonHelper)
void	setResolver(ExceptionResolver<Exception> resolver)
void	setRestMetricsReporter(org.alfresco.metrics.rest.RestMetricsReporter restMetricsReporterImpl)
void	setWebScriptExceptionResolver(ExceptionResolver<org.springframework.extensions.webscripts.WebScriptException> webScriptExceptionResolver)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiAssistant

public ApiAssistant()

Method Detail

determineApi

public static Api determineApi(Map<String,String> templateVars)

Determines the api being used from the templateVars

Parameters:

templateVars -

Returns:

Api

resolveException

public ErrorResponse resolveException(Exception ex)

Resolves an exception as a json error.

Parameters:

exception -

Returns:

ErrorResponse

getJsonHelper

public JacksonHelper getJsonHelper()

setDefaultResolver

public void setDefaultResolver(ExceptionResolver<Exception> defaultResolver)

setWebScriptExceptionResolver

public void setWebScriptExceptionResolver(ExceptionResolver<org.springframework.extensions.webscripts.WebScriptException> webScriptExceptionResolver)

setResolver

public void setResolver(ExceptionResolver<Exception> resolver)

setJsonHelper

public void setJsonHelper(JacksonHelper jsonHelper)

getRestMetricsReporter

public org.alfresco.metrics.rest.RestMetricsReporter getRestMetricsReporter()

Returns:

null if the code is run in community mode

setRestMetricsReporter

public void setRestMetricsReporter(org.alfresco.metrics.rest.RestMetricsReporter restMetricsReporterImpl)