Package com.simplicite.util.tools
Class Parameters
- java.lang.Object
-
- com.simplicite.util.tools.Parameters
-
- All Implemented Interfaces:
java.io.Serializable
- Direct Known Subclasses:
ServletParameters
public class Parameters extends java.lang.Object implements java.io.Serializable
Structure to store parameters- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Parameters.ContextParam
Context parametersstatic class
Parameters.DocParam
Document parameterstatic class
Parameters.InlineParam
Inlining parametersstatic class
Parameters.TreeviewParam
Treeview parameters
-
Constructor Summary
Constructors Constructor Description Parameters()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.String
getAcceptLanguage()
Get accept languagejava.lang.String
getBackLocation()
Get parameter back locationjava.lang.String
getBaseLocation()
Get base location URI (without query string)java.lang.String
getBaseURI()
Get base location URI (without query string, same as getBaseLocation)byte[]
getBody()
Get body as byte array (not applicable if multipart)boolean
getBooleanParameter(java.lang.String param)
Get simple boolean parameterboolean
getBooleanParameter(java.lang.String param, boolean defaultValue)
Get simple boolean parameter with default valuejava.lang.String
getCharset()
Get charsetjava.lang.String
getContentType()
Get content typeParameters.ContextParam
getContextParam()
Get context parametersjava.lang.String
getContextURL()
Get context URLjava.util.Map<java.lang.String,Parameters.DocParam>
getDocParameters()
Single document parametersParameters.DocParam
getDocument(java.lang.String param)
Get single document parameterjava.util.List<Parameters.DocParam>
getDocuments(java.lang.String param)
Get multi-documents parameterdouble
getDoubleParameter(java.lang.String param)
Get simple double parameterdouble
getDoubleParameter(java.lang.String param, double defaultValue)
Get simple double parameter or default valuelong
getElapsedTime()
Get elapsed time in msfloat
getFloatParameter(java.lang.String param)
Get simple float parameterfloat
getFloatParameter(java.lang.String param, float defaultValue)
Get simple float parameter with default valuejava.lang.String
getHeader(java.lang.String name)
Get specified header valuejava.util.Map<java.lang.String,java.lang.String>
getHeaders()
Get all headers as a mapint
getIntParameter(java.lang.String param)
Get simple int parameterint
getIntParameter(java.lang.String param, int defaultValue)
Get simple int parameter with default valueorg.json.JSONArray
getJSONArray()
Get body as JSONArray if applicable, null otherwiseorg.json.JSONObject
getJSONObject()
Get body as JSON object if applicable, null otherwisejava.lang.String
getLocation()
Get location URIjava.lang.String
getLocation(java.lang.String params)
Get location URI with additional URL-encoded parameters (var=value1[&var2=value2[...]])java.lang.String
getLocation(java.lang.String name, java.lang.String value)
Get location URI with an additional non URL-encoded parameterjava.lang.String
getLocation(java.util.Map<java.lang.String,java.lang.Object> params)
Get parameter target location with additional non URL-encoded parameters (provided as a names and values map)java.util.List<java.lang.String>
getLocationParts()
Get location URI partsjava.util.List<java.lang.String>
getLocationParts(java.lang.String startAfter)
Get location URI partsjava.lang.String
getLocationURL()
Get full URL location (including GET parameters)long
getLongParameter(java.lang.String param)
Get simple long parameterlong
getLongParameter(java.lang.String param, long defaultValue)
Get simple long parameter with default valuejava.lang.String
getMethod()
Get methodjava.util.Map<java.lang.String,java.util.List<Parameters.DocParam>>
getMultiDocParameters()
Multi-documents parametersjava.util.Map<java.lang.String,java.lang.String[]>
getMultiParameters()
All multi-valued parametersjava.lang.String
getParameter(java.lang.String param)
Get simple parameter valuejava.lang.String
getParameter(java.lang.String param, java.lang.String defaultValue)
Get simple parameter value with default value if not setjava.util.Map<java.lang.String,java.lang.String>
getParameters()
All mono-valued parametersjava.lang.String[]
getParameters(java.lang.String param)
Get multiple parameter valuesjava.lang.String[]
getParameters(java.lang.String param, java.lang.String[] defaultValues)
Get multiple parameter valuesParameters.ContextParam
getParentOrViewParameter()
Get parent or view context parametersParameters.ContextParam
getParentParameter()
Get parent context parameters to load parent, parent instance, parent field, parent row IDjava.lang.String[]
getPrefixParameterNames(java.lang.String prefix)
Get prefixed parameter namesjava.lang.String[]
getPrefixParameters(java.lang.String prefix)
Get prefixed parameter valuesjava.lang.String
getQueryString()
Get query stringjava.lang.String
getRoot()
Get parameter target root locationjava.lang.String
getRowId(ObjectDB obj)
Get object row ID field values from parameters (using actual object row ID name or, if not found, default row ID name)java.lang.String
getServerURL()
Get server URLParameters.TreeviewParam
getTreeViewParameter(TreeView tv, TreeView.TreeViewNode node)
Get treeview parametersjava.lang.String
getURI()
Get location URI (same as getLocation)java.util.List<java.lang.String>
getURIParts()
Get location URI parts (same as getLocationParts)java.util.List<java.lang.String>
getURIParts(java.lang.String startAfter)
Get location URI parts (same as getLocationParts)java.lang.String
getUserAgent()
Get user agentParameters.ContextParam
getViewParameter()
Get view context parametersboolean
has(java.lang.String name)
Check if a parameter for specified name existsboolean
hasDocParam(java.lang.String name)
Check if a document parameter for specified name existsboolean
hasFilterParam(java.lang.String name)
Check if a parameter for specified filter name existsboolean
hasFilterParam(java.lang.String name, boolean ordering)
Check if a parameter for specified filter name existsboolean
hasMultiParam(java.lang.String name)
Check if a multi-valued parameter for specified name existsboolean
hasParam(java.lang.String name)
Check if a mono-valued parameter for specified name existsboolean
hasPrefixParameters(java.lang.String prefix)
Has prefixed parameter valuesboolean
isBinaryRequest()
Is binary request content type?boolean
isDelete()
Is DELETE method?boolean
isDELETE()
Is DELETE method? (alias to isDelete)boolean
isFormURLEncodedRequest()
Is form URL encoded request content type?boolean
isGet()
Is GET method?boolean
isGET()
Is GET method (alias to isGet)boolean
isHead()
Is HEAD method?boolean
isHEAD()
Is HEAD method? (alias to isHead)boolean
isJSONRequest()
Is JSON body request content type?boolean
isPatch()
Is PATCH method?boolean
isPATCH()
Is PATCH method? (alias to isPatch)boolean
isPost()
Is POST method?boolean
isPOST()
Is POST method? (alias to isPost)boolean
isPut()
Is PUT method?boolean
isPUT()
Is PUT method? (alias to isPut)boolean
isURLFormEncodedRequest()
Deprecated, for removal: This API element is subject to removal in a future version.Use isFormURLEncodedRequestboolean
isXMLRequest()
Is XML body request content type?void
parseJSONBody()
void
remove(java.lang.String param)
Remove parametervoid
setAcceptLanguage(java.lang.String lang)
Set accept languagevoid
setBackLocation(java.lang.String location)
Set parameter previous locationvoid
setBody(byte[] body)
Set body as byte arrayvoid
setCharset(java.lang.String charset)
Set charsetvoid
setContentType(java.lang.String contentType)
Set content typevoid
setContextURL(java.lang.String contextURL)
Set context URLParameters.DocParam
setDocument(java.lang.String param, java.lang.String docId, java.lang.String path, byte[] data, java.io.InputStream is, boolean toDelete)
Add a document to parametervoid
setDocuments(java.lang.String param, java.util.List<Parameters.DocParam> docs)
Set multi-documents parametervoid
setHeader(java.lang.String name, java.lang.String value)
Set specified header valuevoid
setJSONArray(org.json.JSONArray jsonArray)
Set body as JSON arrayvoid
setJSONObject(org.json.JSONObject jsonObject)
Set body as JSON objectvoid
setLocation(java.lang.String location)
Set location URIvoid
setLocationURL(java.lang.String locationURL)
Set full URL location including GET parametersvoid
setMethod(java.lang.String method)
Set methodvoid
setParameter(java.lang.String param, java.lang.String value)
Set simple parametervoid
setParameters(java.lang.String param, java.lang.String[] values)
Set multiple parametervoid
setRoot(java.lang.String root)
Set parameter target root locationvoid
setServerURL(java.lang.String serverURL)
Set server URLvoid
setTime()
Set start timevoid
setUserAgent(java.lang.String userAgent)
Set user agentjava.lang.String
toJSON()
Get parameters as JSON stringorg.json.JSONObject
toJSONObject()
Get parameters as JSON objectjava.lang.String
toString()
Get parameters as string
-
-
-
Method Detail
-
getRoot
public java.lang.String getRoot()
Get parameter target root location- Returns:
- Root location
-
setRoot
public void setRoot(java.lang.String root)
Set parameter target root location- Parameters:
root
- Root location
-
getLocation
public java.lang.String getLocation()
Get location URI- Returns:
- Location URI
-
setLocation
public void setLocation(java.lang.String location)
Set location URI- Parameters:
location
- Location URI
-
getURI
public java.lang.String getURI()
Get location URI (same as getLocation)- Returns:
- Location URI
-
getBaseLocation
public java.lang.String getBaseLocation()
Get base location URI (without query string)- Returns:
- Base location URI
-
getBaseURI
public java.lang.String getBaseURI()
Get base location URI (without query string, same as getBaseLocation)- Returns:
- Base location URI
-
getLocation
public java.lang.String getLocation(java.lang.String params)
Get location URI with additional URL-encoded parameters (var=value1[&var2=value2[...]])- Parameters:
params
- URL-encoded parameters- Returns:
- Location URI with parameters
-
getLocation
public java.lang.String getLocation(java.lang.String name, java.lang.String value)
Get location URI with an additional non URL-encoded parameter- Parameters:
name
- Parameter namevalue
- Parameter value- Returns:
- Location URI with parameters
-
getLocation
public java.lang.String getLocation(java.util.Map<java.lang.String,java.lang.Object> params)
Get parameter target location with additional non URL-encoded parameters (provided as a names and values map)- Parameters:
params
- Parameters map- Returns:
- Location URI with parameters
-
getLocationParts
public java.util.List<java.lang.String> getLocationParts()
Get location URI parts- Returns:
- Location URI part list
-
getLocationParts
public java.util.List<java.lang.String> getLocationParts(java.lang.String startAfter)
Get location URI parts- Parameters:
startAfter
- Trim URI up to first occurence of specified part (e.g. if URI is /api/ext/test/1/list/test/2 and startAt is test only /1/list/test/2 is taken into account)- Returns:
- Location URI part list
-
getURIParts
public java.util.List<java.lang.String> getURIParts()
Get location URI parts (same as getLocationParts)- Returns:
- Location URI part list
-
getURIParts
public java.util.List<java.lang.String> getURIParts(java.lang.String startAfter)
Get location URI parts (same as getLocationParts)- Parameters:
startAfter
- Trim URI up to first occurence of specified part (e.g. if URI is /api/ext/test/1/list/test/2 and startAt is test only /1/list/test/2 is taken into account)- Returns:
- Location URI part list
-
getQueryString
public java.lang.String getQueryString()
Get query string- Returns:
- Query string
-
getMethod
public java.lang.String getMethod()
Get method- Returns:
- Method
-
setMethod
public void setMethod(java.lang.String method)
Set method- Parameters:
method
- Method
-
isHead
public boolean isHead()
Is HEAD method?- Returns:
- True if method is HEAD
-
isHEAD
public boolean isHEAD()
Is HEAD method? (alias to isHead)- Returns:
- True if method is HEAD
-
isGet
public boolean isGet()
Is GET method?- Returns:
- True if method is GET
-
isGET
public boolean isGET()
Is GET method (alias to isGet)- Returns:
- True if method is GET
-
isPost
public boolean isPost()
Is POST method?- Returns:
- True if method is POST
-
isPOST
public boolean isPOST()
Is POST method? (alias to isPost)- Returns:
- True if method is POST
-
isPut
public boolean isPut()
Is PUT method?- Returns:
- True if method is PUT
-
isPUT
public boolean isPUT()
Is PUT method? (alias to isPut)- Returns:
- True if method is PUT
-
isPatch
public boolean isPatch()
Is PATCH method?- Returns:
- True if method is PATCH
-
isPATCH
public boolean isPATCH()
Is PATCH method? (alias to isPatch)- Returns:
- True if method is PATCH
-
isDelete
public boolean isDelete()
Is DELETE method?- Returns:
- True if method is DELETE
-
isDELETE
public boolean isDELETE()
Is DELETE method? (alias to isDelete)- Returns:
- True if method is DELETE
-
getContentType
public java.lang.String getContentType()
Get content type- Returns:
- Content type
-
setContentType
public void setContentType(java.lang.String contentType)
Set content type- Parameters:
contentType
- Content type (one of HTTPTool.
-
isBinaryRequest
public boolean isBinaryRequest()
Is binary request content type?- Returns:
- True if request is of binary content type
-
isFormURLEncodedRequest
public boolean isFormURLEncodedRequest()
Is form URL encoded request content type?- Returns:
- True if request is of form URL encoded content type
-
isURLFormEncodedRequest
@Deprecated(forRemoval=true, since="4.0") public boolean isURLFormEncodedRequest()
Deprecated, for removal: This API element is subject to removal in a future version.Use isFormURLEncodedRequest
-
isJSONRequest
public boolean isJSONRequest()
Is JSON body request content type?- Returns:
- True if request is of JSON content type
-
isXMLRequest
public boolean isXMLRequest()
Is XML body request content type?- Returns:
- True if request is of XML content type
-
getCharset
public java.lang.String getCharset()
Get charset- Returns:
- Charset
-
setCharset
public void setCharset(java.lang.String charset)
Set charset- Parameters:
charset
- Charset
-
getUserAgent
public java.lang.String getUserAgent()
Get user agent- Returns:
- User agent
-
setUserAgent
public void setUserAgent(java.lang.String userAgent)
Set user agent- Parameters:
userAgent
- User agent
-
getAcceptLanguage
public java.lang.String getAcceptLanguage()
Get accept language- Returns:
- accept language (FRA ENU...)
-
setAcceptLanguage
public void setAcceptLanguage(java.lang.String lang)
Set accept language- Parameters:
lang
- User language FRA ENU...
-
getServerURL
public java.lang.String getServerURL()
Get server URL- Returns:
- Server URL
-
setServerURL
public void setServerURL(java.lang.String serverURL)
Set server URL- Parameters:
serverURL
- Server URL
-
getContextURL
public java.lang.String getContextURL()
Get context URL- Returns:
- Context URL
-
setContextURL
public void setContextURL(java.lang.String contextURL)
Set context URL- Parameters:
contextURL
- Context URL
-
getLocationURL
public java.lang.String getLocationURL()
Get full URL location (including GET parameters)- Returns:
- Location URL
-
setLocationURL
public void setLocationURL(java.lang.String locationURL)
Set full URL location including GET parameters- Parameters:
locationURL
- Location URL
-
getBackLocation
public java.lang.String getBackLocation()
Get parameter back location- Returns:
- Back location
-
setBackLocation
public void setBackLocation(java.lang.String location)
Set parameter previous location- Parameters:
location
- Back location
-
getHeaders
public java.util.Map<java.lang.String,java.lang.String> getHeaders()
Get all headers as a map- Returns:
- Parameters map
-
getHeader
public java.lang.String getHeader(java.lang.String name)
Get specified header value- Parameters:
name
- Header name- Returns:
- Header value
-
setHeader
public void setHeader(java.lang.String name, java.lang.String value)
Set specified header value- Parameters:
name
- Header namevalue
- Header value (null removes the header)
-
hasParam
public boolean hasParam(java.lang.String name)
Check if a mono-valued parameter for specified name exists
-
hasMultiParam
public boolean hasMultiParam(java.lang.String name)
Check if a multi-valued parameter for specified name exists
-
hasDocParam
public boolean hasDocParam(java.lang.String name)
Check if a document parameter for specified name exists
-
has
public boolean has(java.lang.String name)
Check if a parameter for specified name exists
-
hasFilterParam
public boolean hasFilterParam(java.lang.String name)
Check if a parameter for specified filter name exists
-
hasFilterParam
public boolean hasFilterParam(java.lang.String name, boolean ordering)
Check if a parameter for specified filter name exists
-
getParameters
public java.util.Map<java.lang.String,java.lang.String> getParameters()
All mono-valued parameters
-
getMultiParameters
public java.util.Map<java.lang.String,java.lang.String[]> getMultiParameters()
All multi-valued parameters
-
getDocParameters
public java.util.Map<java.lang.String,Parameters.DocParam> getDocParameters()
Single document parameters
-
getMultiDocParameters
public java.util.Map<java.lang.String,java.util.List<Parameters.DocParam>> getMultiDocParameters()
Multi-documents parameters
-
setParameter
public void setParameter(java.lang.String param, java.lang.String value)
Set simple parameter
-
setParameters
public void setParameters(java.lang.String param, java.lang.String[] values)
Set multiple parameter
-
setDocument
public Parameters.DocParam setDocument(java.lang.String param, java.lang.String docId, java.lang.String path, byte[] data, java.io.InputStream is, boolean toDelete) throws FileSizeException
Add a document to parameter- Parameters:
param
- Parameter namedocId
- Doc IDpath
- File path or namedata
- Explicit data (huge in heap)is
- Or optional Input stream to preserve heap sizetoDelete
- Flag to delete document on save- Returns:
- Document if less than limited size
- Throws:
FileSizeException
-
getParameter
public java.lang.String getParameter(java.lang.String param)
Get simple parameter value- Parameters:
param
- Parameter name- Returns:
- Parameter value or null
-
getParameter
public java.lang.String getParameter(java.lang.String param, java.lang.String defaultValue)
Get simple parameter value with default value if not set- Parameters:
param
- Parameter namedefaultValue
- Default value- Returns:
- Parameter value or default value
-
getParameters
public java.lang.String[] getParameters(java.lang.String param)
Get multiple parameter values- Parameters:
param
- Parameter name- Returns:
- Parameter values
-
getParameters
public java.lang.String[] getParameters(java.lang.String param, java.lang.String[] defaultValues)
Get multiple parameter values- Parameters:
param
- Parameter namedefaultValues
- Default values- Returns:
- Parameter values
-
getBooleanParameter
public boolean getBooleanParameter(java.lang.String param)
Get simple boolean parameter- Parameters:
param
- Parameter name- Returns:
- Parameter value or false
-
getBooleanParameter
public boolean getBooleanParameter(java.lang.String param, boolean defaultValue)
Get simple boolean parameter with default value- Parameters:
param
- Parameter namedefaultValue
- Default value- Returns:
- Parameter value or default value
-
getIntParameter
public int getIntParameter(java.lang.String param)
Get simple int parameter- Parameters:
param
- Parameter name- Returns:
- Parameter value or 0
-
getIntParameter
public int getIntParameter(java.lang.String param, int defaultValue)
Get simple int parameter with default value- Parameters:
param
- Parameter namedefaultValue
- Default value- Returns:
- Parameter value or default value
-
getLongParameter
public long getLongParameter(java.lang.String param)
Get simple long parameter- Parameters:
param
- Parameter name- Returns:
- Parameter value or 0
-
getLongParameter
public long getLongParameter(java.lang.String param, long defaultValue)
Get simple long parameter with default value- Parameters:
param
- Parameter namedefaultValue
- Default value- Returns:
- Parameter value or default value
-
getFloatParameter
public float getFloatParameter(java.lang.String param)
Get simple float parameter- Parameters:
param
- Parameter name- Returns:
- Parameter value or 0
-
getFloatParameter
public float getFloatParameter(java.lang.String param, float defaultValue)
Get simple float parameter with default value- Parameters:
param
- Parameter namedefaultValue
- Default value- Returns:
- Parameter value or default value
-
getDoubleParameter
public double getDoubleParameter(java.lang.String param)
Get simple double parameter- Parameters:
param
- Parameter name- Returns:
- Parameter value or 0
-
getDoubleParameter
public double getDoubleParameter(java.lang.String param, double defaultValue)
Get simple double parameter or default value- Parameters:
param
- Parameter namedefaultValue
- Default value- Returns:
- Parameter value or default value
-
getContextParam
public Parameters.ContextParam getContextParam()
Get context parameters- Returns:
- Context parameters
-
getParentParameter
public Parameters.ContextParam getParentParameter()
Get parent context parameters to load parent, parent instance, parent field, parent row ID- Returns:
- Parent context parameters
-
getViewParameter
public Parameters.ContextParam getViewParameter()
Get view context parameters- Returns:
- View parameters
-
getParentOrViewParameter
public Parameters.ContextParam getParentOrViewParameter()
Get parent or view context parameters- Returns:
- Parent or view context parameters
-
getTreeViewParameter
public Parameters.TreeviewParam getTreeViewParameter(TreeView tv, TreeView.TreeViewNode node)
Get treeview parameters- Parameters:
tv
- Treeviewnode
- Node- Returns:
- Treeview parameters
-
getPrefixParameterNames
public java.lang.String[] getPrefixParameterNames(java.lang.String prefix)
Get prefixed parameter names
-
hasPrefixParameters
public boolean hasPrefixParameters(java.lang.String prefix)
Has prefixed parameter values
-
getPrefixParameters
public java.lang.String[] getPrefixParameters(java.lang.String prefix)
Get prefixed parameter values
-
getDocument
public Parameters.DocParam getDocument(java.lang.String param)
Get single document parameter- Parameters:
param
- Parameter name- Returns:
- Document parameter
-
getDocuments
public java.util.List<Parameters.DocParam> getDocuments(java.lang.String param)
Get multi-documents parameter- Parameters:
param
- Parameter name- Returns:
- Document parameter
-
setDocuments
public void setDocuments(java.lang.String param, java.util.List<Parameters.DocParam> docs)
Set multi-documents parameter- Parameters:
param
- Parameter namedocs
- Documents parameter
-
remove
public void remove(java.lang.String param)
Remove parameter- Parameters:
param
- Parameter name
-
getBody
public byte[] getBody()
Get body as byte array (not applicable if multipart)- Returns:
- Body as byte array
-
setBody
public void setBody(byte[] body)
Set body as byte array- Parameters:
body
- Body as byte array
-
getJSONObject
public org.json.JSONObject getJSONObject()
Get body as JSON object if applicable, null otherwise- Returns:
- JSON object or null
-
setJSONObject
public void setJSONObject(org.json.JSONObject jsonObject)
Set body as JSON object- Parameters:
jsonObject
- JSON object
-
getJSONArray
public org.json.JSONArray getJSONArray()
Get body as JSONArray if applicable, null otherwise- Returns:
- JSON array or null
-
setJSONArray
public void setJSONArray(org.json.JSONArray jsonArray)
Set body as JSON array- Parameters:
jsonArray
- JSON array
-
setTime
public void setTime()
Set start time
-
getRowId
public java.lang.String getRowId(ObjectDB obj)
Get object row ID field values from parameters (using actual object row ID name or, if not found, default row ID name)
- Parameters:
obj
- Object (can be null, then look for actual object row ID name is - obviously - skipped)
-
getElapsedTime
public long getElapsedTime()
Get elapsed time in ms- Returns:
- Elapsed time
-
parseJSONBody
public void parseJSONBody()
-
toString
public java.lang.String toString()
Get parameters as string- Overrides:
toString
in classjava.lang.Object
- Returns:
- Parameters as string
-
toJSONObject
public org.json.JSONObject toJSONObject()
Get parameters as JSON object- Returns:
- Parameters as JSON object
-
toJSON
public java.lang.String toJSON()
Get parameters as JSON string- Returns:
- Parameters as JSON object
-
-