Package org.frankframework.ladybug

Class LadybugPipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.ladybug.LadybugPipe

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasTransactionAttribute, IConfigurable, IForwardTarget, IPipe, IScopeProvider, IWithParameters, NameAware, EventThrowing, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

@Forward(name="success",description="no errors and all tests passed") @Forward(name="failure",description="errors or failed tests")
public class LadybugPipe
extends FixedForwardPipe

Call Ladybug Test Tool to rerun the reports present in test storage (see Test tab in Ladybug)

Author:

Jaco de Groot

Field Summary

Fields inherited from class org.frankframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class org.frankframework.core.TransactionAttributes

log

Fields inherited from interface org.frankframework.core.IPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor	Description
LadybugPipe()

Method Summary

Modifier and Type	Method	Description
void	configure()	Checks for correct configuration of forward.
PipeRunResult	doPipe(Message message, PipeLineSession session)	This is where the action takes place.
void	setCheckRoles(boolean checkRoles)	Set this to true if you wish to enforce the user roles (e.g. when using an HTTP based listener).
void	setDebugStorage(nl.nn.testtool.storage.Storage debugStorage)
void	setEnableReportGenerator(boolean enabled)	Set to true to enable Ladybug's report generator for the duration of the scheduled report runs then revert it to its original setting
void	setExclude(String exclude)	When set, reports with a full path (path + name) that matches with the specified regular expression are skipped.
void	setReportXmlTransformer(nl.nn.testtool.transform.ReportXmlTransformer reportXmlTransformer)
void	setTestStorage(nl.nn.testtool.storage.CrudStorage testStorage)
void	setTestTool(nl.nn.testtool.TestTool testTool)
void	setWriteToLog(boolean writeToLog)	whether or not to write results to the logfile (testtool4<instance.name>)
void	setWriteToSystemOut(boolean writeToSystemOut)	Deprecated.

Methods inherited from class org.frankframework.pipes.FixedForwardPipe

getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe

Methods inherited from class org.frankframework.pipes.AbstractPipe

addForward, addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getParameterList, hasRegisteredForward, isRunning, registerEvent, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, sizeStatisticsEnabled, start, stop, throwEvent

Methods inherited from class org.frankframework.core.TransactionAttributes

configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.frankframework.core.FrankElement

addConfigWarning

Methods inherited from interface org.frankframework.core.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.HasName

getName

Methods inherited from interface org.frankframework.core.HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Methods inherited from interface org.frankframework.core.IForwardTarget

getName

Methods inherited from interface org.frankframework.core.IPipe

getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getLocker, getLogIntermediaryResults, getMaxThreads, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine, throwEvent

Constructor Details

LadybugPipe

public LadybugPipe()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from class: FixedForwardPipe

Checks for correct configuration of forward.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class FixedForwardPipe

Throws:

ConfigurationException - in case it was not able to configure the component.

doPipe

public PipeRunResult doPipe(Message message,
 PipeLineSession session)
                     throws PipeRunException

Description copied from interface: IPipe

This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object. Implementations must either consume the message, or pass it on to the next Pipe in the PipeRunResult.

Throws:

PipeRunException

setWriteToLog

public void setWriteToLog(boolean writeToLog)

whether or not to write results to the logfile (testtool4<instance.name>)

Default value

false

setWriteToSystemOut

@Deprecated(since="9.3")
public void setWriteToSystemOut(boolean writeToSystemOut)

Deprecated.

whether or not to write results to system out

Default value

false

setCheckRoles

public void setCheckRoles(boolean checkRoles)

Set this to true if you wish to enforce the user roles (e.g. when using an HTTP based listener). When set to false the Ladybug is run anonymously.

Default value

false

setEnableReportGenerator

public void setEnableReportGenerator(boolean enabled)

Set to true to enable Ladybug's report generator for the duration of the scheduled report runs then revert it to its original setting

Default value

false

setExclude

public void setExclude(String exclude)

When set, reports with a full path (path + name) that matches with the specified regular expression are skipped. For example, \"/Unscheduled/.*\" or \".*SKIP\".

setTestTool

public void setTestTool(nl.nn.testtool.TestTool testTool)

setTestStorage

public void setTestStorage(nl.nn.testtool.storage.CrudStorage testStorage)

setDebugStorage

public void setDebugStorage(nl.nn.testtool.storage.Storage debugStorage)

setReportXmlTransformer

public void setReportXmlTransformer(nl.nn.testtool.transform.ReportXmlTransformer reportXmlTransformer)