com.adaptris.core.sap.jco3.rfc.bapi

Class AddAllToMetadata

java.lang.Object

com.adaptris.core.sap.jco3.rfc.bapi.ReturnParserImpl

com.adaptris.core.sap.jco3.rfc.bapi.AddAllToMetadata

All Implemented Interfaces:

BapiReturnParser

public class AddAllToMetadata
extends ReturnParserImpl

Simply takes all the fields from the BAPIRETURN and adds them as metadata.

No parsing is done of the fields, they are added as is. The metadata key corresponds to the field name in the structure with the configured prefix

In the event of multiple RETURN rows, then the a count will be added to the prefix (starting from 0)

In the adapter configuration file this class is aliased as sapjco3-bapireturn-add-all-to-metadata which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields inherited from class com.adaptris.core.sap.jco3.rfc.bapi.ReturnParserImpl

BAPIRET2_FIELD, BAPIRET2_ID, BAPIRET2_LOG_MSG_NO, BAPIRET2_LOG_NO, BAPIRET2_MESSAGE, BAPIRET2_NUMBER, BAPIRET2_PARAMETER, BAPIRET2_ROW, BAPIRET2_TYPE, BAPIRETURN_CODE, BAPIRETURN_LOG_MSG_NO, BAPIRETURN_LOG_NO, BAPIRETURN_MESSAGE, BAPIRETURN_TYPE, BAPIRETURN1_ID, BAPIRETURN1_LOG_MSG_NO, BAPIRETURN1_LOG_NO, BAPIRETURN1_MESSAGE, BAPIRETURN1_NUMBER, BAPIRETURN1_TYPE

Constructor Summary

Constructors

Constructor and Description
AddAllToMetadata()
AddAllToMetadata(java.lang.String prefix)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPrefix()
void	handle(com.sap.conn.jco.JCoStructure returnStruct, AdaptrisMessage msg) Handle the return structure in some fashion.
void	handle(com.sap.conn.jco.JCoTable returnTable, AdaptrisMessage msg) Handle the return structure in some fashion.
void	setPrefix(java.lang.String prefix) Set the prefix for each metadata element generated.

Methods inherited from class com.adaptris.core.sap.jco3.rfc.bapi.ReturnParserImpl

isFailure, parseType

Methods inherited from class java.lang.Object

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

Constructor Detail

AddAllToMetadata

public AddAllToMetadata()

AddAllToMetadata

public AddAllToMetadata(java.lang.String prefix)

Method Detail

handle

public void handle(com.sap.conn.jco.JCoStructure returnStruct,
                   AdaptrisMessage msg)
            throws ProduceException

Description copied from interface: BapiReturnParser

Handle the return structure in some fashion.

Parameters:

returnStruct - the JCoStructure containing the BAPIRETURN

msg - the AdaptrisMessage.

Throws:

ProduceException - if it should be treated as a ProduceException

handle

public void handle(com.sap.conn.jco.JCoTable returnTable,
                   AdaptrisMessage msg)
            throws ProduceException

Description copied from interface: BapiReturnParser

Handle the return structure in some fashion.

Parameters:

returnTable - the JCoTable containing the BAPIRETURN

msg - the AdaptrisMessage.

Throws:

ProduceException - if it should be treated as a ProduceException

getPrefix

public java.lang.String getPrefix()

setPrefix

public void setPrefix(java.lang.String prefix)

Set the prefix for each metadata element generated.

Parameters:

prefix - the prefix, default is RETURN_