nl.nn.adapterframework.pipes

Class BytesOutputPipe

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

nl.nn.adapterframework.pipes.BytesOutputPipe

All Implemented Interfaces:

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

@ElementType(value=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/
• The WebSphere Studio COBOL for Windows Programming Guide from http://www-1.ibm.com/support/docview.wss?uid=swg27005151

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 zero's 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 nl.nn.adapterframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class nl.nn.adapterframework.core.TransactionAttributes

log

Fields inherited from interface nl.nn.adapterframework.core.IExtendedPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor and Description
BytesOutputPipe()

Method Summary

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

Methods inherited from class nl.nn.adapterframework.pipes.FixedForwardPipe

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

Methods inherited from class nl.nn.adapterframework.pipes.AbstractPipe

addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getInSizeStatDummyObject, getOutSizeStatDummyObject, getParameterList, getParameterOverriddenAttributeValue, getParameterValueList, hasSizeStatistics, registerEvent, registerForward, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, start, stop, throwEvent

Methods inherited from class nl.nn.adapterframework.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 nl.nn.adapterframework.core.IExtendedPipe

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

Methods inherited from interface nl.nn.adapterframework.core.IPipe

getMaxThreads

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface nl.nn.adapterframework.core.IForwardTarget

getName

Methods inherited from interface nl.nn.adapterframework.core.HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Constructor Detail

BytesOutputPipe

public BytesOutputPipe()

Method Detail

doPipe

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

Description copied from class: AbstractPipe

This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object.

Specified by:

doPipe in interface IPipe

Specified by:

doPipe in class AbstractPipe

Throws:

PipeRunException