Package com.simplicite.webapp.tools

Class JSONServletTool

java.lang.Object

com.simplicite.util.tools.JSONTool

com.simplicite.webapp.tools.JSONServletTool

public final class JSONServletTool
extends JSONTool

JSON Servlet toolbox

Field Summary

Fields inherited from class com.simplicite.util.tools.JSONTool

EMPTY_JSON_ARRAY, EMPTY_JSON_OBJECT, ERRLEVEL_ERROR, ERRLEVEL_FATAL, ERRLEVEL_WARNING, JSON_DOT_REPLACEMENT, OPENAPI_OAS2, OPENAPI_OAS2_VERSION, OPENAPI_OAS3, OPENAPI_OAS3_VERSION

Constructor Summary

Constructors

Constructor	Description
JSONServletTool()	Constructor Don't instantiate this class, it only provides static variables and methods

Method Summary

Modifier and Type	Method	Description
static java.lang.String	action(ObjectDB obj, Action action, ServletParameters params, boolean embedded)
static java.lang.String	applicationService(ServletParameters params, Grant g)
static java.lang.String	businessObjectService(ServletParameters params, Grant g)
static java.lang.String	businessProcessService(ServletParameters params, Grant g)
static java.lang.String	count(ObjectDB obj, int context, ServletParameters params, boolean embedded)
static java.lang.String	create(ObjectDB obj, ServletParameters params)
static java.lang.String	create(ObjectDB obj, ServletParameters params, boolean embedded)
static java.lang.String	create(ObjectDB obj, ServletParameters params, boolean timestamps, Parameters.InlineParam inlines, boolean embedded)
static java.lang.String	crosstab(ObjectDB obj, Crosstab c, ServletParameters params)
static java.lang.String	crosstab(ObjectDB obj, Crosstab c, ServletParameters params, boolean embedded)
static java.lang.String	crosstabcubes(ObjectDB obj, Crosstab c, ServletParameters params)
static java.lang.String	crosstabcubes(ObjectDB obj, Crosstab c, ServletParameters params, boolean embedded)
static java.lang.String	delete(ObjectDB obj, ServletParameters params)
static java.lang.String	delete(ObjectDB obj, ServletParameters params, boolean embedded)
static java.lang.String	deleteAll(ObjectDB obj, ServletParameters params, boolean embedded)	Bulk deletion
static java.lang.String	documentation(ObjectDB obj, boolean html, boolean header, boolean services, int titleLevel)	Documentation (raw Markdown or HTML)
static java.lang.String	getRedo(Grant g, java.lang.String type)	List all redo
static java.lang.String	getUndo(Grant g, java.lang.String type)	List all undo
static java.lang.String	graph(ObjectDB obj, Graphic g, ServletParameters params)
static java.lang.String	graph(ObjectDB obj, Graphic g, ServletParameters params, boolean embedded)
static java.lang.String	indexsearch(Grant g, ServletParameters params, boolean embedded)
static java.lang.String	indexsearch(Grant g, java.lang.String oneObject, java.lang.String req, Parameters.InlineParam inlines, boolean embedded, boolean metadata, int context, ObjectDB parent)
static java.lang.String	populate(ObjectDB obj, ServletParameters params, Parameters.InlineParam inlines, boolean embedded)
static java.lang.String	print(ObjectDB obj, PrintTemplate pt, ServletParameters params, boolean embedded)	Publication
static java.util.HashMap<java.lang.String,java.lang.String>	readActionFields(ServletParameters params)	Read action fields in parameter _itemaction
static java.lang.String	redo(Grant g, ServletParameters params)	Redo last change if Undo/Redo is set
static java.lang.String	search(ObjectDB obj, int context, ServletParameters params, boolean timestamps, Parameters.InlineParam inlines, boolean embedded, boolean metadata, boolean visibleOnly, java.lang.String edit)
static org.json.JSONObject	session(Grant g, javax.servlet.http.HttpSession session, boolean picture, java.lang.String dateformat)	Session and user info
static java.lang.String	treeview(Grant g, ServletParameters params)	Tree view service
static java.lang.String	undo(Grant g, ServletParameters params)	Undo last change if Undo/Redo is set
static java.lang.String	update(ObjectDB obj, ServletParameters params)
static java.lang.String	update(ObjectDB obj, ServletParameters params, boolean embedded)
static java.lang.String	update(ObjectDB obj, ServletParameters params, boolean timestamps, Parameters.InlineParam inlines, boolean embedded, Parameters.TreeviewParam tv)
static java.lang.String	update(ObjectDB obj, ServletParameters params, Parameters.TreeviewParam tv)
static java.lang.String	updateAll(ObjectDB obj, ServletParameters params, boolean embedded)

Methods inherited from class com.simplicite.util.tools.JSONTool

actionToJson, activityData, activityData, activityDataToJson, activityMetaDataToJson, addActionResultSchema, addAppSessionOpenAPIPath, addBusinessObjectOpenAPIPath, addBusinessObjectOpenAPISchema, addErrorsSchema, addLoginOpenAPIPath, addLogoutOpenAPIPath, addOpenAPIOperationType, addOpenAPIOperationTypes, addOpenAPIParameterType, addPublicationResultSchema, addTag, addTreeviewDataSchema, count, count, document, document, error, error, error, errors, errors, errors, fieldsToJson, fieldsToJson, fieldValue, fieldValue, filters, filters, filters, filtersToJson, fromJSONName, fromYAML, functIdToJson, get, get, get, get, get, get, getError, getError, getError, getErrors, getErrors, getErrors, getInfo, getJSONASCIILogo, getJSONObjectFromXML, getJSONSchema, getOpenAPIError, getOpenAPIInfo, getOpenAPIRef, getOpenAPISchema, getResponse, getResponse, getSysParam, getSysParam, getSysParams, getTexts, getTexts, getWarning, getWarnings, getXMLFromJSONObject, getYAMLASCIILogo, getYAMLProcessor, groupByToJson, historic, indexMetaDataToJson, info, initWebService, jsonAppInfo, jsonApps, jsonArray, jsonArray, jsonArray, jsonArray, jsonDeclaration, jsonDeclaration, jsonDeclaration, jsonDeclaration, jsonDeclaration, jsonDeclaration, jsonDeclaration, jsonDeclaration, jsonDeclaration, jsonDeclaration, jsonDeclaration, jsonDeclaration, jsonDeclaration, jsonDeclaration, jsonDeclaration, jsonDeclaration, jsonDeclaration, jsonDeclaration, jsonDeclaration, jsonDocument, jsonDocument, jsonEnclosedDeclaration, jsonEnclosedDeclaration, jsonEnclosedDeclaration, jsonEnclosedStringDeclaration, jsonEnclosedStringDeclaration, jsonEnclosedStringDeclaration, jsonExtObject, jsonFollow, jsonGetSysParam, jsonGetSysParams, jsonGrant, jsonGrant, jsonListOfValue, jsonMenu, jsonMetaObject, jsonNews, jsonObjectToMap, jsonPreferences, jsonReadDocument, jsonResponse, jsonResponse, jsonSessionInfo, jsonSetSysParam, jsonShortcuts, jsonString, jsonStringArray, jsonStringArray, jsonStringDeclaration, jsonStringDeclaration, jsonStringDeclaration, jsonSysInfo, jsonTestData, jsonText, jsonTexts, jsonTextsArray, JsonToXML, JsonToXML, jsonUndoRedo, jsonUser, jsonWriteDocument, list, listAuthors, listFollows, listSocialPosts, listToJson, listTotals, lovToJson, mapToJSON, messageToJson, metadata, metadata, objectFieldMetaDataToJson, objectFieldMetaDataToJson, objectMetaDataToJson, prepareActionTarget, prepareActionURL, printTemplateToJson, processMetadata, processMetadata, processMetaDataToJson, resourcesToJson, resourceToJson, rowMetaDataToJson, savePreferences, socialCount, toJSONName, toYAML, toYAML, toYAML, toYAML, transitionMetaDataToJson, viewMetadataToJson, warning, warnings

Methods inherited from class java.lang.Object

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

Constructor Detail

JSONServletTool

public JSONServletTool()

Constructor
Don't instantiate this class, it only provides static variables and methods

Method Detail

applicationService

public static java.lang.String applicationService(ServletParameters params,
                                                  Grant g)

businessObjectService

public static java.lang.String businessObjectService(ServletParameters params,
                                                     Grant g)

businessProcessService

public static java.lang.String businessProcessService(ServletParameters params,
                                                      Grant g)

session

public static org.json.JSONObject session(Grant g,
                                          javax.servlet.http.HttpSession session,
                                          boolean picture,
                                          java.lang.String dateformat)

Session and user info

Parameters:

g - Grant

session - Session

picture - Inline picture thumbnail?

dateformat - Date format

search

public static java.lang.String search(ObjectDB obj,
                                      int context,
                                      ServletParameters params,
                                      boolean timestamps,
                                      Parameters.InlineParam inlines,
                                      boolean embedded,
                                      boolean metadata,
                                      boolean visibleOnly,
                                      java.lang.String edit)
                               throws ValidateSearchException

Throws:

ValidateSearchException

count

public static java.lang.String count(ObjectDB obj,
                                     int context,
                                     ServletParameters params,
                                     boolean embedded)

indexsearch

public static java.lang.String indexsearch(Grant g,
                                           ServletParameters params,
                                           boolean embedded)

indexsearch

public static java.lang.String indexsearch(Grant g,
                                           java.lang.String oneObject,
                                           java.lang.String req,
                                           Parameters.InlineParam inlines,
                                           boolean embedded,
                                           boolean metadata,
                                           int context,
                                           ObjectDB parent)
                                    throws SearchException

Throws:

SearchException

populate

public static java.lang.String populate(ObjectDB obj,
                                        ServletParameters params,
                                        Parameters.InlineParam inlines,
                                        boolean embedded)
                                 throws GetException

Throws:

GetException

create

public static java.lang.String create(ObjectDB obj,
                                      ServletParameters params)
                               throws ValidateException,
                                      CreateException,
                                      GetException

Throws:

ValidateException

CreateException

GetException

create

public static java.lang.String create(ObjectDB obj,
                                      ServletParameters params,
                                      boolean embedded)
                               throws ValidateException,
                                      CreateException,
                                      GetException

Throws:

ValidateException

CreateException

GetException

create

public static java.lang.String create(ObjectDB obj,
                                      ServletParameters params,
                                      boolean timestamps,
                                      Parameters.InlineParam inlines,
                                      boolean embedded)
                               throws ValidateException,
                                      CreateException,
                                      GetException

Throws:

ValidateException

CreateException

GetException

update

public static java.lang.String update(ObjectDB obj,
                                      ServletParameters params)
                               throws ValidateException,
                                      UpdateException,
                                      GetException

Throws:

ValidateException

UpdateException

GetException

update

public static java.lang.String update(ObjectDB obj,
                                      ServletParameters params,
                                      boolean embedded)
                               throws ValidateException,
                                      UpdateException,
                                      GetException

Throws:

ValidateException

UpdateException

GetException

update

public static java.lang.String update(ObjectDB obj,
                                      ServletParameters params,
                                      Parameters.TreeviewParam tv)
                               throws ValidateException,
                                      UpdateException,
                                      GetException

Throws:

ValidateException

UpdateException

GetException

update

public static java.lang.String update(ObjectDB obj,
                                      ServletParameters params,
                                      boolean timestamps,
                                      Parameters.InlineParam inlines,
                                      boolean embedded,
                                      Parameters.TreeviewParam tv)
                               throws ValidateException,
                                      UpdateException,
                                      GetException

Throws:

ValidateException

UpdateException

GetException

readActionFields

public static java.util.HashMap<java.lang.String,java.lang.String> readActionFields(ServletParameters params)

Read action fields in parameter _itemaction

Parameters:

params - PArameters

Returns:

Map of field values or null

delete

public static java.lang.String delete(ObjectDB obj,
                                      ServletParameters params)
                               throws GetException,
                                      DeleteException

Throws:

GetException

DeleteException

delete

public static java.lang.String delete(ObjectDB obj,
                                      ServletParameters params,
                                      boolean embedded)
                               throws GetException,
                                      DeleteException

Throws:

GetException

DeleteException

updateAll

public static java.lang.String updateAll(ObjectDB obj,
                                         ServletParameters params,
                                         boolean embedded)
                                  throws UpdateException

Throws:

UpdateException

deleteAll

public static java.lang.String deleteAll(ObjectDB obj,
                                         ServletParameters params,
                                         boolean embedded)
                                  throws DeleteException

Bulk deletion

Parameters:

obj - Object

params - Parameters

embedded - Embedded json ?

Returns:

JSON { count, total, errors, undoredo }

Throws:

DeleteException

crosstab

public static java.lang.String crosstab(ObjectDB obj,
                                        Crosstab c,
                                        ServletParameters params)
                                 throws CrosstabException

Throws:

CrosstabException

crosstab

public static java.lang.String crosstab(ObjectDB obj,
                                        Crosstab c,
                                        ServletParameters params,
                                        boolean embedded)
                                 throws CrosstabException

Throws:

CrosstabException

crosstabcubes

public static java.lang.String crosstabcubes(ObjectDB obj,
                                             Crosstab c,
                                             ServletParameters params)
                                      throws CrosstabException

Throws:

CrosstabException

crosstabcubes

public static java.lang.String crosstabcubes(ObjectDB obj,
                                             Crosstab c,
                                             ServletParameters params,
                                             boolean embedded)
                                      throws CrosstabException

Throws:

CrosstabException

graph

public static java.lang.String graph(ObjectDB obj,
                                     Graphic g,
                                     ServletParameters params)
                              throws GraphException

Throws:

GraphException

graph

public static java.lang.String graph(ObjectDB obj,
                                     Graphic g,
                                     ServletParameters params,
                                     boolean embedded)
                              throws GraphException

Throws:

GraphException

action

public static java.lang.String action(ObjectDB obj,
                                      Action action,
                                      ServletParameters params,
                                      boolean embedded)
                               throws GrantException,
                                      ActionException

Throws:

GrantException

ActionException

print

public static java.lang.String print(ObjectDB obj,
                                     PrintTemplate pt,
                                     ServletParameters params,
                                     boolean embedded)
                              throws GrantException,
                                     PrintException

Publication

Parameters:

obj - Object

pt - Publication template

params - Parameters

embedded - Embedded?

Returns:

Publication result

Throws:

PrintException - If publication fails

GrantException

documentation

public static java.lang.String documentation(ObjectDB obj,
                                             boolean html,
                                             boolean header,
                                             boolean services,
                                             int titleLevel)

Documentation (raw Markdown or HTML)

Parameters:

obj - Object

html - HTML format (false means raw markdown)?

header - Header?

services - Services?

titleLevel - Title level

Returns:

Documentation

treeview

public static java.lang.String treeview(Grant g,
                                        ServletParameters params)

Tree view service

Parameters:

params - Request parameters

Returns:

JSON treeview

undo

public static java.lang.String undo(Grant g,
                                    ServletParameters params)

Undo last change if Undo/Redo is set

Parameters:

params - Request parameters

Returns:

null or URL to display in work area

redo

public static java.lang.String redo(Grant g,
                                    ServletParameters params)

Redo last change if Undo/Redo is set

Parameters:

g - Grant

params - Request parameters

Returns:

null or URL to display in work area

getUndo

public static java.lang.String getUndo(Grant g,
                                       java.lang.String type)

List all undo

Parameters:

g - Grant

type - Type

Returns:

label results

getRedo

public static java.lang.String getRedo(Grant g,
                                       java.lang.String type)

List all redo

Parameters:

g - Grant

type - Type

Returns:

label results