Package de.aristaflow.adept2.ui.htmlgui

Class HTMLContext.Response

  • Enclosing interface:
    HTMLContext
    public static class HTMLContext.Response
extends Object
    A HTTP-response to be sent to the HTTP-client.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  HTMLContext.Response.MimeType
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use MediaType and MediaTypes instead.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected InputStream data
      Data of the response, may be null.
      protected Map<String,​String> header
      Headers for the HTTP response.
      protected String mimeType
      MIME type of content, e.g.
      protected int status
      HTTP status code after processing, e.g. "200 OK", HTTP_OK

    • Constructor Summary

      Constructors 
      Constructor Description
      Response​(int status, InputStream data)
      Creates a response with the designated status and the designated data.
      Response​(int status, InputStream data, String fileName)
      Creates a response with the designated status and the designated data.
      Response​(int status, String txt)
      Creates a response with the designated status and the designated UTF-8-encoded plain text.
      Response​(int status, String origMimeType, InputStream data)
      Creates a new HTTP-response with the designated status, MIME-type and data.
      Response​(int status, String mimeType, String txt)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use Response(int, String) instead.
      Response​(int status, org.apache.tika.mime.MediaType mediaType, InputStream data)
      Creates a response with the designated status and the designated data using the designated media type.
      Response​(int status, org.apache.tika.mime.MediaType mediaType, String txt)
      Creates a response with the designated status and the designated text using the designated media type.

    • Field Detail

      • status

        protected final int status
        HTTP status code after processing, e.g. "200 OK", HTTP_OK

      • mimeType

        protected final String mimeType
        MIME type of content, e.g. "text/html".

      • data

        protected final InputStream data
        Data of the response, may be null.

      • header

        protected final Map<String,​String> header
        Headers for the HTTP response. Use addHeader() to add lines.

    • Constructor Detail

      • Response

        public Response​(int status,
                String txt)
        Creates a response with the designated status and the designated UTF-8-encoded plain text.
        Parameters:
        status - The HTTP-status of the response to create.
        txt - The string which to send as UTF-8-encoded plain text.

      • Response

        @Deprecated(since="14.0.0",
            forRemoval=true)
public Response​(int status,
                String mimeType,
                String txt)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use Response(int, String) instead.
        Creates a response with the designated status and the designated text using the designated MIME type.
        Parameters:
        status - The HTTP-status of the response to create.
        mimeType - The MIME-type of the HTTP-response to create.
        txt - The string which to send as UTF-8-encoded plain text.

      • Response

        public Response​(int status,
                org.apache.tika.mime.MediaType mediaType,
                String txt)
        Creates a response with the designated status and the designated text using the designated media type.
        Parameters:
        status - The HTTP-status of the response to create.
        mediaType - The media type of the HTTP-response to create. This may be null.
        txt - The string which to send as UTF-8-encoded plain text.

      • Response

        public Response​(int status,
                InputStream data)
        Creates a response with the designated status and the designated data. The MIME type is determined from the data.
        Parameters:
        status - The HTTP-status of the response to create.
        data - The contents of the HTTP-response to create. If this stream does not support marking, it may be copied in memory or to a temporary file!

      • Response

        public Response​(int status,
                InputStream data,
                String fileName)
        Creates a response with the designated status and the designated data. The MIME type is determined from the data and/or the designated file name.
        Parameters:
        status - The HTTP-status of the response to create.
        data - The contents of the HTTP-response to create. If this stream does not support marking, it may be copied in memory or to a temporary file!
        fileName - The name of the file the designated data represents. This is used to determine the MIME type. It may be null.

      • Response

        public Response​(int status,
                String origMimeType,
                InputStream data)
        Creates a new HTTP-response with the designated status, MIME-type and data.
        Parameters:
        status - The HTTP-status of the response to create.
        origMimeType - The MIME-type of the HTTP-response to create. If this is null, the MIME type will be determined from the designated data.
        data - The contents of the HTTP-response to create. If this stream does not support marking, it may be copied in memory or to a temporary file!

      • Response

        public Response​(int status,
                org.apache.tika.mime.MediaType mediaType,
                InputStream data)
        Creates a response with the designated status and the designated data using the designated media type. The caller has to make sure that this corresponds to the data.
        Parameters:
        status - The HTTP-status of the response to create.
        mediaType - The media type of the designated data. If this is null, the media type will be determined from the designated data. If this stream does not support marking, it may be copied in memory or to a temporary file!
        data - The contents of the HTTP-response to create.

    • Method Detail

      • addHeader

        public void addHeader​(String name,
                      String value)
        Adds the designated line to the header of this HTTP-response.
        Parameters:
        name - The name of the header-field to add to this HTTP-response.
        value - The value of the header-field to add to this HTTP-response.

      • getStatus

        public int getStatus()
        Return the HTTP status code of the response.
        Returns:
        The HTTP status code of the response.

      • getMimeType

        public String getMimeType()
        Returns the mime type of the response.
        Returns:
        The mime type of the response.

      • getData

        public InputStream getData()
        Returns the response data.
        Returns:
        The response data.

      • getHeader

        public Map<String,​String> getHeader()
        Returns the additional response headers.
        Returns:
        Additional response headers.