Package de.xima.fc.interfaces.plugin.param.servlet

Interface IPluginServletActionParams

    • Method Detail

      • getSessionAttributeMap

        Map<String,​Serializable> getSessionAttributeMap()
        Gets the values from the current HttpSession. The servlet plugin may be executed on a different server that does not have direct access to the HTTP request: Please note that changes to this map are NOT reflected or saved in the HttpSession. To modify the session attributes, use the IPluginServletActionRetVal.getSessionAttributeMap() return value.
        Returns:
        A map Map with all attributes of the current HttpSession.
        Since:
        5.0

      • getUser

        IUser getUser()
        Returns:
        the user who called the servlet action plugin.
        Since:
        8.0.0

      • getRequestParameters

        Map<String,​List<String>> getRequestParameters()
        The parameters from the HTTP request. This includes both URL parameters as well as POST parameters, but excluded uploaded files. Please note that multiple values may have been given for a URL or POST parameter, eg. http://example.com?foo=bar&foo=baz. Also, for some HTTP methods such as EServletAction.DELETE, you may have to parse the HTTP request body yourself.
        Returns:
        A Map with the parameters from the HttpServletRequest.
        See Also:
        getUploadFiles()

      • getUploadFiles

        Map<String,​List<FileData>> getUploadFiles()
        Returns:
        A Map between the name of an upload form element and the file(s) that were uploaded for that upload element.

      • getLocale

        Locale getLocale()
        Returns:
        The current Locale of the request; or the default locale in case no locale could be determined.

      • getAction

        EServletAction getAction()
        Returns:
        The HTTP method of the servlet request.

      • getHeaderMap

        Map<String,​String> getHeaderMap()
        Returns:
        A Map that contains the HTTP header parameters. The map is case-insensitive, i.e. you can access a header with the key "Content-Type" as well as "content-type" etc.

      • getFrontendServer

        FrontendServer getFrontendServer()
        Returns:
        The current FrontendServer to which the servlet request was made, or null if the request was made directly to the master server.

      • getSessionID

        String getSessionID()
        Returns:
        The session ID for the user who is currently logged in; or null in case no session ID is available (which may happen, for example, when the user is not logged in).
        Since:
        5.1.0

      • getPluginClient

        Mandant getPluginClient()
        Returns:
        The Mandant to which the servlet action plugin belongs to; or null in case the plugin was installed as a system plugin and no client was provided in the servlet action URL.
        Since:
        5.1.0

      • getFrqSessionAttributes

        Map<Serializable,​Serializable> getFrqSessionAttributes()
        Gets the values stored in the current FRQSession. The servlet plugin may be executed on a different server that does not have direct access to the HTTP request: Please note that changes to this map are NOT reflected or saved in the FRQSession. To modify the FRQ session attributes, use the IPluginServletActionRetVal.getFrqSessionAttributeMap() return value.
        Returns:
        Attributes from the form request session of the current request. If no such session exists, this is an empty map.
        Since:
        7.0.13
        See Also:
        getFrqSessionId()

      • getFrqSessionId

        String getFrqSessionId()
        Gets the ID of the current form request session, if such a session exists.
        Returns:
        The ID of the current FRQ (form request) session, if such a session exists.
        Since:
        8.0.0
        See Also:
        getFrqSessionAttributes()

      • getRequestUri

        String getRequestUri()
        Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request. The web container does not decode this String. For example:
        First line of HTTP request Returned Value
        POST /some/path.html HTTP/1.1 /some/path.html
        GET http://foo.bar/a.html HTTP/1.0 /a.html
        HEAD /xyz?a=b HTTP/1.1 /xyz

        To reconstruct an URL with a scheme and host, use HttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest).

        Returns:
        a String containing the part of the URL from the protocol name up to the query string
        Since:
        8.0.0
        See Also:
        HttpServletRequest.getRequestURI()

      • getRequestUrl

        String getRequestUrl()
        Reconstructs the URL the client used to make the request. The returned URL contains a protocol, server name, port number, and server path, but it does not include query string parameters.

        If this request has been forwarded using RequestDispatcher.forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse), the server path in the reconstructed URL must reflect the path used to obtain the RequestDispatcher, and not the server path specified by the client.

        Returns:
        a StringBuffer object containing the reconstructed URL
        Since:
        8.0.0
        See Also:
        HttpServletRequest.getRequestURL()

      • getContextPath

        String getContextPath()
        Returns the portion of the request URI that indicates the context of the request. The context path always comes first in a request URI. The path starts with a "/" character but does not end with a "/" character. For servlets in the default (root) context, this method returns "". The container does not decode this string.

        It is possible that a servlet container may match a context by more than one context path. In such cases this method will return the actual context path used by the request and it may differ from the path returned by the ServletContext.getContextPath() method. The context path returned by ServletContext.getContextPath() should be considered as the prime or preferred context path of the application.

        Returns:
        a String specifying the portion of the request URI that indicates the context of the request
        Since:
        8.0.0
        See Also:
        HttpServletRequest.getContextPath()

      • getBaseUrl

        String getBaseUrl()
        Returns the HTTP request base URL. This is the URL from the scheme, domain until with context path, including the trailing slash. This is the value you could use in HTML <base> tag in an XHTML view.
        Returns:
        The HTTP request base URL.
        Since:
        8.0.0
        See Also:
        HttpServletRequest.getRequestURI(), HttpServletRequest.getRequestURL(), HttpServletRequest.getContextPath()

      • getRemoteAddr

        String getRemoteAddr()
        Returns the Internet Protocol (IP) address of the client that sent the request. This will first check the Forwarded and X-Forwarded-For request headers and if any is present, then return its first IP address, else just return ServletRequest.getRemoteAddr() unmodified.
        Returns:
        The IP address of the client.
        Since:
        8.0.0
        See Also:
        ServletRequest.getRemoteAddr()