Package org.jolokia.server.core.http

Interface BackChannel

All Known Implementing Classes:
ServletBackChannel
public interface BackChannel
Channel for talking back to the client.
Since:
07/07/15
Author:
roland

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CONTENT_TYPE
    Parameter specifying the content type of the backchannel
    static final String
    ENCODING
    Parameter speficying the encoding

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    Close the channel.
    OutputStream
    getOutputStream()
    Get the write for writing to the client
    boolean
    isClosed()
    Check whether the backchanel is closed
    void
    open(Map<String,?> pParams)
    Open the channel.

  • Field Details

  • Method Details

    • open

      void open(Map<String,?> pParams) throws IOException
      Open the channel. Note, that a channel which has been already closed cannot be reopened again.
      Parameters:
      pParams - params for opening the back channel. The following parameter keys should be use for opening:
      • backChannel.contentType - Content-Type to set on the backchannel
      • backChannel.encoding - Encoding used for the client communication
      Throws:
      IOException - if the channel was already closed

    • close

      void close()
      Close the channel. After this no write is allowed anymore

    • isClosed

      boolean isClosed()
      Check whether the backchanel is closed

    • getOutputStream

      OutputStream getOutputStream() throws IOException
      Get the write for writing to the client
      Returns:
      output stream for writing out the answer
      Throws:
      IOException - if the channel is already closed.