Package com.dtolabs.rundeck.plugins.logging

Interface StreamingLogReaderPlugin

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, CompletableIterator<LogEvent>, java.util.Iterator<LogEvent>, LogEventIterator, OffsetIterator<LogEvent>, StreamingLogReader

public interface StreamingLogReaderPlugin
extends StreamingLogReader

Plugin interface for streaming log readers

Method Summary

Modifier and Type	Method	Description
boolean	initialize(java.util.Map<java.lang.String,? extends java.lang.Object> context)	Sets the execution context information for the log information being requested, will be called prior to other methods StreamingLogReader.openStream(Long), and must return true to indicate the stream is ready to be open, false otherwise.

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface com.dtolabs.rundeck.core.logging.CompletableIterator

isComplete

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Methods inherited from interface com.dtolabs.rundeck.core.logging.OffsetIterator

getOffset

Methods inherited from interface com.dtolabs.rundeck.core.logging.StreamingLogReader

getLastModified, getTotalSize, openStream

Method Detail

initialize

boolean initialize(java.util.Map<java.lang.String,? extends java.lang.Object> context)

Sets the execution context information for the log information being requested, will be called prior to other methods StreamingLogReader.openStream(Long), and must return true to indicate the stream is ready to be open, false otherwise.

Parameters:

context - execution context data

Returns:

true if the stream is ready to open