ambit2.rest

Class AbstractResource<Q,T extends Serializable,P extends net.idea.modbcum.i.processors.IProcessor<Q,org.restlet.representation.Representation>>

java.lang.Object

org.restlet.resource.UniformResource

org.restlet.resource.ServerResource

ambit2.rest.ProtectedResource

ambit2.rest.freemarker.FreeMarkerResource

ambit2.rest.AbstractResource<Q,T,P>

Type Parameters:

Q -

T -

P -

All Implemented Interfaces:

net.idea.restnet.i.aa.IAuthToken, net.idea.restnet.i.freemarker.IFreeMarkerSupport

Direct Known Subclasses:

SimpleTaskResource

public abstract class AbstractResource<Q,T extends Serializable,P extends net.idea.modbcum.i.processors.IProcessor<Q,org.restlet.representation.Representation>>
extends FreeMarkerResource

Abstract class for resources

Author:

nina

Field Summary

Fields

Modifier and Type	Field and Description
static String	b64search_param
static String	caseSensitive
static String	condition
protected Exception	error
static String	max_hits
static String	property
protected Q	queryObject
protected org.restlet.data.Status	response_status
static String	returnProperties
static String	search_param

Fields inherited from class ambit2.rest.freemarker.FreeMarkerResource

fmSupport

Constructor Summary

Constructors

Constructor and Description
AbstractResource()

Method Summary

Modifier and Type	Method and Description
abstract P	createConvertor(org.restlet.representation.Variant variant)
protected abstract Q	createQuery(org.restlet.Context context, org.restlet.Request request, org.restlet.Response response)
protected void	customizeVariants(org.restlet.data.MediaType[] mimeTypes)
protected void	doInit()
protected org.restlet.representation.Representation	get(org.restlet.representation.Variant variant)
protected String	getParameter(org.restlet.data.Form requestHeaders, String paramName, String description) Calls #getParameter(Form, String, boolean) with false for the last argument
protected String	getParameter(org.restlet.data.Form requestHeaders, String paramName, String description, boolean mandatory) Returns parameter value and throwsan exception if value is missing of mandatory parameter
protected org.restlet.representation.Representation	getRepresentation(org.restlet.representation.Variant variant)
List<org.restlet.representation.Variant>	getVariants()
protected org.restlet.representation.Representation	post(org.restlet.representation.Representation entity, org.restlet.representation.Variant variant)
protected org.restlet.representation.Representation	processNotFound(net.idea.modbcum.i.exceptions.NotFoundException x, org.restlet.representation.Variant variant)
String[]	URI_to_handle()

Methods inherited from class ambit2.rest.freemarker.FreeMarkerResource

configureTemplateMap, getHTMLByTemplate, getSearchReference, getTemplateName, isHtmlbyTemplate, setHtmlbyTemplate, toRepresentation

Methods inherited from class ambit2.rest.ProtectedResource

cleanedResourceRef, doRelease, getAgent, getPassword, getResourceRef, getToken, getTokenFromCookies, getUserName, setCacheHeaders, setFrameOptions, setTokenCookies, useSecureCookie

Methods inherited from class org.restlet.resource.ServerResource

delete, delete, describeVariants, doConditionalHandle, doHandle, doHandle, doNegotiatedHandle, get, getInfo, getInfo, getOnContinue, getOnSent, getPreferredVariant, handle, head, head, isAnnotated, isConditional, isExisting, isInRole, isNegotiated, options, options, post, put, put, redirectPermanent, redirectPermanent, redirectSeeOther, redirectSeeOther, redirectTemporary, redirectTemporary, setAllowedMethods, setAnnotated, setChallengeRequests, setConditional, setCookieSettings, setDimensions, setExisting, setLocationRef, setLocationRef, setNegotiated, setOnContinue, setOnSent, setServerInfo, setStatus, setStatus, setStatus, setStatus, updateAllowedMethods, updateDimensions

Methods inherited from class org.restlet.resource.UniformResource

doCatch, getAllowedMethods, getApplication, getChallengeRequests, getChallengeResponse, getClientInfo, getConditions, getContext, getConverterService, getCookies, getCookieSettings, getDimensions, getHostRef, getLocationRef, getLogger, getMatrix, getMetadataService, getMethod, getOriginalRef, getProtocol, getQuery, getRanges, getReference, getReferrerRef, getRequest, getRequestAttributes, getRequestEntity, getResponse, getResponseAttributes, getResponseEntity, getRootRef, getServerInfo, getStatus, getStatusService, init, isConfidential, release

Methods inherited from class java.lang.Object

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

Field Detail

queryObject

protected Q queryObject

error

protected Exception error

response_status

protected org.restlet.data.Status response_status

search_param

public static final String search_param

See Also:

Constant Field Values

b64search_param

public static final String b64search_param

See Also:

Constant Field Values

property

public static final String property

See Also:

Constant Field Values

condition

public static final String condition

See Also:

Constant Field Values

caseSensitive

public static final String caseSensitive

See Also:

Constant Field Values

returnProperties

public static final String returnProperties

See Also:

Constant Field Values

max_hits

public static final String max_hits

See Also:

Constant Field Values

Constructor Detail

AbstractResource

public AbstractResource()

Method Detail

URI_to_handle

public String[] URI_to_handle()

doInit

protected void doInit()
               throws org.restlet.resource.ResourceException

Overrides:

doInit in class ProtectedResource

Throws:

org.restlet.resource.ResourceException

customizeVariants

protected void customizeVariants(org.restlet.data.MediaType[] mimeTypes)

createConvertor

public abstract P createConvertor(org.restlet.representation.Variant variant)
                           throws net.idea.modbcum.i.exceptions.AmbitException,
                                  org.restlet.resource.ResourceException

Throws:

net.idea.modbcum.i.exceptions.AmbitException

org.restlet.resource.ResourceException

createQuery

protected abstract Q createQuery(org.restlet.Context context,
                                 org.restlet.Request request,
                                 org.restlet.Response response)
                          throws org.restlet.resource.ResourceException

Throws:

org.restlet.resource.ResourceException

getVariants

public List<org.restlet.representation.Variant> getVariants()

Overrides:

getVariants in class org.restlet.resource.ServerResource

get

protected org.restlet.representation.Representation get(org.restlet.representation.Variant variant)
                                                 throws org.restlet.resource.ResourceException

Overrides:

get in class FreeMarkerResource

Throws:

org.restlet.resource.ResourceException

getRepresentation

protected org.restlet.representation.Representation getRepresentation(org.restlet.representation.Variant variant)
                                                               throws org.restlet.resource.ResourceException

Overrides:

getRepresentation in class FreeMarkerResource

Throws:

org.restlet.resource.ResourceException

processNotFound

protected org.restlet.representation.Representation processNotFound(net.idea.modbcum.i.exceptions.NotFoundException x,
                                                                    org.restlet.representation.Variant variant)
                                                             throws Exception

Throws:

Exception

getParameter

protected String getParameter(org.restlet.data.Form requestHeaders,
                              String paramName,
                              String description,
                              boolean mandatory)
                       throws org.restlet.resource.ResourceException

Returns parameter value and throwsan exception if value is missing of mandatory parameter

Parameters:

requestHeaders -

paramName -

mandatory -

Returns:

Throws:

org.restlet.resource.ResourceException

getParameter

protected String getParameter(org.restlet.data.Form requestHeaders,
                              String paramName,
                              String description)
                       throws org.restlet.resource.ResourceException

Calls #getParameter(Form, String, boolean) with false for the last argument

Parameters:

requestHeaders -

paramName -

Returns:

Throws:

org.restlet.resource.ResourceException

post

protected org.restlet.representation.Representation post(org.restlet.representation.Representation entity,
                                                         org.restlet.representation.Variant variant)
                                                  throws org.restlet.resource.ResourceException

Overrides:

post in class org.restlet.resource.ServerResource

Throws:

org.restlet.resource.ResourceException