Package de.uplanet.lucy.server.connector

Interface IServerBridgeResponse

  • public interface IServerBridgeResponse

    • Method Detail

      • setStatus

        void setStatus​(int p_iStatus)
        Set the HTTP status and message.
        Parameters:
        p_iStatus - The HTTP status code.

      • getStatus

        int getStatus()
        Get the HTTP status.
        Returns:
        The HTTP status.

      • sendError

        void sendError​(int p_iStatus)
        throws IOException
        Sends an error response to the client using the specified HTTP status code and clears the output buffer.
        Parameters:
        p_iStatus - The HTTP status code.
        Throws:
        IOException - If an I/O error occurs.
        See Also:
        HttpServletResponse.sendError(int)

      • sendError

        void sendError​(int p_iStatus,
               String p_strMsg)
        throws IOException
        Sends an error response to the client using the specified HTTP status code and clears the output buffer.

        For more information see HttpServletResponse.sendError(int, String)

        Parameters:
        p_iStatus - The HTTP status code.
        p_strMsg - The message to be be included in the error page.
        Throws:
        IOException - If an I/O error occurs.
        See Also:
        HttpServletResponse.sendError(int, String)

      • sendRedirect

        void sendRedirect​(String p_strLocation)
           throws IOException
        Sends a temporary redirect response to the client using the specified redirect location URL. This method can accept relative URLs; the servlet container must convert the relative URL to an absolute URL before sending the response to the client. If the location is relative without a leading '/' the container interprets it as relative to the current request URI. If the location is relative with a leading '/' the container interprets it as relative to the servlet container root.
        Parameters:
        p_strLocation - The redirect location URL.
        Throws:
        IOException - If an I/O error occurred.
        IllegalStateException - If the response was committed or if a partial URL is given and cannot be converted into a valid URL

      • isCommitted

        boolean isCommitted()
        Returns a boolean indicating if the response has been committed. A committed response has already had its status code and headers written.
        Returns:
        A boolean indicating if the response has been committed.
        See Also:
        resetBuffer(), reset()

      • resetBuffer

        void resetBuffer()
        Clears the content of the underlying buffer in the response without clearing headers or status code. If the response has been committed, this method throws an IllegalStateException.
        Throws:
        IllegalStateException - If the response has already been committed.
        See Also:
        isCommitted()

      • reset

        void reset()
        Clears any data that exists in the response buffer as well as the status code and headers. Possibly set ignore-write flags on output streams are also reset to false.

        If the response has been committed, this method throws an IllegalStateException.

        Throws:
        IllegalStateException - If the response has already been committed.
        See Also:
        isCommitted()

      • setHeaderValue

        @Deprecated
void setHeaderValue​(String p_strKey,
                    String p_strValue)
        Deprecated.
        Use setHeader(String, String) instead.
        Set one name-value pair into the header map.
        Parameters:
        p_strKey - The header key.
        p_strValue - The header value.

      • getHeaderValue

        @Deprecated
String getHeaderValue​(String p_strKey)
        Deprecated.
        Use getHeader(String) instead.
        Get a header info value to a specified key.
        Parameters:
        p_strKey - The header info key.
        Returns:
        The header value.

      • getHeaderValueMap

        @Deprecated
Map<String,​String> getHeaderValueMap()
        Deprecated.
        Use getHeaderNames() and get the values with separate class to getHeader(String).
        Get an unmodifiable reference to the internal header map.

        Note: This method is for internal use only. It must not be used in scripts.

        Returns:
        An unmodifiable header map.

      • containsHeader

        boolean containsHeader​(String p_strName)
        Returns a boolean indicating whether the named response header has already been set.
        Parameters:
        p_strName - The header name.
        Returns:
        true if the named response header has already been set, or false otherwise.
        Since:
        Intrexx 9.5.

      • getHeader

        String getHeader​(String p_strName)
        Gets the value of the response header with the given name.

        If a response header with the given name exists and contains multiple values, the value that was added first will be returned.

        This method considers only response headers set or added via setHeader(String, String), addHeader(String, String), setDateHeader(String, long), addDateHeader(String, long), respectively.

        Parameters:
        p_strName - The name of the response header whose value to return.
        Returns:
        The value of the response header with the given name, or null if no header with the given name has been set on this response.
        Since:
        Intrexx 9.5.

      • setHeader

        void setHeader​(String p_strName,
               String p_strValue)
        Sets a response header with the given name and value. If the header had already been set, the new value overwrites the previous one. The containsHeader(String) method can be used to test for the presence of a header before setting its value.
        Parameters:
        p_strName - The name of the header.
        p_strValue - The header value If it contains octet string, it should be encoded according to RFC 2047.
        Since:
        Intrexx 9.5.
        See Also:
        containsHeader(String), addHeader(String, String)

      • addHeader

        void addHeader​(String p_strName,
               String p_strValue)
        Adds a response header with the given name and value. This method allows response headers to have multiple values.
        Parameters:
        p_strName - The name of the header.
        p_strValue - The header value If it contains octet string, it should be encoded according to RFC 2047.
        Since:
        Intrexx 9.5.
        See Also:
        setHeader(String, String)

      • setDateHeader

        void setDateHeader​(String p_strName,
                   long p_lDate)
        Sets a response header with the given name and date-value. The date is specified in terms of milliseconds since the epoch. If the header had already been set, the new value overwrites the previous one. The containsHeader(String) method can be used to test for the presence of a header before setting its value.
        Parameters:
        p_strName - The name of the header.
        p_lDate - The assigned date value.
        Since:
        Intrexx 9.5.
        See Also:
        containsHeader(String), addDateHeader(String, long)

      • addDateHeader

        void addDateHeader​(String p_strName,
                   long p_lDate)
        Adds a response header with the given name and date-value. The date is specified in terms of milliseconds since the epoch. This method allows response headers to have multiple values.
        Parameters:
        p_strName - The name of the header.
        p_lDate - The additional date value.
        Since:
        Intrexx 9.5.
        See Also:
        setDateHeader(String, long)

      • addCookie

        void addCookie​(de.uplanet.net.http.ICookie p_cookie)
        Add a cookie to the response or replace a cookie in the response.

        An already existing cookie is being replaced if it is considered equal according to RFC 2965, 3.3.3, ie.

        • it comes from same domain (case-insensitive),
        • has the same name (case-insensitive),
        • and has the same path (case-sensitive).

        Parameters:
        p_cookie - The cookie to be added.

      • getCookieList

        List<de.uplanet.net.http.ICookie> getCookieList()
        Get a reference to the internal cookie list.

        Note: This method is for internal use only. It must not be used in scripts.

        Returns:
        The cookie list.

      • getWriter

        Writer getWriter()
          throws IOException
        Get a writer to the underlying output stream with the given charset.
        Returns:
        The writer.
        Throws:
        IOException

      • setCharacterEncoding

        void setCharacterEncoding​(String p_strCharsetName)
        Sets the character encoding of the response being sent to the client.
        Parameters:
        p_strCharsetName - The name of the character encoding to be set.

      • getCharacterEncoding

        String getCharacterEncoding()
        Returns the name of the character encoding used for the body sent in this response.
        Returns:
        The name of the character encoding