Package org.frankframework.pipes

Class CrlPipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.pipes.CrlPipe

All Implemented Interfaces:

HasTransactionAttribute, IConfigurable, IConfigurationAware, IForwardTarget, INamedObject, IPipe, IScopeProvider, IWithParameters, EventThrowing, HasStatistics, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

@ElementType(TRANSLATOR)
public class CrlPipe
extends FixedForwardPipe

Pipe that reads a CRL from an input stream and transforms it to an XML. The steam is closed after reading. Example configuration:

        <pipe
                name="Read issuer"
                className="org.frankframework.pipes.FilePipe"
                actions="read"
                fileName="dir/issuer.cer"
                preserveInput="true"
                outputType="stream"
                storeResultInSessionKey="issuer"
                >
                <forward name="success" path="Read CRL" />
        </pipe>
        <pipe
                name="Read CRL"
                className="org.frankframework.pipes.FilePipe"
                actions="read"
                fileName="dir/CRL.crl"
                outputType="stream"
                >
                <forward name="success" path="Transform CRL" />
        </pipe>
        <pipe
                name="Transform CRL"
                className="org.frankframework.pipes.CrlPipe"
                issuerSessionKey="issuer"
                >
                <forward name="success" path="EXIT" />
        </pipe>
 

Author:

Miel Hoppenbrouwers, Jaco de Groot, Tom van der Heijden

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
CrlPipe()

Method Summary

Modifier and Type	Method	Description
PipeRunResult	doPipe(Message message, PipeLineSession session)	This is where the action takes place.
String	getIssuerSessionKey()
void	setIssuerSessionKey(String issuerSessionKey)	Name of the sessionKey that holds the certificate of the issuer who signed the CRL.

Methods inherited from class org.frankframework.pipes.FixedForwardPipe

configure, getIfParam, getIfValue, getOnlyIfSessionKey, getOnlyIfValue, getParameterValue, getSuccessForward, getUnlessSessionKey, getUnlessValue, isSkipOnEmptyInput, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe

Methods inherited from class org.frankframework.pipes.AbstractPipe

addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getApplicationContext, getChompCharSize, getConfigurationClassLoader, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getEventSourceName, getForwards, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getLocker, getLogIntermediaryResults, getMaxThreads, getName, getParameterList, getPipeLine, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, registerEvent, registerForward, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setEventPublisher, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPipeLine, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, sizeStatisticsEnabled, start, stop, throwEvent

Methods inherited from class org.frankframework.core.TransactionAttributes

configureTransactionAttributes, getTransactionAttribute, getTransactionTimeout, getTxDef, isTransacted, isTransacted, setTransacted, setTransactionAttribute, 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.IPipe

throwEvent

Constructor Details

CrlPipe

public CrlPipe()

Method Details

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. If the result of the Pipe does not depend on the input, like for the FixedResultPipe, the Pipe can schedule the input to be closed at session exit, by calling Message.closeOnCloseOf(PipeLineSession, String) This allows the previous Pipe to release any resources (e.g. connections) that it might have kept open until the message was consumed. Doing so avoids connections leaking from pools, while it enables efficient streaming processing of data while it is being read from a stream.

Throws:

PipeRunException

setIssuerSessionKey

public void setIssuerSessionKey(String issuerSessionKey)

Name of the sessionKey that holds the certificate of the issuer who signed the CRL.

getIssuerSessionKey

public String getIssuerSessionKey()