io.fabric8.maven.docker.access.log

Interface LogCallback

All Known Implementing Classes:

DefaultLogCallback

public interface LogCallback

Interface called for each log line received from the docker host when asynchronous log fetching is used.

Since:

21/11/14

Author:

roland

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LogCallback.DoneException Exception indicating that logging is done and should be finished

Method Summary

Modifier and Type	Method and Description
void	close() Invoked by a user when callback is no longer used.
void	error(String error) Method called in case on an error when reading the logs
void	log(int type, Timestamp timestamp, String txt) Receive a log entry
void	open() To be called by a client to start the callback and allocate the underlying output stream.

Method Detail

log

void log(int type,
         Timestamp timestamp,
         String txt)
  throws LogCallback.DoneException

Receive a log entry

Parameters:

type - 1 for log on standard output, 2 for standard error

timestamp - timestampp on the server side when this entry happened

txt - log output

Throws:

CancellationException - if thrown will stop the logging.

LogCallback.DoneException

error

void error(String error)

Method called in case on an error when reading the logs

Parameters:

error - error description

open

void open()
   throws IOException

To be called by a client to start the callback and allocate the underlying output stream. In case of a shared stream it might be that the stream is reused

Throws:

IOException

close

void close()

Invoked by a user when callback is no longer used. Closing the underlying stream may be delayed by the implementation when this stream is shared between multiple clients.