Package com.simplicite.webapp.services

Class RESTMappedObjectsExternalObject

java.lang.Object

com.simplicite.util.ExternalObject

com.simplicite.webapp.services.RESTServiceExternalObject

com.simplicite.webapp.services.RESTMappedObjectsExternalObject

All Implemented Interfaces:

com.simplicite.util.engine.CacheInterface, java.io.Serializable

public abstract class RESTMappedObjectsExternalObject
extends RESTServiceExternalObject

REST service external object dedicated to mapped business object services

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DESC_HIDDEN_FROM_SCHEMA	Hidden description, means hiding from the schemas
static java.lang.String	OPERATION_CREATE	Create operation
static java.lang.String	OPERATION_DELETE	Delete operation
static java.lang.String	OPERATION_GET	Get operation
static java.lang.String	OPERATION_PING	Ping operation
static java.lang.String	OPERATION_SEARCH	Search operation
static java.lang.String	OPERATION_UPDATE	Update operation

Fields inherited from class com.simplicite.util.ExternalObject

DEFAUT_MIME_TYPE

Constructor Summary

Constructors

Constructor	Description
RESTMappedObjectsExternalObject()

Method Summary

Modifier and Type	Method	Description
void	addField(java.lang.String name, java.lang.String field, java.lang.String fieldName)	Add a field mapping
void	addField(java.lang.String name, java.lang.String field, java.lang.String fieldName, java.lang.String desc, java.lang.String example)	Add a field mapping
void	addObject(java.lang.String name, java.lang.String objName)	Add an object mapping
void	addObject(java.lang.String name, java.lang.String objName, java.lang.String desc)	Add an object mapping
void	addObject(java.lang.String name, java.lang.String objName, java.lang.String desc, boolean paginated, int pageSize)	Add an object mapping
void	addOperationDesc(java.lang.String name, java.lang.String op, java.lang.String desc)	Add a description for operation
void	addRefField(java.lang.String name, java.lang.String refName, java.lang.String refField, java.lang.String refFieldName)	Add a reference field mapping
void	addRefField(java.lang.String name, java.lang.String refName, java.lang.String refField, java.lang.String refFieldName, java.lang.String desc)	Add a reference field mapping
void	addRefField(java.lang.String name, java.lang.String refName, java.lang.String refField, java.lang.String refFieldName, java.lang.String linkName, boolean embeddedLink, int embeddingDepth, java.lang.String desc)	Add a reference field mapping
void	addRefField(java.lang.String name, java.lang.String refName, java.lang.String refField, java.lang.String refFieldName, java.lang.String linkName, boolean embeddedLink, java.lang.String desc)	Add a reference field mapping
void	addTimestampFields(java.lang.String name)	Addd timestamp fields
java.lang.Object	del(Parameters params)	DELETE method
org.json.JSONObject	error(int code, java.lang.String message)	Error response
java.lang.Object	get(Parameters params)	GET method
java.lang.String	getOpenAPIBasePath()	Get OpenAPI base path
java.lang.String	getOpenAPIDesc()	Get OpenAPI description
int	getOpenAPISpec()	Get OpenAPI specification
java.lang.String	getOpenAPIVers()	Get OpenAPI version
int	getOpenAPIVersion()	Deprecated, for removal: This API element is subject to removal in a future version. Use getOpenAPISpec
org.json.JSONObject	openapi()	OpenAPI documentation
java.lang.Object	post(Parameters params)	POST method
java.lang.Object	put(Parameters params)	PUT method
void	setOpenAPIBasePath(java.lang.String basePath)	Set base path (defauts to /api/<name>)
void	setOpenAPIDesc(java.lang.String desc)	Set description (defauts to external objet description)
void	setOpenAPISpec(int spec)	Set OpenAPI specification
void	setOpenAPIVers(java.lang.String version)	Set version (defauts to external objet name)
void	setOpenAPIVersion(int spec)	Deprecated, for removal: This API element is subject to removal in a future version. Use setOpenAPISpec
org.json.JSONObject	success(java.lang.String operation, java.lang.String objName, org.json.JSONObject res)	Success response

Methods inherited from class com.simplicite.webapp.services.RESTServiceExternalObject

badRequest, badRequest, borrowAPIObject, clearDataCache, display, error, error, error, forbidden, getFromDataCache, getURIParts, head, init, internalServerError, isDebug, patch, removeFromDataCache, returnAPIObject, setDebug, setUseCache, storeInDataCache, success, unauthorized, useDataCache, useObjectPool

Methods inherited from class com.simplicite.util.ExternalObject

addChartjs, addExtraCSS, addExtraCSS, addExtraHTML, addExtraHTML, addExtraJS, addExtraJS, addFullCalendar, addFullCalendar, addGmap, addJQPlot, addMarkdown, addMustache, addQRCodeScanner, addSharedScript, addSignaturePad, addSimpliciteClient, addVue, addVueRuntimeOnly, apendSimpliciteLib, appendChartjs, appendCSSInclude, appendCSSIncludes, appendFullCalendar, appendFullCalendar, appendGmap, appendHTML, appendJQPlot, appendJSInclude, appendJSIncludes, appendMarkdown, appendMustache, appendQRCodeScanner, appendSignaturePad, appendVue, appendVueRuntimeOnly, destroy, enableGC, evalExpression, garbageCollection, getBooleanParameter, getCacheKey, getClassName, getConsole, getContentDisposition, getCSSResources, getDesc, getDisplay, getDoubleParameter, getExternalObjectId, getExternalObjectName, getExtraCSS, getExtraHTML, getExtraJS, getFlagParameter, getFloatParameter, getGrant, getHelp, getHTML, getHTMLResources, getHTTPStatus, getIconCode, getId, getImageResources, getInstanceName, getIntParameter, getJSResources, getLabel, getLongParameter, getMaxAge, getMimeType, getMIMEType, getModuleId, getModuleName, getName, getObjectParameter, getObjectParameter, getParameter, getParameter, getResource, getResourceContent, getResourceCSSContent, getResourceCSSURL, getResourceFontContent, getResourceFontURL, getResourceHTMLContent, getResourceHTMLURL, getResourceJSContent, getResourceJSURL, getResourcePDFContent, getResourcePDFURL, getResources, getResourceURL, getRoot, getScriptId, getSharedScripts, getTarget, getURL, hasDecoration, hasJSGlobals, hasJSParameters, hasResources, hasTitle, httpRedirect, invokeAction, invokeAction, invokeAction, invokeAction, isEmbedded, isJavaImplemented, isPublic, javascript, lastUsage, prepareExpression, readScript, redirect, removeParameter, removeParameters, sendHttpError, sendHttpRedirect, sendJavaScript, sendRedirect, setClassName, setConsole, setContentDisposition, setCSVMIMEType, setDecoration, setDisplay, setGrant, setHelp, setHTML, setHTMLMIMEType, setHTTPStatus, setIconCode, setId, setInstanceName, setJavaImplemented, setJSGlobals, setJSONMIMEType, setJSParameters, setLabel, setMaxAge, setMimeType, setMIMEType, setModuleId, setModuleName, setMSExcelMIMEType, setMSPowerPointMIMEType, setMSWordMIMEType, setName, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setPDFMIMEType, setPublic, setResources, setRoot, setScriptId, setTarget, setTextMIMEType, setTitle, setTSVMIMEType, setURL, setUseCalculator, setUseCalendar, setUseCharts, setUseCodeEditor, setUseCompletion, setUseHTMLEditor, setUseJQPlot, setUseSimpliciteClient, setUseTreeview, setXMLMIMEType, setYAMLMIMEType, setZIPMIMEType, toJSONObject, toString, unitTests, useCalculator, useCalendar, useChartjs, useCodeEditor, useCompletion, useHTMLEditor, useJQPlot, useSimpliciteClient, useTreeview

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DESC_HIDDEN_FROM_SCHEMA

public static final java.lang.String DESC_HIDDEN_FROM_SCHEMA

Hidden description, means hiding from the schemas

See Also:

Constant Field Values

OPERATION_PING

public static final java.lang.String OPERATION_PING

Ping operation

See Also:

Constant Field Values

OPERATION_SEARCH

public static final java.lang.String OPERATION_SEARCH

Search operation

See Also:

Constant Field Values

OPERATION_GET

public static final java.lang.String OPERATION_GET

Get operation

See Also:

Constant Field Values

OPERATION_CREATE

public static final java.lang.String OPERATION_CREATE

Create operation

See Also:

Constant Field Values

OPERATION_UPDATE

public static final java.lang.String OPERATION_UPDATE

Update operation

See Also:

Constant Field Values

OPERATION_DELETE

public static final java.lang.String OPERATION_DELETE

Delete operation

See Also:

Constant Field Values

Constructor Detail

RESTMappedObjectsExternalObject

public RESTMappedObjectsExternalObject()

Method Detail

error

public org.json.JSONObject error(int code,
                                 java.lang.String message)

Error response

Overrides:

error in class RESTServiceExternalObject

Parameters:

code - HTTP status

message - Error message

Returns:

JSON object

success

public org.json.JSONObject success(java.lang.String operation,
                                   java.lang.String objName,
                                   org.json.JSONObject res)

Success response

Parameters:

operation - Operation (one of OPERATION_*)

objName - Object name

res - Response

Returns:

JSON object

addObject

public void addObject(java.lang.String name,
                      java.lang.String objName)

Add an object mapping

Parameters:

name - Mapped object name (e.g. users mapped to User)

objName - Business object name (e.g. User)

addObject

public void addObject(java.lang.String name,
                      java.lang.String objName,
                      java.lang.String desc)

Add an object mapping

Parameters:

name - Mapped object name (e.g. users mapped to User)

objName - Business object name (e;g. User)

desc - Optional description (defaults to configured object description, using DESC_HIDDEN constant hides object from the schemas)

addObject

public void addObject(java.lang.String name,
                      java.lang.String objName,
                      java.lang.String desc,
                      boolean paginated,
                      int pageSize)

Add an object mapping

Parameters:

name - Mapped object name (e.g. users mapped to User)

objName - Business object name (e;g. User)

desc - Optional description (defaults to configured object description, using DESC_HIDDEN constant hides object from the schemas)

paginated - Paginated by default?

pageSize - Default page size. Defautls to configured page size if this value is 0

addTimestampFields

public void addTimestampFields(java.lang.String name)

Addd timestamp fields

Parameters:

name - Mapped objevt name

addOperationDesc

public void addOperationDesc(java.lang.String name,
                             java.lang.String op,
                             java.lang.String desc)

Add a description for operation

Parameters:

name - Object name (may be null)

op - Operation name (one of OPERATION_* constant)

desc - Description

addField

public void addField(java.lang.String name,
                     java.lang.String field,
                     java.lang.String fieldName)

Add a field mapping

Parameters:

name - Mapped object name (e.g. users)

field - Mapped field name (e.g. login)

fieldName - Actual business object field name (e.g. usr_login)

addField

public void addField(java.lang.String name,
                     java.lang.String field,
                     java.lang.String fieldName,
                     java.lang.String desc,
                     java.lang.String example)

Add a field mapping

Parameters:

name - Mapped object name (e.g. users)

field - Mapped field name (e.g. login)

fieldName - Actual business object field name (e.g. usr_login)

desc - Optional description (defaults to configured field description)

example - Optional example value

addRefField

public void addRefField(java.lang.String name,
                        java.lang.String refName,
                        java.lang.String refField,
                        java.lang.String refFieldName)

Add a reference field mapping

Parameters:

name - Mapped object name (e.g. resps mapped to Responsability)

refName - Mapped referenced object name (e.g. users mapped to User), note that this object name is implictly used to name the link

refField - Mapped reference field name (e.g. userId)

refFieldName - Actual business object reference field name (e.g. rsp_login_id)

addRefField

public void addRefField(java.lang.String name,
                        java.lang.String refName,
                        java.lang.String refField,
                        java.lang.String refFieldName,
                        java.lang.String desc)

Add a reference field mapping

Parameters:

name - Mapped object name (e.g. resps mapped to Responsability)

refName - Mapped referenced object name (e.g. users mapped to User), note that this object name is implictly used to name the link

refField - Mapped reference field name (e.g. userId)

refFieldName - Actual business object reference field name (e.g. rsp_login_id)

desc - Optional description (defaults to configured reference field description)

addRefField

public void addRefField(java.lang.String name,
                        java.lang.String refName,
                        java.lang.String refField,
                        java.lang.String refFieldName,
                        java.lang.String linkName,
                        boolean embeddedLink,
                        java.lang.String desc)

Add a reference field mapping

Parameters:

name - Mapped object name (e.g. resps mapped to Responsability)

refName - Mapped referenced object name (e.g. users mapped to User)

refField - Mapped reference field name (e.g. userId)

refFieldName - Actual business object reference field name (e.g. rsp_login_id)

linkName - Optional link name (e.g. userResps), otherwise the referenced object name is used to name the link

embeddedLink - Embedded link?

desc - Optional description (defaults to configured reference field description)

addRefField

public void addRefField(java.lang.String name,
                        java.lang.String refName,
                        java.lang.String refField,
                        java.lang.String refFieldName,
                        java.lang.String linkName,
                        boolean embeddedLink,
                        int embeddingDepth,
                        java.lang.String desc)

Add a reference field mapping

Parameters:

name - Mapped object name (e.g. resps mapped to Responsability)

refName - Mapped referenced object name (e.g. users mapped to User)

refField - Mapped reference field name (e.g. userId)

refFieldName - Actual business object reference field name (e.g. rsp_login_id)

linkName - Optional link name (e.g. userResps), otherwise the referenced object name is used to name the link

embeddedLink - Embedded link?

embeddingDepth - Embedding depth (for reflexive link) <1 means no limit in depth

desc - Optional description (defaults to configured reference field description)

getOpenAPISpec

public int getOpenAPISpec()

Get OpenAPI specification

Returns:

OpenAPI specification (one of JSONTool.OPENAPI_*)

setOpenAPISpec

public void setOpenAPISpec(int spec)

Set OpenAPI specification

Parameters:

spec - OpenAPI specification (one of JSONTool.OPENAPI_*)

setOpenAPIDesc

public void setOpenAPIDesc(java.lang.String desc)

Set description (defauts to external objet description)

Parameters:

desc - OpenAPI description

getOpenAPIDesc

public java.lang.String getOpenAPIDesc()

Get OpenAPI description

Returns:

OpenAPI description

setOpenAPIVers

public void setOpenAPIVers(java.lang.String version)

Set version (defauts to external objet name)

Parameters:

version - OpenAPI version

getOpenAPIVers

public java.lang.String getOpenAPIVers()

Get OpenAPI version

Returns:

OpenAPI version

setOpenAPIBasePath

public void setOpenAPIBasePath(java.lang.String basePath)

Set base path (defauts to /api/<name>)

Parameters:

basePath - OpenAPI base path

getOpenAPIBasePath

public java.lang.String getOpenAPIBasePath()

Get OpenAPI base path

Returns:

basePath OpenAPI base path

openapi

public org.json.JSONObject openapi()

OpenAPI documentation

Overrides:

openapi in class RESTServiceExternalObject

Returns:

OpenAPI documentation as JSON object

get

public java.lang.Object get(Parameters params)
                     throws HTTPException

GET method

Overrides:

get in class RESTServiceExternalObject

Parameters:

params - Parameters

Returns:

GET response

Throws:

HTTPException

post

public java.lang.Object post(Parameters params)
                      throws HTTPException

POST method

Overrides:

post in class RESTServiceExternalObject

Parameters:

params - Parameters

Returns:

POST response

Throws:

HTTPException

put

public java.lang.Object put(Parameters params)
                     throws HTTPException

PUT method

Overrides:

put in class RESTServiceExternalObject

Parameters:

params - Parameters

Returns:

PUT response

Throws:

HTTPException

del

public java.lang.Object del(Parameters params)
                     throws HTTPException

DELETE method

Overrides:

del in class RESTServiceExternalObject

Parameters:

params - Parameters

Returns:

DELETE response

Throws:

HTTPException

getOpenAPIVersion

@Deprecated(forRemoval=true,
            since="4.0")
public int getOpenAPIVersion()

Deprecated, for removal: This API element is subject to removal in a future version.

Use getOpenAPISpec

setOpenAPIVersion

@Deprecated(forRemoval=true,
            since="4.0")
public void setOpenAPIVersion(int spec)

Deprecated, for removal: This API element is subject to removal in a future version.

Use setOpenAPISpec