com.mulesoft.mule.transport.sap.jco3.xml

Class AbstractSapFunctionXmlParser

java.lang.Object

com.mulesoft.mule.transport.sap.jco3.xml.AbstractSapXmlParser

com.mulesoft.mule.transport.sap.jco3.xml.AbstractSapFunctionXmlParser

All Implemented Interfaces:

SapFunctionXmlParser, SapJcoXmlParser

Direct Known Subclasses:

SapFunctionXmlParserV1Impl, SapFunctionXmlParserV2Impl

public abstract class AbstractSapFunctionXmlParser
extends AbstractSapXmlParser
implements SapFunctionXmlParser

Field Summary

Fields

Modifier and Type	Field and Description
static String	SINGLE_TABLE_VALUE

Fields inherited from class com.mulesoft.mule.transport.sap.jco3.xml.AbstractSapXmlParser

ENCODED_CODE_DIGIT_START, ENCODED_SLASH_FOR_XML, logger

Constructor Summary

Constructors

Constructor and Description
AbstractSapFunctionXmlParser()

Method Summary

Methods

Modifier and Type	Method and Description
protected com.sap.conn.jco.AbapException	createAbapException(String errorKey, String messageClass, String messageType, String messageNumber, List<String> messageParameters, String message)
protected com.sap.conn.jco.JCoFunction	createFunction(String functionName)
protected String	decodeTableFieldName(String fieldName, boolean isTableField)
protected String	encodeTableFieldName(com.sap.conn.jco.JCoField field, boolean isTableField)
protected String	getAttributeValue(String name, XMLStreamReader reader)
protected SapJcoClient	getSapClient()
void	initialise(SapJcoClient sapClient)
static boolean	isBapiReturnCodeOkay(com.sap.conn.jco.JCoFunction function)
protected void	jcoFunctionToJcoFunctionOutput(com.sap.conn.jco.JCoFunction function, com.sap.conn.jco.JCoFunction src)
String	jcoFunctionToXmlMetadata(String functionName, String encoding, MetadataLevel metadata)
void	objectToJcoFunctionResponse(com.sap.conn.jco.JCoFunction function, Object sapObject, String encoding) This method will set the output parameters for function.
protected void	parseErrorsRecord(String errorsRecordName, List<com.sap.conn.jco.AbapException> errors, XMLStreamReader reader)
String	sapObjectToXml(Object sapObject, String encoding)
protected void	setSapClient(SapJcoClient sapClient)
protected String	transformJcoFunction(com.sap.conn.jco.JCoFunction function, String encoding, MetadataLevel metadata)
protected abstract void	writeChangingElement(XMLEventWriter writer, com.sap.conn.jco.JCoFunction function, XMLEventFactory eventFactory, MetadataLevel metadata)
protected abstract void	writeErrorElement(XMLEventWriter writer, com.sap.conn.jco.AbapException[] exceptions, XMLEventFactory eventFactory, MetadataLevel metadata)
protected abstract void	writeExportElement(XMLEventWriter writer, com.sap.conn.jco.JCoFunction function, XMLEventFactory eventFactory, MetadataLevel metadata)
protected abstract void	writeImportElement(XMLEventWriter writer, com.sap.conn.jco.JCoFunction function, XMLEventFactory eventFactory, MetadataLevel metadata)
protected abstract void	writeRootElementEnd(XMLEventWriter writer, com.sap.conn.jco.JCoFunction function, XMLEventFactory eventFactory, MetadataLevel metadata)
protected abstract void	writeRootElementStart(XMLEventWriter writer, com.sap.conn.jco.JCoFunction function, XMLEventFactory eventFactory, MetadataLevel metadata)
protected abstract void	writeTablesElement(XMLEventWriter writer, com.sap.conn.jco.JCoFunction function, XMLEventFactory eventFactory, MetadataLevel metadata)
protected abstract void	xmlToJcoFunctionOutput(com.sap.conn.jco.JCoFunction function, InputStream stream, String encoding)
SapObject	xmlToSapObject(Collection<InputStream> streams, SapType type, String objectName, String encoding)

Methods inherited from class com.mulesoft.mule.transport.sap.jco3.xml.AbstractSapXmlParser

cleanInvalidXmlChars, decodeSapObjectName, encodeSapObjectName, setLogger, writeAttribute, writeCharacters, writeEndDocument, writeEndElement, writeEndXsdAll, writeEndXsdAttribute, writeEndXsdComplexType, writeEndXsdElement, writeEndXsdExtension, writeEndXsdRestriction, writeEndXsdSequence, writeEndXsdSimpleContent, writeEndXsdSimpleType, writeStartDocument, writeStartElement, writeStartXsdAll, writeStartXsdAttribute, writeStartXsdComplexType, writeStartXsdElement, writeStartXsdElement, writeStartXsdElement, writeStartXsdExtension, writeStartXsdRestriction, writeStartXsdSequence, writeStartXsdSimpleContent, writeStartXsdSimpleType, writeXsdAttribute, writeXsdAttribute, writeXsdDocumentation, writeXsdEnumRestriction, writeXsdFixedAttribute, writeXsdMaxLengthRestriction

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.mulesoft.mule.transport.sap.jco3.xml.SapJcoXmlParser

getXmlSchema, xmlToSapObject

Field Detail

SINGLE_TABLE_VALUE

public static final String SINGLE_TABLE_VALUE

See Also:

Constant Field Values

Constructor Detail

AbstractSapFunctionXmlParser

public AbstractSapFunctionXmlParser()

Method Detail

initialise

public void initialise(SapJcoClient sapClient)
                throws Exception

Specified by:

initialise in interface SapJcoXmlParser

Parameters:

sapClient -

Throws:

Exception

See Also:

com.mulesoft.mule.transport.sap.functional.jco3.xml.SapJcoXmlParser#initialise(com.mulesoft.mule.transport.sap.jco3.SapJcoClient)

xmlToSapObject

public SapObject xmlToSapObject(Collection<InputStream> streams,
                       SapType type,
                       String objectName,
                       String encoding)
                         throws Exception

Specified by:

xmlToSapObject in interface SapJcoXmlParser

Throws:

Exception

sapObjectToXml

public String sapObjectToXml(Object sapObject,
                    String encoding)
                      throws Exception

Specified by:

sapObjectToXml in interface SapJcoXmlParser

Throws:

Exception

jcoFunctionToXmlMetadata

public String jcoFunctionToXmlMetadata(String functionName,
                              String encoding,
                              MetadataLevel metadata)
                                throws Exception

Specified by:

jcoFunctionToXmlMetadata in interface SapFunctionXmlParser

Throws:

Exception

objectToJcoFunctionResponse

public void objectToJcoFunctionResponse(com.sap.conn.jco.JCoFunction function,
                               Object sapObject,
                               String encoding)
                                 throws Exception

This method will set the output parameters for function.

Specified by:

objectToJcoFunctionResponse in interface SapFunctionXmlParser

Parameters:

function - The function where output parameters will be set

sapObject - Representation of the JCo function with response values

Throws:

Exception

jcoFunctionToJcoFunctionOutput

protected void jcoFunctionToJcoFunctionOutput(com.sap.conn.jco.JCoFunction function,
                                  com.sap.conn.jco.JCoFunction src)
                                       throws Exception

Throws:

Exception

xmlToJcoFunctionOutput

protected abstract void xmlToJcoFunctionOutput(com.sap.conn.jco.JCoFunction function,
                          InputStream stream,
                          String encoding)
                                        throws Exception

Throws:

Exception

transformJcoFunction

protected String transformJcoFunction(com.sap.conn.jco.JCoFunction function,
                          String encoding,
                          MetadataLevel metadata)
                               throws XMLStreamException,
                                      UnsupportedEncodingException

Throws:

XMLStreamException

UnsupportedEncodingException

writeRootElementStart

protected abstract void writeRootElementStart(XMLEventWriter writer,
                         com.sap.conn.jco.JCoFunction function,
                         XMLEventFactory eventFactory,
                         MetadataLevel metadata)
                                       throws XMLStreamException

Throws:

XMLStreamException

writeRootElementEnd

protected abstract void writeRootElementEnd(XMLEventWriter writer,
                       com.sap.conn.jco.JCoFunction function,
                       XMLEventFactory eventFactory,
                       MetadataLevel metadata)
                                     throws XMLStreamException

Throws:

XMLStreamException

writeImportElement

protected abstract void writeImportElement(XMLEventWriter writer,
                      com.sap.conn.jco.JCoFunction function,
                      XMLEventFactory eventFactory,
                      MetadataLevel metadata)
                                    throws XMLStreamException

Throws:

XMLStreamException

writeExportElement

protected abstract void writeExportElement(XMLEventWriter writer,
                      com.sap.conn.jco.JCoFunction function,
                      XMLEventFactory eventFactory,
                      MetadataLevel metadata)
                                    throws XMLStreamException

Throws:

XMLStreamException

writeTablesElement

protected abstract void writeTablesElement(XMLEventWriter writer,
                      com.sap.conn.jco.JCoFunction function,
                      XMLEventFactory eventFactory,
                      MetadataLevel metadata)
                                    throws XMLStreamException

Throws:

XMLStreamException

writeChangingElement

protected abstract void writeChangingElement(XMLEventWriter writer,
                        com.sap.conn.jco.JCoFunction function,
                        XMLEventFactory eventFactory,
                        MetadataLevel metadata)
                                      throws XMLStreamException

Throws:

XMLStreamException

writeErrorElement

protected abstract void writeErrorElement(XMLEventWriter writer,
                     com.sap.conn.jco.AbapException[] exceptions,
                     XMLEventFactory eventFactory,
                     MetadataLevel metadata)
                                   throws XMLStreamException

Throws:

XMLStreamException

createFunction

protected com.sap.conn.jco.JCoFunction createFunction(String functionName)
                                               throws Exception

Throws:

Exception

isBapiReturnCodeOkay

public static boolean isBapiReturnCodeOkay(com.sap.conn.jco.JCoFunction function)

getAttributeValue

protected String getAttributeValue(String name,
                       XMLStreamReader reader)

createAbapException

protected com.sap.conn.jco.AbapException createAbapException(String errorKey,
                                                 String messageClass,
                                                 String messageType,
                                                 String messageNumber,
                                                 List<String> messageParameters,
                                                 String message)

parseErrorsRecord

protected void parseErrorsRecord(String errorsRecordName,
                     List<com.sap.conn.jco.AbapException> errors,
                     XMLStreamReader reader)
                          throws Exception

Throws:

Exception

getSapClient

protected SapJcoClient getSapClient()

setSapClient

protected void setSapClient(SapJcoClient sapClient)

encodeTableFieldName

protected String encodeTableFieldName(com.sap.conn.jco.JCoField field,
                          boolean isTableField)

decodeTableFieldName

protected String decodeTableFieldName(String fieldName,
                          boolean isTableField)