Class 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
    • Constructor Summary

      Constructors 
      Constructor Description
      Parameters()  
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.String getBackLocation()
      Get parameter back location
      java.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 parameter
      boolean getBooleanParameter​(java.lang.String param, boolean def)
      Get simple boolean parameter with default value
      java.lang.String getCharset()
      Get charset
      java.lang.String getContentType()
      Get content type
      Parameters.ContextParam getContextParam()
      Get context parameters
      java.lang.String getContextURL()
      Get context URL
      java.util.Map<java.lang.String,​Parameters.DocParam> getDocParameters()
      All document parameters
      Parameters.DocParam getDocument​(java.lang.String param)
      Get document parameter
      double getDoubleParameter​(java.lang.String param)
      Get simple double parameter
      double getDoubleParameter​(java.lang.String param, double def)
      Get simple double parameter or default value
      long getElapsedTime()
      Get elapsed time in ms
      float getFloatParameter​(java.lang.String param)
      Get simple float parameter
      float getFloatParameter​(java.lang.String param, float def)
      Get simple float parameter with default value
      java.lang.String getHeader​(java.lang.String name)
      Get specified header value
      java.util.Map<java.lang.String,​java.lang.String> getHeaders()
      Get all headers as a map
      int getIntParameter​(java.lang.String param)
      Get simple int parameter
      int getIntParameter​(java.lang.String param, int def)
      Get simple int parameter with default value
      org.json.JSONArray getJSONArray()
      Get body as JSONArray if applicable, null otherwise
      org.json.JSONObject getJSONObject()
      Get body as JSON object if applicable, null otherwise
      java.lang.String getLocation()
      Get location URI
      java.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 parameter
      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)
      java.util.List<java.lang.String> getLocationParts()
      Get location URI parts
      java.util.List<java.lang.String> getLocationParts​(java.lang.String startAfter)
      Get location URI parts
      java.lang.String getLocationURL()
      Get full URL location (including GET parameters)
      long getLongParameter​(java.lang.String param)
      Get simple long parameter
      long getLongParameter​(java.lang.String param, long def)
      Get simple long parameter with default value
      java.lang.String getMethod()
      Get method
      java.util.Map<java.lang.String,​java.lang.String[]> getMultiParameters()
      All multi-valued parameters
      java.lang.String getParameter​(java.lang.String param)
      Get simple parameter value
      java.lang.String getParameter​(java.lang.String param, java.lang.String defaultValue)
      Get simple parameter value with default value if not set
      java.util.Map<java.lang.String,​java.lang.String> getParameters()
      All mono-valued parameters
      java.lang.String[] getParameters​(java.lang.String param)
      Get multiple parameter values
      Parameters.ContextParam getParentOrViewParameter()
      Get parent or view context parameters
      Parameters.ContextParam getParentParameter()
      Get parent context parameters to load parent, parent instance, parent field, parent row ID
      java.lang.String[] getPrefixParameterNames​(java.lang.String prefix)
      Get prefixed parameter names
      java.lang.String[] getPrefixParameters​(java.lang.String prefix)
      Get prefixed parameter values
      java.lang.String getQueryString()
      Get query string
      java.lang.String getRoot()
      Get parameter target root location
      java.lang.String getServerURL()
      Get server URL
      Parameters.TreeviewParam getTreeViewParameter​(TreeView tv, TreeView.TreeViewNode node)
      Get treeview parameters
      java.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 agent
      Parameters.ContextParam getViewParameter()
      Get view context parameters
      boolean has​(java.lang.String name)
      Check if a parameter for specified name exists
      boolean hasDocParam​(java.lang.String name)
      Check if a document parameter for specified name exists
      boolean hasFilterParam​(java.lang.String name)
      Check if a parameter for specified filter name exists
      boolean hasFilterParam​(java.lang.String name, boolean ordering)
      Check if a parameter for specified filter name exists
      boolean hasMultiParam​(java.lang.String name)
      Check if a multi-valued parameter for specified name exists
      boolean hasParam​(java.lang.String name)
      Check if a mono-valued parameter for specified name exists
      boolean hasPrefixParameters​(java.lang.String prefix)
      Has prefixed parameter values
      boolean 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.
      Use isFormURLEncodedRequest
      boolean isXMLRequest()
      Is XML body request content type?
      void remove​(java.lang.String param)
      Remove parameter
      void setBackLocation​(java.lang.String location)
      Set parameter previous location
      void setBody​(byte[] body)
      Set body as byte array
      void setCharset​(java.lang.String charset)
      Set charset
      void setContentType​(java.lang.String contentType)
      Set content type
      void setContextURL​(java.lang.String contextURL)
      Set context URL
      Parameters.DocParam setDocument​(java.lang.String param, java.lang.String path, byte[] data, java.io.InputStream is)
      Set a simple document
      void setJSONArray​(org.json.JSONArray jsonArray)
      Set body as JSON array
      void setJSONObject​(org.json.JSONObject jsonObject)
      Set body as JSON object
      void setLocation​(java.lang.String location)
      Set location URI
      void setLocationURL​(java.lang.String locationURL)
      Set full URL location including GET parameters
      void setMethod​(java.lang.String method)
      Set method
      void setParameter​(java.lang.String param, java.lang.String value)
      Set simple parameter
      void setParameters​(java.lang.String param, java.lang.String[] values)
      Set multiple parameter
      void setRoot​(java.lang.String root)
      Set parameter target root location
      void setServerURL​(java.lang.String serverURL)
      Set server URL
      void setTime()
      Set start time
      void setUserAgent​(java.lang.String userAgent)
      Set user agent
      java.lang.String toJSON()
      Get parameters as JSON string
      org.json.JSONObject toJSONObject()
      Get parameters as JSON object
      java.lang.String toString()
      Get parameters as string
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • Parameters

        public Parameters()
    • 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 name
        value - 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
        public boolean isURLFormEncodedRequest()
        Deprecated.
        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
      • 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
      • 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()
        All document 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 path,
                                               byte[] data,
                                               java.io.InputStream is)
                                        throws FileSizeException
        Set a simple document
        Parameters:
        param - Parameter name
        path - File path or name
        data - Explicit data (huge in heap)
        is - Or optional Input stream to preserve heap size
        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 name
        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
      • 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 def)
        Get simple boolean parameter with default value
        Parameters:
        param - Parameter name
        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 def)
        Get simple int parameter with default value
        Parameters:
        param - Parameter name
        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 def)
        Get simple long parameter with default value
        Parameters:
        param - Parameter name
        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 def)
        Get simple float parameter with default value
        Parameters:
        param - Parameter name
        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 def)
        Get simple double parameter or default value
        Parameters:
        param - Parameter name
        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
      • 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 document parameter
        Parameters:
        param - Parameter name
        Returns:
        Document 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
      • getElapsedTime

        public long getElapsedTime()
        Get elapsed time in ms
        Returns:
        Elapsed time
      • toString

        public java.lang.String toString()
        Get parameters as string
        Overrides:
        toString in class java.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