Class GetPrincipalPipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.pipes.GetPrincipalPipe

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="*",
         description="principal has not been found, when {@literal notFoundForwardName} is used")
@EnterpriseIntegrationPattern(SESSION)
public class GetPrincipalPipe
extends FixedForwardPipe

Returns the name of the user executing the request.

Since:

4.7

Author:

Gerrit van Brakel

Field Summary

Fields

Modifier and Type	Field	Description
protected PipeForward	notFoundForward

Fields inherited from class AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class TransactionAttributes

log

Fields inherited from interface IPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor	Description
GetPrincipalPipe()

Method Summary

Modifier and Type	Method	Description
void	configure()	Checks for correct configuration of forward.
@NonNull PipeRunResult	doPipe(Message message, PipeLineSession session)	This is where the action takes place.
void	setNotFoundForwardName(String string)	Name of the forward returned if the principal has not been found.

Methods inherited from class FixedForwardPipe

getParameterValue

Methods inherited from class AbstractPipe

addForward, addParameter, createBean, findForward, getAdapter, getEventSourceName, getParameterList, getRegisteredForwards, hasRegisteredForward, isRunning, registerEvent, setApplicationContext, setChompCharSize, setDefaultValue, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setIfParam, setIfValue, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setOnlyIfSessionKey, setOnlyIfValue, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setSkipOnEmptyInput, setStoreResultInSessionKey, setUnlessSessionKey, setUnlessValue, setWriteToSecLog, sizeStatisticsEnabled, skipPipe, start, stop, throwEvent

Methods inherited from class TransactionAttributes

configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout

Methods inherited from class Object

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

Methods inherited from interface FrankElement

addConfigWarning

Methods inherited from interface HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface HasName

getName

Methods inherited from interface HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Methods inherited from interface IForwardTarget

getName

Methods inherited from interface IPipe

getChompCharSize, getDefaultValue, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getIfParam, getIfValue, getLocker, getLogIntermediaryResults, getMaxThreads, getOnlyIfSessionKey, getOnlyIfValue, getSecLogSessionKeys, getStoreResultInSessionKey, getUnlessSessionKey, getUnlessValue, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isSkipOnEmptyInput, isWriteToSecLog, setPipeLine, throwEvent

Field Details

notFoundForward

protected PipeForward notFoundForward

Constructor Details

GetPrincipalPipe

public GetPrincipalPipe()

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 @NonNull 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

setNotFoundForwardName

public void setNotFoundForwardName(String string)

Name of the forward returned if the principal has not been found.