org.jenkinsci.plugins.rundeck

Class RunDeckLogTail

java.lang.Object

org.jenkinsci.plugins.rundeck.RunDeckLogTail

All Implemented Interfaces:

Iterable<List<org.rundeck.client.api.model.ExecLog>>

public class RunDeckLogTail
extends Object
implements Iterable<List<org.rundeck.client.api.model.ExecLog>>

This class implements logtailing for Rundeck.

Author:

ckramer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	RunDeckLogTail.RunDeckLogTailIterator

Constructor Summary

Constructors

Constructor and Description
RunDeckLogTail(RundeckManager rundeckClient, Long executionId) Standard constructor that contains sensible defaults for handling the API calls correctly.
RunDeckLogTail(RundeckManager rundeckClient, Long executionId, int maxlines, int maxRetries, long sleepRetry, long sleepUnmodified, long sleepModified) Extended constructor containing all the variables that can be set.

Method Summary

Modifier and Type	Method and Description
RunDeckLogTail.RunDeckLogTailIterator	iterator()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

RunDeckLogTail

public RunDeckLogTail(RundeckManager rundeckClient,
                      Long executionId)

Standard constructor that contains sensible defaults for handling the API calls correctly.

Parameters:

rundeckClient - Rundeck Client

executionId - Execution ID

RunDeckLogTail

public RunDeckLogTail(RundeckManager rundeckClient,
                      Long executionId,
                      int maxlines,
                      int maxRetries,
                      long sleepRetry,
                      long sleepUnmodified,
                      long sleepModified)

Extended constructor containing all the variables that can be set.

Parameters:

rundeckClient - the runDeckClient

executionId - the id of the RunDeck job

maxlines - the maximum number of lines to fetch on each API call

maxRetries - the maximum number of retry attempts if the api call fails

sleepRetry - sleep time in ms that will be triggered if a api call fails

sleepUnmodified - sleep time in ms when the results are unmodified

sleepModified - sleep time in ms when the results are modified

Method Detail

iterator

public RunDeckLogTail.RunDeckLogTailIterator iterator()

Specified by:

iterator in interface Iterable<List<org.rundeck.client.api.model.ExecLog>>