com.goldencode.p2j.soap

Class SoapRequestParser

java.lang.Object

com.goldencode.p2j.rest.ServiceArgumentsParser

com.goldencode.p2j.soap.SoapRequestParser

public class SoapRequestParser
extends ServiceArgumentsParser

Parse the service input arguments from the SOAP envelope (body or header).

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,LegacyServiceParameter>	params The map of service input parameters, (FWD-style) as defined at the WSDL operation.
private LegacyServiceParameter[]	serviceParameters The list of service input parameters (FWD-style) as defined at the WSDL operation.
private java.util.Map<java.lang.String,WsdlConfig.BaseSchemaType>	soapParams The schema definition for the service input parameters, as defined at the schema.
private org.apache.axiom.om.OMElement	soapRequest The SOAP body element which encodes the request.

Constructor Summary

Constructors

Constructor and Description
SoapRequestParser(LegacyServiceParameter[] params, org.apache.axiom.om.OMElement soapRequest, javax.wsdl.Operation soapOperation, WsdlConfig wsdlConfig) Initialize this instance, to parse the input parameters for the SOAP operation.

Method Summary

Modifier and Type	Method and Description
protected void	assignArgument(int idx, BaseDataType bdt, java.lang.String sval) Assign the given argument to the specified value.
private java.lang.Object	createArgument(java.lang.String xsdType, java.lang.Class<?> type, java.lang.String sval) Create a new BaseDataType instance and restore its value from the given string, based on the XSD type.
protected DatasetWrapper	createDataset(java.lang.String name, boolean input, boolean output, boolean asHandle) Create a new DatasetWrapper, so that the transfer is made via XML.
protected TableWrapper	createTable(java.lang.String name, boolean input, boolean output, boolean asHandle) Create a new TableWrapper, so that the transfer is made via XML.
private LegacyServiceParameter	getLegacyParameter(java.lang.String source) Get the service parameter with the given name.
private org.apache.axiom.om.OMElement	getSoapParameter(java.lang.String source) Get the SOAP element from the envelope's body, for the specified parameter.
private java.util.Iterator<org.apache.axiom.om.OMElement>	getSoapParameters(java.lang.String source) Get the SOAP elements from the envelope's body, for the specified parameter.
protected DatasetWrapper	loadDataSet(java.lang.String content) Load the specified dataset.
protected TableWrapper	loadTable(java.lang.String content) Load the specified table.
protected void	notAValue(BaseDataType bdt, java.lang.String val) Raises an error so that the request stops with a 5xx internal server error.
protected java.lang.String	parseArgumentInt(java.lang.String body, java.lang.String source, javax.servlet.http.HttpServletRequest request) Parse the argument, by interpreting the request.
protected java.lang.Object[]	parseExtentArgument(java.lang.String body, javax.servlet.http.HttpServletRequest request, int idx, java.lang.String source, java.lang.String type, int extent) Parse an extent argument.

Methods inherited from class com.goldencode.p2j.rest.ServiceArgumentsParser

parseArguments, parseArguments, parseArguments

Methods inherited from class java.lang.Object

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

Field Detail

soapRequest

private final org.apache.axiom.om.OMElement soapRequest

The SOAP body element which encodes the request.

params

private final java.util.Map<java.lang.String,LegacyServiceParameter> params

The map of service input parameters, (FWD-style) as defined at the WSDL operation.

soapParams

private final java.util.Map<java.lang.String,WsdlConfig.BaseSchemaType> soapParams

The schema definition for the service input parameters, as defined at the schema.

serviceParameters

private final LegacyServiceParameter[] serviceParameters

The list of service input parameters (FWD-style) as defined at the WSDL operation.

Constructor Detail

SoapRequestParser

public SoapRequestParser(LegacyServiceParameter[] params,
                         org.apache.axiom.om.OMElement soapRequest,
                         javax.wsdl.Operation soapOperation,
                         WsdlConfig wsdlConfig)

Initialize this instance, to parse the input parameters for the SOAP operation.

Parameters:

params - The output parameters for the SOAP operation.

soapRequest - The SOAP request body.

soapOperation - The SOAP operation as defined in the WSDL.

wsdlConfig - The WSDL configuration.

Method Detail

parseExtentArgument

protected java.lang.Object[] parseExtentArgument(java.lang.String body,
                                                 javax.servlet.http.HttpServletRequest request,
                                                 int idx,
                                                 java.lang.String source,
                                                 java.lang.String type,
                                                 int extent)
                                          throws RequestArgumentError

Parse an extent argument.

Specified by:

parseExtentArgument in class ServiceArgumentsParser

Parameters:

body - The HTTP body.

request - The request payload.

idx - The argument's index.

source - The arguments's source.

type - The arguments's type.

extent - The arguments's length.

Returns:

An array with the argument's values.

Throws:

RequestArgumentError

assignArgument

protected void assignArgument(int idx,
                              BaseDataType bdt,
                              java.lang.String sval)
                       throws RequestArgumentError

Assign the given argument to the specified value.

This will assign the bdt instance, depending on the argument's configured XSD type.

Specified by:

assignArgument in class ServiceArgumentsParser

Parameters:

idx - The argument's index.

bdt - The argument's BaseDataType instance (may be null).

sval - The string representation of this argument.

Throws:

RequestArgumentError

parseArgumentInt

protected java.lang.String parseArgumentInt(java.lang.String body,
                                            java.lang.String source,
                                            javax.servlet.http.HttpServletRequest request)
                                     throws java.io.IOException

Parse the argument, by interpreting the request.

Specified by:

parseArgumentInt in class ServiceArgumentsParser

Parameters:

body - The request body.

source - The parameter's encoded source.

request - The request payload.

Returns:

The resolved argument.

Throws:

java.io.IOException

loadTable

protected TableWrapper loadTable(java.lang.String content)
                          throws java.io.IOException,
                                 RequestArgumentError

Load the specified table.

Specified by:

loadTable in class ServiceArgumentsParser

Parameters:

content - The table definition.

Returns:

A TableWrapper instance to be passed as argument to the remote call.

Throws:

java.io.IOException

RequestArgumentError

createDataset

protected DatasetWrapper createDataset(java.lang.String name,
                                       boolean input,
                                       boolean output,
                                       boolean asHandle)

Create a new DatasetWrapper, so that the transfer is made via XML.

Overrides:

createDataset in class ServiceArgumentsParser

Parameters:

name - The dataset name.

input - The INPUT mode.

output - The OUTPUT mode.

asHandle - Flag indicating if this is a DATASET-HANDLE parameter.

Returns:

A new DatasetWrapper for XML transfer.

createTable

protected TableWrapper createTable(java.lang.String name,
                                   boolean input,
                                   boolean output,
                                   boolean asHandle)

Create a new TableWrapper, so that the transfer is made via XML.

Overrides:

createTable in class ServiceArgumentsParser

Parameters:

name - The table name.

input - The INPUT mode.

output - The OUTPUT mode.

asHandle - Flag indicating if this is a DATASET-HANDLE parameter.

Returns:

A new TableWrapper for XML transfer.

loadDataSet

protected DatasetWrapper loadDataSet(java.lang.String content)
                              throws java.io.IOException,
                                     RequestArgumentError

Load the specified dataset.

Specified by:

loadDataSet in class ServiceArgumentsParser

Parameters:

content - The dataset definition.

Returns:

A DatasetWrapper instance to be passed as argument to the remote call.

Throws:

java.io.IOException

RequestArgumentError

notAValue

protected void notAValue(BaseDataType bdt,
                         java.lang.String val)
                  throws RequestArgumentError

Raises an error so that the request stops with a 5xx internal server error.

Overrides:

notAValue in class ServiceArgumentsParser

Parameters:

bdt - The BDT for which the value could not be parsed.

val - The attempted value to assign.

Throws:

RequestArgumentError

getLegacyParameter

private LegacyServiceParameter getLegacyParameter(java.lang.String source)

Get the service parameter with the given name.

Parameters:

source - The parameter's name.

Returns:

The LegacyServiceParameter from the params map.

getSoapParameter

private org.apache.axiom.om.OMElement getSoapParameter(java.lang.String source)

Get the SOAP element from the envelope's body, for the specified parameter.

Parameters:

source - The parameter name.

Returns:

The SOAP element for this parameter, from the envelope's body.

getSoapParameters

private java.util.Iterator<org.apache.axiom.om.OMElement> getSoapParameters(java.lang.String source)

Get the SOAP elements from the envelope's body, for the specified parameter.

Parameters:

source - The parameter name.

Returns:

The SOAP elements for this parameter, from the envelope's body.

createArgument

private java.lang.Object createArgument(java.lang.String xsdType,
                                        java.lang.Class<?> type,
                                        java.lang.String sval)
                                 throws RequestArgumentError

Create a new BaseDataType instance and restore its value from the given string, based on the XSD type.

Parameters:

xsdType - The parameter's XSD type.

type - The BDT sub-class.

sval - The string representation of this argument.

Returns:

The new BaseDataType or MemoryBuffer instance for this argument.

Throws:

RequestArgumentError