Package com.simplicite.util.tools
Class JSONTool
- java.lang.Object
-
- com.simplicite.util.tools.JSONTool
-
- Direct Known Subclasses:
JSONServletTool
public class JSONTool extends java.lang.Object
JSON toolbox
This class only provides static variables and methods
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
EMPTY_JSON_ARRAY
Empty JSON arraystatic java.lang.String
EMPTY_JSON_OBJECT
Empty JSON objectstatic int
ERRLEVEL_ERROR
static int
ERRLEVEL_FATAL
static int
ERRLEVEL_WARNING
static java.lang.String
JSON_DOT_REPLACEMENT
Deprecated.static int
OPENAPI_OAS2
OAS 2 (Swagger)static java.lang.String
OPENAPI_OAS2_VERSION
OAS 2 version stringstatic int
OPENAPI_OAS3
OAS 3 (OpenAPI)static java.lang.String
OPENAPI_OAS3_VERSION
OAS 3 version string
-
Constructor Summary
Constructors Constructor Description JSONTool()
Hidden default constructor
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static java.lang.String
actionToJson(ObjectDB obj, Action action, java.lang.String[] row, boolean create, int context)
static java.lang.String
activityData(Processus pcs, ActivityFile af, ObjectDB object)
static java.lang.String
activityData(Processus pcs, ActivityFile af, ObjectDB object, boolean metadata, boolean embedded)
static java.lang.String
activityDataToJson(Processus p, ActivityFile af, ObjectDB obj, boolean metadata)
static java.lang.String
activityMetaDataToJson(Activity a)
static org.json.JSONObject
addActionResultSchema(org.json.JSONObject schemas)
Add action result OpenAPI schemas description to schemasstatic org.json.JSONObject
addAppSessionOpenAPIPath(org.json.JSONObject paths, int spec)
Add application and session REST services OpenAPI paths description to pathsstatic org.json.JSONObject
addBusinessObjectOpenAPIPath(org.json.JSONObject paths, ObjectDB obj, java.lang.String relPath, int spec)
Add business object REST services OpenAPI paths to pathsstatic org.json.JSONObject
addBusinessObjectOpenAPISchema(org.json.JSONObject schemas, ObjectDB obj, int spec)
Add business object REST services OpenAPI schema to schemasstatic org.json.JSONObject
addErrorsSchema(org.json.JSONObject schemas)
Add error messages OpenAPI schemas description to schemasstatic org.json.JSONObject
addLoginOpenAPIPath(org.json.JSONObject paths, int spec)
Add login service OpenAPI path description to pathsstatic org.json.JSONObject
addLogoutOpenAPIPath(org.json.JSONObject paths, int spec)
Add logout service OpenAPI path description to pathsstatic org.json.JSONObject
addOpenAPIOperationType(org.json.JSONObject operation, java.lang.String requestType, java.lang.String requestSchema, java.lang.String responseType, java.lang.String responseSchema, int[] errorStatuses, int spec)
Get OpenAPI operation typesstatic org.json.JSONObject
addOpenAPIOperationTypes(org.json.JSONObject operation, java.lang.String[] requestTypes, java.lang.String requestSchema, java.lang.String[] responseTypes, java.lang.String responseSchema, int[] errorStatuses, int spec)
Get OpenAPI operation typesstatic org.json.JSONObject
addOpenAPIParameterType(org.json.JSONObject param, java.lang.String type, org.json.JSONArray values, int spec)
Add OpenAPI parameter typestatic org.json.JSONObject
addPublicationResultSchema(org.json.JSONObject schemas)
Add publication result OpenAPI schemas description to schemasstatic org.json.JSONArray
addTag(org.json.JSONArray tags, java.lang.String name, java.lang.String desc)
Add a tagstatic org.json.JSONObject
addTreeviewDataSchema(org.json.JSONObject schemas)
Add treeview data OpenAPI schemas description to schemasstatic java.lang.String
count(ObjectDB obj)
static java.lang.String
count(ObjectDB obj, boolean metadata)
static java.lang.String
document(ObjectDB obj, java.lang.String rowId, java.lang.String field)
static java.lang.String
document(ObjectDB obj, java.lang.String rowId, java.lang.String field, boolean embedded, boolean copy)
static java.lang.String
error(int status, java.lang.String message, int level, java.lang.String metadata)
Error responsestatic java.lang.String
error(java.lang.String message, int level)
Error responsestatic java.lang.String
error(java.lang.String message, int level, java.lang.String metadata)
Error responsestatic java.lang.String
errors(int status, java.lang.String[] messages, int level, java.lang.String metadata)
Errors responsestatic java.lang.String
errors(java.lang.String[] messages, int level)
Errors responsestatic java.lang.String
errors(java.lang.String[] messages, int level, java.lang.String metadata)
Errors responsestatic java.lang.String
fieldsToJson(ObjectDB obj)
static java.lang.String
fieldsToJson(ObjectDB obj, Parameters.InlineParam inlines, java.lang.String[] fields, boolean onlyFunctIds, boolean timestamps)
static java.lang.String
fieldValue(ObjectField field)
static java.lang.String
fieldValue(ObjectField field, java.lang.String value)
static java.lang.String
filters(ObjectDB obj, boolean reset)
static java.lang.String
filters(ObjectDB obj, int context, boolean reset)
static java.lang.String
filters(ObjectDB obj, int context, boolean reset, boolean embedded)
static java.lang.String
filtersToJson(ObjectDB obj, boolean reset, boolean limited)
JSON filters in service formatstatic java.lang.String
fromJSONName(java.lang.String name)
Get internal name (using dots as separator) from JSON name (using Globals.DOT_REPLACEMENT as separator)static org.json.JSONObject
fromYAML(java.lang.String yaml)
Convert YAML to JSON objectstatic java.lang.String
functIdToJson(ObjectDB obj)
static java.lang.String
get(ObjectDB obj, java.lang.String rowId)
Get object record as JSONstatic java.lang.String
get(ObjectDB obj, java.lang.String rowId, boolean embedded)
Get object record as JSONstatic java.lang.String
get(ObjectDB obj, java.lang.String rowId, int context, boolean timestamps, java.lang.String[] fields, Parameters.InlineParam inlines, boolean embedded, boolean metadata, Parameters.ContextParam parent, boolean social, boolean share, java.util.List<java.lang.String> msgs, Parameters.TreeviewParam tv)
Get object record as JSONstatic java.lang.String
get(ObjectDB obj, java.lang.String rowId, int context, boolean timestamps, java.lang.String[] fields, Parameters.InlineParam inlines, boolean embedded, boolean metadata, Parameters.ContextParam parent, boolean social, boolean share, java.util.List<java.lang.String> msgs, TreeView tv, TreeView.TreeViewNode tvNode, int tvDepth)
Deprecated.static java.lang.String
get(ObjectDB obj, java.lang.String rowId, int context, boolean timestamps, java.lang.String[] fields, Parameters.InlineParam inlines, boolean embedded, boolean metadata, Parameters.ContextParam parent, boolean social, java.util.List<java.lang.String> msgs, TreeView tv, TreeView.TreeViewNode tvNode, int tvDepth)
Deprecated.static java.lang.String
get(ObjectDB obj, java.lang.String rowId, int context, java.lang.String[] fields, Parameters.InlineParam inlines, boolean embedded)
Get object record as JSONstatic org.json.JSONObject
getError(int status, java.lang.Object message, int level, java.lang.Object metadata)
Get error responsestatic org.json.JSONObject
getError(java.lang.Object message, int level)
Get error responsestatic org.json.JSONObject
getError(java.lang.Object message, int level, java.lang.Object metadata)
Get error responsestatic org.json.JSONObject
getErrors(int status, java.lang.Object[] messages, int level, java.lang.Object metadata)
Get errors responsestatic org.json.JSONObject
getErrors(java.lang.Object[] messages, int level)
Get errors responsestatic org.json.JSONObject
getErrors(java.lang.Object[] messages, int level, java.lang.Object metadata)
Get errors responsestatic org.json.JSONObject
getInfo(java.lang.String message)
Get info responsestatic java.lang.String
getJSONASCIILogo(java.lang.String complement)
Get ASCII logo as JSON commentsstatic org.json.JSONObject
getJSONObjectFromXML(java.lang.String xml)
Get JSON object from XMLstatic org.json.JSONObject
getJSONSchema(ObjectDB obj)
Get JSON Schema for specified objectstatic org.json.JSONObject
getOpenAPIError(int code, int spec)
Get OpenAPI errorstatic org.json.JSONObject
getOpenAPIInfo(java.lang.String title, java.lang.String desc, java.lang.String version, boolean license, boolean contact)
Get OpenAPI infostatic java.lang.String
getOpenAPIRef(java.lang.String name, int spec)
Get OpenAPI referencestatic org.json.JSONObject
getOpenAPISchema(Grant g, int spec, org.json.JSONObject info, org.json.JSONArray tags, java.lang.String basePath, org.json.JSONObject paths, org.json.JSONObject schemas)
Get OpenAPI schemastatic org.json.JSONObject
getResponse(java.lang.String type, java.lang.Object response)
Get response JSON objectstatic org.json.JSONObject
getResponse(java.lang.String type, java.lang.Object response, java.lang.String msg)
Get response JSON objectstatic org.json.JSONObject
getSysParam(Grant g, java.lang.String name)
Get a single session system parameter as JSONstatic org.json.JSONObject
getSysParam(Grant g, java.lang.String name, boolean force)
Get a single system parameter as JSONstatic org.json.JSONObject
getSysParams(Grant g, boolean embedded)
Get all session system parameters as JSON ojectstatic java.lang.String
getTexts(Grant g)
Get all texts as a JSON objectstatic java.lang.String
getTexts(Grant g, java.lang.String regex)
Get all matching texts as a JSON objectstatic org.json.JSONObject
getWarning(java.lang.String message)
Get warning responsestatic org.json.JSONObject
getWarnings(java.lang.String[] messages)
Get warnings responsestatic java.lang.String
getXMLFromJSONObject(org.json.JSONObject json)
Get XML from JSON objectLstatic java.lang.String
getYAMLASCIILogo(java.lang.String complement)
Get ASCII logo as YAML commentsstatic org.yaml.snakeyaml.Yaml
getYAMLProcessor()
Get YAML processorstatic java.lang.String
groupByToJson(ObjectDB obj, java.util.List<java.lang.String[]> list)
static java.lang.String
historic(ObjectDB obj, int page)
static java.lang.String
indexMetaDataToJson(Grant g)
Index metadata as JSON stringstatic java.lang.String
info(java.lang.String message)
static ObjectContextWeb
initWebService(ObjectDB obj, int context, Parameters.ContextParam p, boolean apply, java.lang.String edit)
Prepare the object context for web servicestatic java.lang.String
jsonAppInfo(Grant g, boolean embedded)
Application info as JSON stringstatic java.lang.String
jsonApps(Grant g)
Get home pages (scopes) as JSON stringstatic java.lang.String
jsonArray(double[] vals)
static java.lang.String
jsonArray(java.lang.Double[] vals)
static java.lang.String
jsonArray(java.lang.Object[] contents)
static java.lang.String
jsonArray(java.util.List<?> contents)
static java.lang.String
jsonDeclaration(ObjectField f)
static java.lang.String
jsonDeclaration(ObjectField f, java.lang.Object value)
static java.lang.String
jsonDeclaration(java.lang.String name, boolean content)
static java.lang.String
jsonDeclaration(java.lang.String name, double content)
static java.lang.String
jsonDeclaration(java.lang.String name, double[] contents)
static java.lang.String
jsonDeclaration(java.lang.String name, float content)
static java.lang.String
jsonDeclaration(java.lang.String name, float[] contents)
static java.lang.String
jsonDeclaration(java.lang.String name, int content)
static java.lang.String
jsonDeclaration(java.lang.String name, int[] contents)
static java.lang.String
jsonDeclaration(java.lang.String name, long content)
static java.lang.String
jsonDeclaration(java.lang.String name, long[] contents)
static java.lang.String
jsonDeclaration(java.lang.String name, java.lang.Boolean content)
static java.lang.String
jsonDeclaration(java.lang.String name, java.lang.Double content)
static java.lang.String
jsonDeclaration(java.lang.String name, java.lang.Float content)
static java.lang.String
jsonDeclaration(java.lang.String name, java.lang.Integer content)
static java.lang.String
jsonDeclaration(java.lang.String name, java.lang.Long content)
static java.lang.String
jsonDeclaration(java.lang.String name, java.lang.Object content)
static java.lang.String
jsonDeclaration(java.lang.String name, java.lang.String[] contents)
static java.lang.String
jsonDeclaration(java.lang.String name, java.util.List<?> contents)
static java.lang.String
jsonDocument(Grant g, DocumentDB doc, boolean inlineContent, boolean inlineThumbnail, boolean copy)
Builds a JSON object for documentstatic java.lang.String
jsonDocument(Grant g, java.lang.String docId, boolean inlineContent, boolean inlineThumbnail, boolean copy)
Builds a JSON object for documentstatic java.lang.String
jsonEnclosedDeclaration(java.lang.String name, java.lang.String content)
static java.lang.String
jsonEnclosedDeclaration(java.lang.String name, java.lang.String[] contents)
static java.lang.String
jsonEnclosedDeclaration(java.lang.String name, java.util.List<?> contents)
static java.lang.String
jsonEnclosedStringDeclaration(java.lang.String name, java.lang.String content)
static java.lang.String
jsonEnclosedStringDeclaration(java.lang.String name, java.lang.String[] contents)
static java.lang.String
jsonEnclosedStringDeclaration(java.lang.String name, java.util.List<?> contents)
static java.lang.String
jsonExtObject(Grant g, java.lang.String name)
External object meta data as JSONstatic java.lang.String
jsonFollow(Grant g, SocialPost.Author a)
static java.lang.String
jsonGetSysParam(Grant g, java.lang.String name)
Deprecated.static java.lang.String
jsonGetSysParams(Grant g, boolean embedded)
Deprecated.Use getSysParamsstatic java.lang.String
jsonGrant(Grant g, boolean inlinePicture, boolean web, boolean embedded)
Full grant data as JSON stringstatic java.lang.String
jsonGrant(Grant g, boolean inlinePicture, boolean web, boolean texts, boolean embedded)
Full grant data as JSON stringstatic java.lang.String
jsonListOfValue(Grant g, java.lang.String name, boolean embedded)
List of values as JSON stringstatic java.lang.String
jsonMenu(Grant g, boolean embedded)
Menu as JSONstatic java.lang.String
jsonMetaObject(Grant g, java.lang.String val, Parameters.InlineParam inlines)
Builds a JSON object for a meta object valuestatic java.lang.String
jsonNews(Grant g, boolean inlineImages, boolean embedded)
News as JSONstatic java.util.Map<java.lang.String,java.lang.Object>
jsonObjectToMap(org.json.JSONObject object)
Convert JSONObject to plain Mapstatic java.lang.String
jsonPreferences(ObjectDB obj)
Object preferencesstatic java.lang.String
jsonReadDocument(Grant g, java.lang.String docId, boolean includeContent, boolean includeThumbnail)
Read document informations as JSONstatic java.lang.String
jsonResponse(java.lang.String type, java.lang.String response)
static java.lang.String
jsonResponse(java.lang.String type, java.lang.String response, java.lang.String msg)
static java.lang.String
jsonSessionInfo(Grant g, javax.servlet.http.HttpSession session, boolean embedded)
Session info as JSON string{ login, id, timeout, created, lastaccess, expires, timezone, licensed, revision, authtoken }
static java.lang.String
jsonSetSysParam(Grant g, java.lang.String name, java.lang.String value, boolean save)
Set a session system parameter as JSONstatic java.lang.String
jsonShortcuts(Grant g)
Shortcuts as JSON stringstatic java.lang.String
jsonString(java.lang.Object str)
static java.lang.String
jsonStringArray(java.lang.Object[] strs)
static java.lang.String
jsonStringArray(java.util.List<?> contents)
static java.lang.String
jsonStringDeclaration(java.lang.String name, java.lang.Object content)
static java.lang.String
jsonStringDeclaration(java.lang.String name, java.lang.String[] contents)
static java.lang.String
jsonStringDeclaration(java.lang.String name, java.util.List<?> contents)
static java.lang.String
jsonSysInfo(Grant g, boolean embedded)
System info as JSON stringstatic java.lang.String
jsonTestData(Grant g, java.lang.String obj, java.lang.String rowId)
Random datastatic java.lang.String
jsonText(Grant g, java.lang.String code)
Text as JSONstatic java.lang.String
jsonTexts(Grant g)
All texts as JSONstatic java.lang.String
jsonTextsArray(Grant g, java.lang.String regex)
All matching texts as a JSON arraystatic DataXML
JsonToXML(org.json.JSONObject item)
Convert a JSON item to XML data setstatic DataXML
JsonToXML(org.json.JSONObject item, org.json.JSONObject olditem, ObjectDB obj)
Convert a JSON item to XML data setstatic java.lang.String
jsonUndoRedo(ObjectDB obj)
static java.lang.String
jsonUser(Grant g, java.lang.String login, boolean inlinePicture, boolean embedded)
User as JSON stringstatic java.lang.String
jsonWriteDocument(Grant g, java.lang.String docId, java.lang.String name, java.lang.String path, java.lang.String content, java.lang.String object, java.lang.String field, java.lang.String rowId)
Write documentstatic java.lang.String
list(ObjectDB obj, int context, Parameters.ContextParam p, int page, Parameters.InlineParam inlines, boolean embedded, boolean metadata, boolean historic, boolean totals, boolean social, boolean timestamp, boolean visibleOnly, java.lang.String edit, boolean groupby, boolean partial, int treeDepth)
static java.lang.String
listAuthors(Grant g, java.lang.String req, java.lang.String object, boolean all)
static java.lang.String
listFollows(Grant g, java.lang.String status)
static java.lang.String
listSocialPosts(Grant g, java.lang.String postId, java.lang.String object, java.lang.String rowId, int page, boolean act, boolean follow, boolean countersOnly, boolean audit, java.lang.String level)
Social as JSONstatic java.lang.String
listToJson(ObjectDB obj, java.util.List<java.lang.String[]> list, Parameters.InlineParam inlines, int context, Parameters.ContextParam p, boolean metadata, boolean timestamp, boolean visibleOnly, java.lang.String edit)
static java.lang.String
listTotals(ObjectDB obj)
static java.lang.String
lovToJson(java.util.List<EnumItem> items)
List of values as JSONstatic java.lang.String
mapToJSON(java.util.Map<java.lang.String,java.lang.String> map)
Convert Map to JSONstatic java.lang.String
messageToJson(Grant g, java.lang.String msg, ObjectDB obj)
Convert a message to JSON { code, level, text, label, field }static java.lang.String
metadata(ObjectDB obj, int context, Parameters.ContextParam p, java.lang.String[] row)
static java.lang.String
metadata(ObjectDB obj, int context, Parameters.ContextParam p, java.lang.String[] row, boolean embedded, boolean init, boolean visibleOnly, java.lang.String edit)
static java.lang.String
objectFieldMetaDataToJson(Grant g, ObjectField field)
static java.lang.String
objectFieldMetaDataToJson(Grant g, ObjectField field, ObjectDB obj, int context, java.lang.String[] row, java.lang.String edit)
Field definitionstatic java.lang.String
objectMetaDataToJson(ObjectDB obj, int context, Parameters.ContextParam params, java.lang.String[] row, boolean init, boolean visibleOnly, java.lang.String edit)
static java.lang.String
prepareActionTarget(Action action)
static java.lang.String
prepareActionURL(ObjectDB obj, java.lang.String[] row, Action action)
static java.lang.String
printTemplateToJson(ObjectDB obj, java.lang.String[] row, PrintTemplate prt)
static java.lang.String
processMetadata(Processus pcs)
static java.lang.String
processMetadata(Processus pcs, boolean embedded)
static java.lang.String
processMetaDataToJson(Processus pcs)
static java.lang.String
resourcesToJson(java.util.List<Resource> resources)
static java.lang.String
resourceToJson(Resource r)
static java.lang.String
rowMetaDataToJson(ObjectDB obj, int context, Parameters.ContextParam p, java.lang.String[] row, boolean visibleOnly, java.lang.String edit)
Simplified meta for list rowsstatic void
savePreferences(ObjectDB obj, java.lang.String json)
static java.lang.String
socialCount(ObjectDB obj)
static java.lang.String
toJSONName(java.lang.String name)
Get JSON name (using Globals.DOT_REPLACEMENT as separator) from internal name (using dots as separator)static java.lang.String
toYAML(java.lang.String json)
Convert JSON string to YAML stringstatic java.lang.StringBuilder
toYAML(java.lang.StringBuilder json)
Convert JSON string builder to YAML string builderstatic java.lang.String
toYAML(org.json.JSONArray json)
Convert JSON array to YAMLstatic java.lang.String
toYAML(org.json.JSONObject json)
Convert JSON object to YAMLstatic java.lang.String
transitionMetaDataToJson(Grant g, Transition t)
static java.lang.String
viewMetadataToJson(Grant g, View view, ObjectDB parent, boolean home)
View metadata as JSON stringstatic java.lang.String
warning(java.lang.String message)
static java.lang.String
warnings(java.lang.String[] messages)
-
-
-
Field Detail
-
JSON_DOT_REPLACEMENT
@Deprecated public static final java.lang.String JSON_DOT_REPLACEMENT
Deprecated.- See Also:
- Constant Field Values
-
EMPTY_JSON_OBJECT
public static final java.lang.String EMPTY_JSON_OBJECT
Empty JSON object- See Also:
- Constant Field Values
-
EMPTY_JSON_ARRAY
public static final java.lang.String EMPTY_JSON_ARRAY
Empty JSON array- See Also:
- Constant Field Values
-
ERRLEVEL_FATAL
public static final int ERRLEVEL_FATAL
- See Also:
- Constant Field Values
-
ERRLEVEL_ERROR
public static final int ERRLEVEL_ERROR
- See Also:
- Constant Field Values
-
ERRLEVEL_WARNING
public static final int ERRLEVEL_WARNING
- See Also:
- Constant Field Values
-
OPENAPI_OAS2
public static final int OPENAPI_OAS2
OAS 2 (Swagger)- See Also:
- Constant Field Values
-
OPENAPI_OAS3
public static final int OPENAPI_OAS3
OAS 3 (OpenAPI)- See Also:
- Constant Field Values
-
OPENAPI_OAS2_VERSION
public static final java.lang.String OPENAPI_OAS2_VERSION
OAS 2 version string- See Also:
- Constant Field Values
-
OPENAPI_OAS3_VERSION
public static final java.lang.String OPENAPI_OAS3_VERSION
OAS 3 version string- See Also:
- Constant Field Values
-
-
Method Detail
-
toJSONName
public static java.lang.String toJSONName(java.lang.String name)
Get JSON name (using Globals.DOT_REPLACEMENT as separator) from internal name (using dots as separator)- Parameters:
name
- Internal name- Returns:
- JSON name
-
fromJSONName
public static java.lang.String fromJSONName(java.lang.String name)
Get internal name (using dots as separator) from JSON name (using Globals.DOT_REPLACEMENT as separator)- Parameters:
name
- JSON name- Returns:
- Internal name
-
jsonArray
public static java.lang.String jsonArray(java.lang.Object[] contents)
-
jsonArray
public static java.lang.String jsonArray(double[] vals)
-
jsonArray
public static java.lang.String jsonArray(java.lang.Double[] vals)
-
jsonArray
public static java.lang.String jsonArray(java.util.List<?> contents)
-
jsonString
public static java.lang.String jsonString(java.lang.Object str)
-
jsonStringArray
public static java.lang.String jsonStringArray(java.lang.Object[] strs)
-
jsonStringArray
public static java.lang.String jsonStringArray(java.util.List<?> contents)
-
jsonDeclaration
public static java.lang.String jsonDeclaration(ObjectField f)
-
jsonDeclaration
public static java.lang.String jsonDeclaration(ObjectField f, java.lang.Object value)
-
jsonDeclaration
public static java.lang.String jsonDeclaration(java.lang.String name, java.lang.Object content)
-
jsonDeclaration
public static java.lang.String jsonDeclaration(java.lang.String name, boolean content)
-
jsonDeclaration
public static java.lang.String jsonDeclaration(java.lang.String name, java.lang.Boolean content)
-
jsonDeclaration
public static java.lang.String jsonDeclaration(java.lang.String name, int content)
-
jsonDeclaration
public static java.lang.String jsonDeclaration(java.lang.String name, java.lang.Integer content)
-
jsonDeclaration
public static java.lang.String jsonDeclaration(java.lang.String name, long content)
-
jsonDeclaration
public static java.lang.String jsonDeclaration(java.lang.String name, java.lang.Long content)
-
jsonDeclaration
public static java.lang.String jsonDeclaration(java.lang.String name, float content)
-
jsonDeclaration
public static java.lang.String jsonDeclaration(java.lang.String name, java.lang.Float content)
-
jsonDeclaration
public static java.lang.String jsonDeclaration(java.lang.String name, double content)
-
jsonDeclaration
public static java.lang.String jsonDeclaration(java.lang.String name, java.lang.Double content)
-
jsonEnclosedDeclaration
public static java.lang.String jsonEnclosedDeclaration(java.lang.String name, java.lang.String content)
-
jsonDeclaration
public static java.lang.String jsonDeclaration(java.lang.String name, java.lang.String[] contents)
-
jsonDeclaration
public static java.lang.String jsonDeclaration(java.lang.String name, int[] contents)
-
jsonDeclaration
public static java.lang.String jsonDeclaration(java.lang.String name, long[] contents)
-
jsonDeclaration
public static java.lang.String jsonDeclaration(java.lang.String name, float[] contents)
-
jsonDeclaration
public static java.lang.String jsonDeclaration(java.lang.String name, double[] contents)
-
jsonEnclosedDeclaration
public static java.lang.String jsonEnclosedDeclaration(java.lang.String name, java.lang.String[] contents)
-
jsonDeclaration
public static java.lang.String jsonDeclaration(java.lang.String name, java.util.List<?> contents)
-
jsonEnclosedDeclaration
public static java.lang.String jsonEnclosedDeclaration(java.lang.String name, java.util.List<?> contents)
-
jsonStringDeclaration
public static java.lang.String jsonStringDeclaration(java.lang.String name, java.lang.Object content)
-
jsonEnclosedStringDeclaration
public static java.lang.String jsonEnclosedStringDeclaration(java.lang.String name, java.lang.String content)
-
jsonStringDeclaration
public static java.lang.String jsonStringDeclaration(java.lang.String name, java.lang.String[] contents)
-
jsonEnclosedStringDeclaration
public static java.lang.String jsonEnclosedStringDeclaration(java.lang.String name, java.lang.String[] contents)
-
jsonStringDeclaration
public static java.lang.String jsonStringDeclaration(java.lang.String name, java.util.List<?> contents)
-
jsonEnclosedStringDeclaration
public static java.lang.String jsonEnclosedStringDeclaration(java.lang.String name, java.util.List<?> contents)
-
jsonResponse
public static java.lang.String jsonResponse(java.lang.String type, java.lang.String response)
-
jsonResponse
public static java.lang.String jsonResponse(java.lang.String type, java.lang.String response, java.lang.String msg)
-
getResponse
public static org.json.JSONObject getResponse(java.lang.String type, java.lang.Object response)
Get response JSON object- Parameters:
type
- Response typeresponse
- Response
-
getResponse
public static org.json.JSONObject getResponse(java.lang.String type, java.lang.Object response, java.lang.String msg)
Get response JSON object- Parameters:
type
- Response typeresponse
- Responsemsg
- Message
-
info
public static java.lang.String info(java.lang.String message)
-
getInfo
public static org.json.JSONObject getInfo(java.lang.String message)
Get info response- Parameters:
message
- Info message
-
warning
public static java.lang.String warning(java.lang.String message)
-
getWarning
public static org.json.JSONObject getWarning(java.lang.String message)
Get warning response- Parameters:
message
- Warning message
-
warnings
public static java.lang.String warnings(java.lang.String[] messages)
-
getWarnings
public static org.json.JSONObject getWarnings(java.lang.String[] messages)
Get warnings response- Parameters:
messages
- Warning messages
-
error
public static java.lang.String error(java.lang.String message, int level)
Error response- Parameters:
message
- Error message or JSON objectlevel
- Error level
-
error
public static java.lang.String error(java.lang.String message, int level, java.lang.String metadata)
Error response- Parameters:
message
- Error message or JSON objectlevel
- Error levelmetadata
- Optional metadata
-
error
public static java.lang.String error(int status, java.lang.String message, int level, java.lang.String metadata)
Error response- Parameters:
status
- HTTP status value (e.g. 404)message
- Error message or JSON objectlevel
- Error levelmetadata
- Optional metadata
-
getError
public static org.json.JSONObject getError(java.lang.Object message, int level)
Get error response- Parameters:
message
- Error messagelevel
- Error level
-
getError
public static org.json.JSONObject getError(java.lang.Object message, int level, java.lang.Object metadata)
Get error response- Parameters:
message
- Error messagelevel
- Error levelmetadata
- Optional metadata
-
getError
public static org.json.JSONObject getError(int status, java.lang.Object message, int level, java.lang.Object metadata)
Get error response- Parameters:
status
- HTTP status value (e.g. 404)message
- Error messagelevel
- Error levelmetadata
- Optional metadata
-
errors
public static java.lang.String errors(java.lang.String[] messages, int level)
Errors response- Parameters:
messages
- Error messageslevel
- Errors level
-
errors
public static java.lang.String errors(java.lang.String[] messages, int level, java.lang.String metadata)
Errors response- Parameters:
messages
- Error messageslevel
- Errors levelmetadata
- Optional metadata
-
errors
public static java.lang.String errors(int status, java.lang.String[] messages, int level, java.lang.String metadata)
Errors response- Parameters:
status
- HTTP status value (e.g. 404)messages
- Error messageslevel
- Errors levelmetadata
- Optional metadata
-
getErrors
public static org.json.JSONObject getErrors(java.lang.Object[] messages, int level)
Get errors response- Parameters:
messages
- Error messageslevel
- Error level
-
getErrors
public static org.json.JSONObject getErrors(java.lang.Object[] messages, int level, java.lang.Object metadata)
Get errors response- Parameters:
messages
- Error messageslevel
- Error levelmetadata
- Optional metadata
-
getErrors
public static org.json.JSONObject getErrors(int status, java.lang.Object[] messages, int level, java.lang.Object metadata)
Get errors response- Parameters:
messages
- Error messageslevel
- Error levelmetadata
- Optional metadata
-
messageToJson
public static java.lang.String messageToJson(Grant g, java.lang.String msg, ObjectDB obj)
Convert a message to JSON { code, level, text, label, field }
-
resourceToJson
public static java.lang.String resourceToJson(Resource r)
-
resourcesToJson
public static java.lang.String resourcesToJson(java.util.List<Resource> resources)
-
objectFieldMetaDataToJson
public static java.lang.String objectFieldMetaDataToJson(Grant g, ObjectField field)
-
objectFieldMetaDataToJson
public static java.lang.String objectFieldMetaDataToJson(Grant g, ObjectField field, ObjectDB obj, int context, java.lang.String[] row, java.lang.String edit)
Field definition- Parameters:
g
- User rightsfield
- Fieldobj
- Optional objectcontext
- Object contextrow
- Current rowedit
- Optional edit list mode "new" or "rows"- Returns:
- JSON
-
initWebService
public static ObjectContextWeb initWebService(ObjectDB obj, int context, Parameters.ContextParam p, boolean apply, java.lang.String edit)
Prepare the object context for web service- Parameters:
obj
- Objectcontext
- Object contextp
- Optional context parametersapply
- true to apply init hook and user filtersedit
- optional edit mode- Returns:
- Object context
-
jsonUndoRedo
public static java.lang.String jsonUndoRedo(ObjectDB obj)
-
objectMetaDataToJson
public static java.lang.String objectMetaDataToJson(ObjectDB obj, int context, Parameters.ContextParam params, java.lang.String[] row, boolean init, boolean visibleOnly, java.lang.String edit)
-
rowMetaDataToJson
public static java.lang.String rowMetaDataToJson(ObjectDB obj, int context, Parameters.ContextParam p, java.lang.String[] row, boolean visibleOnly, java.lang.String edit)
Simplified meta for list rows
-
printTemplateToJson
public static java.lang.String printTemplateToJson(ObjectDB obj, java.lang.String[] row, PrintTemplate prt)
-
actionToJson
public static java.lang.String actionToJson(ObjectDB obj, Action action, java.lang.String[] row, boolean create, int context)
-
prepareActionURL
public static java.lang.String prepareActionURL(ObjectDB obj, java.lang.String[] row, Action action)
-
prepareActionTarget
public static java.lang.String prepareActionTarget(Action action)
-
filtersToJson
public static java.lang.String filtersToJson(ObjectDB obj, boolean reset, boolean limited)
JSON filters in service format- Parameters:
obj
- Objectreset
- Reset filters first ?limited
- get valued filter only ?- Returns:
- JSON
-
fieldValue
public static java.lang.String fieldValue(ObjectField field)
-
fieldValue
public static java.lang.String fieldValue(ObjectField field, java.lang.String value)
-
functIdToJson
public static java.lang.String functIdToJson(ObjectDB obj)
-
fieldsToJson
public static java.lang.String fieldsToJson(ObjectDB obj)
-
fieldsToJson
public static java.lang.String fieldsToJson(ObjectDB obj, Parameters.InlineParam inlines, java.lang.String[] fields, boolean onlyFunctIds, boolean timestamps)
-
listToJson
public static java.lang.String listToJson(ObjectDB obj, java.util.List<java.lang.String[]> list, Parameters.InlineParam inlines, int context, Parameters.ContextParam p, boolean metadata, boolean timestamp, boolean visibleOnly, java.lang.String edit)
-
groupByToJson
public static java.lang.String groupByToJson(ObjectDB obj, java.util.List<java.lang.String[]> list)
-
metadata
public static java.lang.String metadata(ObjectDB obj, int context, Parameters.ContextParam p, java.lang.String[] row)
-
metadata
public static java.lang.String metadata(ObjectDB obj, int context, Parameters.ContextParam p, java.lang.String[] row, boolean embedded, boolean init, boolean visibleOnly, java.lang.String edit)
-
filters
public static java.lang.String filters(ObjectDB obj, boolean reset)
-
filters
public static java.lang.String filters(ObjectDB obj, int context, boolean reset)
-
filters
public static java.lang.String filters(ObjectDB obj, int context, boolean reset, boolean embedded)
-
get
public static java.lang.String get(ObjectDB obj, java.lang.String rowId) throws GetException
Get object record as JSON- Parameters:
obj
- Business objectrowId
- Object row ID- Returns:
- JSON
- Throws:
GetException
- If get fails
-
get
public static java.lang.String get(ObjectDB obj, java.lang.String rowId, boolean embedded) throws GetException
Get object record as JSON- Parameters:
obj
- Business objectrowId
- Object row IDembedded
- True to return data without a json response container- Returns:
- JSON
- Throws:
GetException
- If get fails
-
get
public static java.lang.String get(ObjectDB obj, java.lang.String rowId, int context, java.lang.String[] fields, Parameters.InlineParam inlines, boolean embedded) throws GetException
Get object record as JSON- Parameters:
obj
- Business objectrowId
- Object row IDcontext
- Context (none, update, create...) from ObjectDB.CONTEXT_*fields
- Optional list of fields to return (default return all fields)inlines
- Options to return inlined documentsembedded
- True to return data without a json response container- Returns:
- JSON
- Throws:
GetException
- If get fails
-
get
@Deprecated public static java.lang.String get(ObjectDB obj, java.lang.String rowId, int context, boolean timestamps, java.lang.String[] fields, Parameters.InlineParam inlines, boolean embedded, boolean metadata, Parameters.ContextParam parent, boolean social, java.util.List<java.lang.String> msgs, TreeView tv, TreeView.TreeViewNode tvNode, int tvDepth) throws GetException
Deprecated.- Throws:
GetException
-
get
@Deprecated public static java.lang.String get(ObjectDB obj, java.lang.String rowId, int context, boolean timestamps, java.lang.String[] fields, Parameters.InlineParam inlines, boolean embedded, boolean metadata, Parameters.ContextParam parent, boolean social, boolean share, java.util.List<java.lang.String> msgs, TreeView tv, TreeView.TreeViewNode tvNode, int tvDepth) throws GetException
Deprecated.- Throws:
GetException
-
get
public static java.lang.String get(ObjectDB obj, java.lang.String rowId, int context, boolean timestamps, java.lang.String[] fields, Parameters.InlineParam inlines, boolean embedded, boolean metadata, Parameters.ContextParam parent, boolean social, boolean share, java.util.List<java.lang.String> msgs, Parameters.TreeviewParam tv) throws GetException
Get object record as JSON- Parameters:
obj
- Business objectrowId
- Object row IDcontext
- Context (none, update, create...) from ObjectDB.CONTEXT_*timestamps
- True to return the timestamps of recordfields
- Optional list of fields to return (default return all fields)inlines
- Options to return inlined documentsembedded
- True to return data without a json response containermetadata
- True to return metadata of object in that contextparent
- Optional parent object contextsocial
- True to count posts for this recordshare
- True to get social data to share for this recordmsgs
- Optional messages to returntv
- Optional treeview parameters to get a record tree- Returns:
- JSON
- Throws:
GetException
- If get fails
-
document
public static java.lang.String document(ObjectDB obj, java.lang.String rowId, java.lang.String field) throws GetException
- Throws:
GetException
-
document
public static java.lang.String document(ObjectDB obj, java.lang.String rowId, java.lang.String field, boolean embedded, boolean copy) throws GetException
- Throws:
GetException
-
list
public static java.lang.String list(ObjectDB obj, int context, Parameters.ContextParam p, int page, Parameters.InlineParam inlines, boolean embedded, boolean metadata, boolean historic, boolean totals, boolean social, boolean timestamp, boolean visibleOnly, java.lang.String edit, boolean groupby, boolean partial, int treeDepth)
-
count
public static java.lang.String count(ObjectDB obj)
-
count
public static java.lang.String count(ObjectDB obj, boolean metadata)
-
listTotals
public static java.lang.String listTotals(ObjectDB obj)
-
historic
public static java.lang.String historic(ObjectDB obj, int page)
-
socialCount
public static java.lang.String socialCount(ObjectDB obj)
-
processMetaDataToJson
public static java.lang.String processMetaDataToJson(Processus pcs)
-
activityMetaDataToJson
public static java.lang.String activityMetaDataToJson(Activity a)
-
transitionMetaDataToJson
public static java.lang.String transitionMetaDataToJson(Grant g, Transition t)
-
processMetadata
public static java.lang.String processMetadata(Processus pcs)
-
processMetadata
public static java.lang.String processMetadata(Processus pcs, boolean embedded)
-
activityDataToJson
public static java.lang.String activityDataToJson(Processus p, ActivityFile af, ObjectDB obj, boolean metadata)
-
activityData
public static java.lang.String activityData(Processus pcs, ActivityFile af, ObjectDB object)
-
activityData
public static java.lang.String activityData(Processus pcs, ActivityFile af, ObjectDB object, boolean metadata, boolean embedded)
-
indexMetaDataToJson
public static java.lang.String indexMetaDataToJson(Grant g)
Index metadata as JSON string- Parameters:
g
- Grant- Returns:
- JSON string
-
jsonSessionInfo
public static java.lang.String jsonSessionInfo(Grant g, javax.servlet.http.HttpSession session, boolean embedded)
Session info as JSON string{ login, id, timeout, created, lastaccess, expires, timezone, licensed, revision, authtoken }
- Parameters:
g
- Grantsession
- Sessionembedded
- Embedded ?- Returns:
- JSON string
-
jsonAppInfo
public static java.lang.String jsonAppInfo(Grant g, boolean embedded)
Application info as JSON string- Parameters:
g
- Grantembedded
- Embedded ?- Returns:
- JSON string
-
jsonSysInfo
public static java.lang.String jsonSysInfo(Grant g, boolean embedded)
System info as JSON string- Parameters:
g
- Grantembedded
- Embedded ?- Returns:
- JSON string
-
viewMetadataToJson
public static java.lang.String viewMetadataToJson(Grant g, View view, ObjectDB parent, boolean home)
View metadata as JSON string- Parameters:
g
- Grantview
- Viewparent
- Paren objecthome
- Home?- Returns:
- JSON string
-
jsonGrant
public static java.lang.String jsonGrant(Grant g, boolean inlinePicture, boolean web, boolean embedded)
Full grant data as JSON string- Parameters:
g
- GrantinlinePicture
- Inline picture content ?web
- Add user's menu, texts and system parameters ?embedded
- Embedded ?- Returns:
- JSON string
-
jsonGrant
public static java.lang.String jsonGrant(Grant g, boolean inlinePicture, boolean web, boolean texts, boolean embedded)
Full grant data as JSON string- Parameters:
g
- GrantinlinePicture
- Inline picture content ?web
- Add web menu, parameters... ?texts
- inline static TEXTs with web properties ?embedded
- Embedded ?- Returns:
- JSON string
-
jsonApps
public static java.lang.String jsonApps(Grant g)
Get home pages (scopes) as JSON string- Parameters:
g
- Grant- Returns:
- JSON string
-
jsonShortcuts
public static java.lang.String jsonShortcuts(Grant g)
Shortcuts as JSON string- Parameters:
g
- Grant- Returns:
- JSON string
-
jsonUser
public static java.lang.String jsonUser(Grant g, java.lang.String login, boolean inlinePicture, boolean embedded)
User as JSON string- Parameters:
g
- Grantlogin
- User logininlinePicture
- Inline picture content ?- Returns:
- JSON string
-
jsonListOfValue
public static java.lang.String jsonListOfValue(Grant g, java.lang.String name, boolean embedded)
List of values as JSON string- Parameters:
g
- Grantname
- List of value name- Returns:
- JSON string
-
lovToJson
public static java.lang.String lovToJson(java.util.List<EnumItem> items)
List of values as JSON- Parameters:
items
- Items- Returns:
- JSON
-
jsonGetSysParams
@Deprecated public static java.lang.String jsonGetSysParams(Grant g, boolean embedded)
Deprecated.Use getSysParams
-
getSysParams
public static org.json.JSONObject getSysParams(Grant g, boolean embedded)
Get all session system parameters as JSON oject- Parameters:
g
- Grant- Returns:
- JSON object
-
jsonGetSysParam
@Deprecated public static java.lang.String jsonGetSysParam(Grant g, java.lang.String name)
Deprecated.
-
getSysParam
public static org.json.JSONObject getSysParam(Grant g, java.lang.String name)
Get a single session system parameter as JSON
- Parameters:
g
- Grantname
- System parameter name- Returns:
- json
-
getSysParam
public static org.json.JSONObject getSysParam(Grant g, java.lang.String name, boolean force)
Get a single system parameter as JSON- Parameters:
g
- Grantname
- System parameter nameforce
- Force read system parameter (if false the session's value is returned)- Returns:
- JSON
-
jsonSetSysParam
public static java.lang.String jsonSetSysParam(Grant g, java.lang.String name, java.lang.String value, boolean save)
Set a session system parameter as JSON
- Parameters:
g
- Grantname
- System parameter namevalue
- System parameter value (remove if null)save
- Save as user system parameter- Returns:
- json
-
jsonText
public static java.lang.String jsonText(Grant g, java.lang.String code)
Text as JSON
- Parameters:
g
- Grantcode
- Text code
-
jsonTextsArray
public static java.lang.String jsonTextsArray(Grant g, java.lang.String regex)
All matching texts as a JSON array
- Parameters:
g
- Grantregex
- Filtering regex on codes- Returns:
- json array
-
jsonTexts
public static java.lang.String jsonTexts(Grant g)
All texts as JSON
- Parameters:
g
- Grant- Returns:
- json
-
getTexts
public static java.lang.String getTexts(Grant g)
Get all texts as a JSON object
- Parameters:
g
- Grant
-
getTexts
public static java.lang.String getTexts(Grant g, java.lang.String regex)
Get all matching texts as a JSON object
- Parameters:
g
- Grantregex
- Optional filtering regular expression on codes
-
jsonMenu
public static java.lang.String jsonMenu(Grant g, boolean embedded)
Menu as JSON
- Parameters:
g
- Grant- Returns:
- json
-
jsonPreferences
public static java.lang.String jsonPreferences(ObjectDB obj)
Object preferences- Parameters:
obj
- Business object- Returns:
- JSON
-
savePreferences
public static void savePreferences(ObjectDB obj, java.lang.String json)
-
listSocialPosts
public static java.lang.String listSocialPosts(Grant g, java.lang.String postId, java.lang.String object, java.lang.String rowId, int page, boolean act, boolean follow, boolean countersOnly, boolean audit, java.lang.String level)
Social as JSON
- Parameters:
postId
- Optional filterobject
- Optional filterrowId
- Optional filterpage
- Paginationact
- true to include activity messagesfollow
- true to get follower counterscountersOnly
- true to get counters onlyaudit
- true to get audit messageslevel
- optional filter on level- Returns:
- json { count, posted, page, list:[], follow:{followed, follower, requested} }
-
jsonFollow
public static java.lang.String jsonFollow(Grant g, SocialPost.Author a)
-
listFollows
public static java.lang.String listFollows(Grant g, java.lang.String status)
-
listAuthors
public static java.lang.String listAuthors(Grant g, java.lang.String req, java.lang.String object, boolean all)
-
jsonNews
public static java.lang.String jsonNews(Grant g, boolean inlineImages, boolean embedded)
News as JSON
- Parameters:
inlineImages
- Inline images contents ?embedded
- True to return data without a json response container- Returns:
- json
-
jsonDocument
public static java.lang.String jsonDocument(Grant g, java.lang.String docId, boolean inlineContent, boolean inlineThumbnail, boolean copy)
Builds a JSON object for document
- Parameters:
g
- GrantdocId
- Document IDinlineContent
- Include document content (base64 encoded string)inlineThumbnail
- Include document thumbnail content (base64 encoded string)- Returns:
- json
-
jsonMetaObject
public static java.lang.String jsonMetaObject(Grant g, java.lang.String val, Parameters.InlineParam inlines)
Builds a JSON object for a meta object value
- Parameters:
g
- Grantval
- Meta object valueinlines
- Inline documents options- Returns:
- json
-
jsonDocument
public static java.lang.String jsonDocument(Grant g, DocumentDB doc, boolean inlineContent, boolean inlineThumbnail, boolean copy)
Builds a JSON object for document
- Parameters:
g
- Grantdoc
- DocumentinlineContent
- Include document content (base64 encoded string)inlineThumbnail
- Inline document thumbnail content (base64 encoded string)copy
- Serialize for copy ?- Returns:
- json
-
jsonReadDocument
public static java.lang.String jsonReadDocument(Grant g, java.lang.String docId, boolean includeContent, boolean includeThumbnail)
Read document informations as JSON
- Parameters:
g
- GrantdocId
- Document IDincludeContent
- Include document content (base64 encoded string)includeThumbnail
- Include document thumbnail content (base64 encoded string)- Returns:
- json
-
jsonWriteDocument
public static java.lang.String jsonWriteDocument(Grant g, java.lang.String docId, java.lang.String name, java.lang.String path, java.lang.String content, java.lang.String object, java.lang.String field, java.lang.String rowId)
Write document
- Parameters:
g
- Grantname
- Document namecontent
- Document content (base64 encoded string)- Returns:
- json
-
jsonExtObject
public static java.lang.String jsonExtObject(Grant g, java.lang.String name)
External object meta data as JSON
- Parameters:
name
- External object name- Returns:
- json
-
JsonToXML
public static DataXML JsonToXML(org.json.JSONObject item)
Convert a JSON item to XML data set- Parameters:
item
- JSON object with fields
-
JsonToXML
public static DataXML JsonToXML(org.json.JSONObject item, org.json.JSONObject olditem, ObjectDB obj)
Convert a JSON item to XML data set- Parameters:
item
- JSON object with current field valuesolditem
- JSON object with old field valuesobj
- Optional to order fields
-
jsonObjectToMap
public static java.util.Map<java.lang.String,java.lang.Object> jsonObjectToMap(org.json.JSONObject object)
Convert JSONObject to plain Map
-
mapToJSON
public static java.lang.String mapToJSON(java.util.Map<java.lang.String,java.lang.String> map)
Convert Map to JSON
-
addOpenAPIParameterType
public static org.json.JSONObject addOpenAPIParameterType(org.json.JSONObject param, java.lang.String type, org.json.JSONArray values, int spec)
Add OpenAPI parameter type- Parameters:
param
- Parameter objecttype
- Typevalues
- Valuesspec
- OpenAPI specification- Returns:
- JSON object
-
addOpenAPIOperationType
public static org.json.JSONObject addOpenAPIOperationType(org.json.JSONObject operation, java.lang.String requestType, java.lang.String requestSchema, java.lang.String responseType, java.lang.String responseSchema, int[] errorStatuses, int spec)
Get OpenAPI operation types- Parameters:
operation
- OperationrequestType
- Request typerequestSchema
- Request schemaresponseType
- Response typeresponseSchema
- Response schemaerrorStatuses
- Error statusesspec
- OpenAPI specification- Returns:
- JSON object
-
addOpenAPIOperationTypes
public static org.json.JSONObject addOpenAPIOperationTypes(org.json.JSONObject operation, java.lang.String[] requestTypes, java.lang.String requestSchema, java.lang.String[] responseTypes, java.lang.String responseSchema, int[] errorStatuses, int spec)
Get OpenAPI operation types- Parameters:
operation
- OperationrequestTypes
- Request typesrequestSchema
- Request schemaresponseTypes
- Response typesresponseSchema
- Response schemaerrorStatuses
- Error statusesspec
- OpenAPI specification- Returns:
- JSON object
-
getOpenAPIRef
public static java.lang.String getOpenAPIRef(java.lang.String name, int spec)
Get OpenAPI reference- Parameters:
name
- Reference namespec
- OpenAPI specification- Returns:
- JSON object
-
getOpenAPIError
public static org.json.JSONObject getOpenAPIError(int code, int spec)
Get OpenAPI error- Parameters:
code
- Error codespec
- OpenAPI specification- Returns:
- JSON object
-
getOpenAPIInfo
public static org.json.JSONObject getOpenAPIInfo(java.lang.String title, java.lang.String desc, java.lang.String version, boolean license, boolean contact)
Get OpenAPI info- Parameters:
title
- Titledesc
- Descriptionversion
- Versionlicense
- License?contact
- Contact?- Returns:
- JSON object
-
addTag
public static org.json.JSONArray addTag(org.json.JSONArray tags, java.lang.String name, java.lang.String desc)
Add a tag- Parameters:
tags
- Tag list (or null)name
- Tag namedesc
- Tag description
-
getOpenAPISchema
public static org.json.JSONObject getOpenAPISchema(Grant g, int spec, org.json.JSONObject info, org.json.JSONArray tags, java.lang.String basePath, org.json.JSONObject paths, org.json.JSONObject schemas)
Get OpenAPI schema- Parameters:
g
- Grantspec
- OpenAPI specificationinfo
- Infotags
- TagsbasePath
- Base pathpaths
- Pathsschemas
- Schemas- Returns:
- JSON object
-
addLoginOpenAPIPath
public static org.json.JSONObject addLoginOpenAPIPath(org.json.JSONObject paths, int spec)
Add login service OpenAPI path description to paths- Parameters:
paths
- Pathsspec
- OpenAPI specification- Returns:
- JSONObject
-
addLogoutOpenAPIPath
public static org.json.JSONObject addLogoutOpenAPIPath(org.json.JSONObject paths, int spec)
Add logout service OpenAPI path description to paths- Parameters:
paths
- Pathsspec
- OpenAPI specification- Returns:
- JSONObject
-
addActionResultSchema
public static org.json.JSONObject addActionResultSchema(org.json.JSONObject schemas)
Add action result OpenAPI schemas description to schemas- Parameters:
schemas
- Schemas- Returns:
- JSONObject
-
addPublicationResultSchema
public static org.json.JSONObject addPublicationResultSchema(org.json.JSONObject schemas)
Add publication result OpenAPI schemas description to schemas- Parameters:
schemas
- Schemas- Returns:
- JSONObject
-
addTreeviewDataSchema
public static org.json.JSONObject addTreeviewDataSchema(org.json.JSONObject schemas)
Add treeview data OpenAPI schemas description to schemas- Parameters:
schemas
- Schemas- Returns:
- JSONObject
-
addErrorsSchema
public static org.json.JSONObject addErrorsSchema(org.json.JSONObject schemas)
Add error messages OpenAPI schemas description to schemas- Parameters:
schemas
- Schemas- Returns:
- JSONObject
-
addAppSessionOpenAPIPath
public static org.json.JSONObject addAppSessionOpenAPIPath(org.json.JSONObject paths, int spec)
Add application and session REST services OpenAPI paths description to paths- Parameters:
paths
- Pathsspec
- OpenAPI specification- Returns:
- JSONObject
-
addBusinessObjectOpenAPISchema
public static org.json.JSONObject addBusinessObjectOpenAPISchema(org.json.JSONObject schemas, ObjectDB obj, int spec)
Add business object REST services OpenAPI schema to schemas- Parameters:
schemas
- Schemasobj
- Business objectspec
- OpenAPI specification- Returns:
- Updated schemas
-
addBusinessObjectOpenAPIPath
public static org.json.JSONObject addBusinessObjectOpenAPIPath(org.json.JSONObject paths, ObjectDB obj, java.lang.String relPath, int spec)
Add business object REST services OpenAPI paths to paths- Parameters:
paths
- Pathsobj
- Business objectrelPath
- Relative path to base pathspec
- OpenAPI specification- Returns:
- Updated paths
-
getJSONSchema
public static org.json.JSONObject getJSONSchema(ObjectDB obj)
Get JSON Schema for specified object- Parameters:
obj
- Object- Returns:
- JSON schema
-
jsonTestData
public static java.lang.String jsonTestData(Grant g, java.lang.String obj, java.lang.String rowId) throws GrantException
Random data- Parameters:
g
- Grantobj
- Object namerowId
- Optional row ID- Throws:
GrantException
-
getJSONObjectFromXML
public static org.json.JSONObject getJSONObjectFromXML(java.lang.String xml)
Get JSON object from XML- Parameters:
xml
- XML string- Returns:
- JSON object or null if XML is not parseable as JSON object
-
getXMLFromJSONObject
public static java.lang.String getXMLFromJSONObject(org.json.JSONObject json)
Get XML from JSON objectL- Parameters:
json
- JSON object- Returns:
- XML string or null is JSON object is to parseable as XML
-
getJSONASCIILogo
public static java.lang.String getJSONASCIILogo(java.lang.String complement)
Get ASCII logo as JSON comments- Parameters:
complement
- Additonal string to append to logo
-
getYAMLASCIILogo
public static java.lang.String getYAMLASCIILogo(java.lang.String complement)
Get ASCII logo as YAML comments- Parameters:
complement
- Additonal string to append to logo
-
getYAMLProcessor
public static org.yaml.snakeyaml.Yaml getYAMLProcessor()
Get YAML processor
-
toYAML
public static java.lang.String toYAML(org.json.JSONObject json)
Convert JSON object to YAML- Parameters:
json
- JSON object- Returns:
- YAML string
-
toYAML
public static java.lang.String toYAML(org.json.JSONArray json)
Convert JSON array to YAML- Parameters:
json
- JSON array- Returns:
- YAML string
-
toYAML
public static java.lang.String toYAML(java.lang.String json)
Convert JSON string to YAML string- Parameters:
json
- JSON string- Returns:
- YAML string
-
toYAML
public static java.lang.StringBuilder toYAML(java.lang.StringBuilder json)
Convert JSON string builder to YAML string builder- Parameters:
json
- JSON string builder- Returns:
- YAML string builder
-
fromYAML
public static org.json.JSONObject fromYAML(java.lang.String yaml)
Convert YAML to JSON object- Parameters:
yaml
- YAML string- Returns:
- JSON object
-
-