Interface LogStream

  • All Superinterfaces:
    java.lang.AutoCloseable, java.io.Closeable, java.util.Iterator<LogMessage>
    All Known Implementing Classes:
    DefaultLogStream

    public interface LogStream
    extends java.util.Iterator<LogMessage>, java.io.Closeable
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void attach​(java.io.OutputStream stdout, java.io.OutputStream stderr)
      Attaches two OutputStreams to the LogStream.
      void attach​(java.io.OutputStream stdout, java.io.OutputStream stderr, boolean closeAtEof)
      Attaches two OutputStreams to the LogStream.
      void close()
      Redefine to not throw checked exceptions.
      java.lang.String readFully()  
      • Methods inherited from interface java.util.Iterator

        forEachRemaining, hasNext, next, remove
    • Method Detail

      • readFully

        java.lang.String readFully()
      • attach

        void attach​(java.io.OutputStream stdout,
                    java.io.OutputStream stderr)
             throws java.io.IOException
        Attaches two OutputStreams to the LogStream. Closes the streams after use.
        Parameters:
        stdout - OutputStream for the standard out
        stderr - OutputStream for the standard err
        Throws:
        java.io.IOException - if an I/O error occurs
        See Also:
        for control over stream lifecycles
      • attach

        void attach​(java.io.OutputStream stdout,
                    java.io.OutputStream stderr,
                    boolean closeAtEof)
             throws java.io.IOException
        Attaches two OutputStreams to the LogStream.

        Example usage:

         
         dockerClient
             .attachContainer(containerId,
                 AttachParameter.LOGS, AttachParameter.STDOUT,
                 AttachParameter.STDERR, AttachParameter.STREAM)
             .attach(System.out, System.err);
         
         

        Typically you use PipedOutputStream connected to a PipedInputStream which are read by - for example - an InputStreamReader or a Scanner. For small inputs, the PipedOutputStream just writes to the buffer of the PipedInputStream, but you actually want to read and write from separate threads, as it may deadlock the thread.

         
           final PipedInputStream stdout = new PipedInputStream();
           final PipedInputStream stderr = new PipedInputStream();
           final PipedOutputStream stdout_pipe = new PipedOutputStream(stdout);
           final PipedOutputStream stderr_pipe = new PipedOutputStream(stderr);
        
           executor.submit(new Callable&lt;Void&gt;() {
             &#064;Override
             public Void call() throws Exception {
               dockerClient.attachContainer(containerId,
                   AttachParameter.LOGS, AttachParameter.STDOUT,
                   AttachParameter.STDERR, AttachParameter.STREAM
                 .attach(stdout_pipe, stderr_pipe);
               return null;
             }
           });
        
           try (Scanner sc_stdout = new Scanner(stdout); Scanner sc_stderr = new Scanner(stderr)) {
             // ... read here
           }
         
         
        Parameters:
        stdout - OutputStream for the standard out
        stderr - OutputStream for the standard err
        closeAtEof - whether to close the streams when this log stream ends
        Throws:
        java.io.IOException - if an I/O error occurs
        See Also:
        PipedInputStream, PipedOutputStream
      • close

        void close()
        Redefine to not throw checked exceptions.
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable