Package org.frankframework.pipes

Class BytesOutputPipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.pipes.BytesOutputPipe

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

@EnterpriseIntegrationPattern(TRANSLATOR)
public class BytesOutputPipe
extends FixedForwardPipe

Output bytes as specified by the input XML. Actions are taken on every field tag found in the input XML. Every field tag should have a type attribute that specifies the type of conversion that needs to be done on the string specified by the value attribute. A value attribute also needs to be present for every field tag. Currently, two types of conversion are supported:

• GetBytesFromString, a conversion from string to bytes as specified by java.lang.String.getBytes(String charsetName).
• PackedDecimal, a conversion from string to Packed-decimal.

An additional charset attribute is needed for a GetBytesFromString conversion. An input XML that would encode the string " TEST 1234 " into EBCDIC format would look like:

 <fields>
   <field type="GetBytesFromString" value=" TEST 1234 " charset="Cp037"/>
 </fields>
 

The Packed-decimal conversion has been implemented according to information found in the following resources:

• A description as found at http://www.simotime.com/datapk01.htm.
• AS400PackedDecimal.java from jtopen_6_1_source.zip downloaded at http://jt400.sourceforge.net/.

Some examples:

• The string +12345 will be translated to three bytes with the following hexadecimal representation: 12 34 5C.
• The string -12345 will be translated to three bytes with the following hexadecimal representation: 12 34 5D.
• The string 12345 will be translated to three bytes with the following hexadecimal representation: 12 34 5F.
• The string 1234 will be translated to three bytes with the following hexadecimal representation: 01 23 4F.

The Packed-decimal is prefixed with zeroes when the specified size is bigger than the number of decimals. An exception is thrown when the specified size is smaller than the number of decimals. An input XML that would generate a number of Packed-decimals could look like:

 <fields>
   <field type="PackedDecimal" value="+12345" size="16"/>
   <field type="PackedDecimal" value="+67890" size="16"/>
   <field type="PackedDecimal" value="+1234" size="16"/>
   <field type="PackedDecimal" value="-12345" size="16"/>
   <field type="PackedDecimal" value="-67890" size="16"/>
   <field type="PackedDecimal" value="-1234" size="16"/>
   <field type="PackedDecimal" value="12345" size="16"/>
   <field type="PackedDecimal" value="67890" size="16"/>
   <field type="PackedDecimal" value="1234" size="16"/>
   <field type="PackedDecimal" value="+1" size="16"/>
   <field type="PackedDecimal" value="-1" size="16"/>
   <field type="PackedDecimal" value="+12" size="16"/>
   <field type="PackedDecimal" value="-12" size="16"/>
   <field type="PackedDecimal" value="+123" size="16"/>
   <field type="PackedDecimal" value="-123" size="16"/>
   <field type="PackedDecimal" value="+1234" size="16"/>
   <field type="PackedDecimal" value="-1234" size="16"/>
   <field type="PackedDecimal" value="+12345" size="16"/>
   <field type="PackedDecimal" value="-12345" size="16"/>
   <field type="PackedDecimal" value="+123456" size="16"/>
   <field type="PackedDecimal" value="-123456" size="16"/>
   <field type="PackedDecimal" value="+1234567" size="16"/>
   <field type="PackedDecimal" value="-1234567" size="16"/>
   <field type="PackedDecimal" value="+12345678" size="16"/>
   <field type="PackedDecimal" value="-12345678" size="16"/>
 </fields>
 

Since:

4.9

Author:

Jaco de Groot (***@dynasol.nl)

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

Method Summary

Modifier and Type	Method	Description
PipeRunResult	doPipe(Message message, PipeLineSession session)	This is where the action takes place.

Methods inherited from class org.frankframework.pipes.FixedForwardPipe

configure, 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

BytesOutputPipe

public BytesOutputPipe()

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.

Throws:

PipeRunException