com.goldencode.p2j.soap

Class SoapResponseArguments

java.lang.Object

com.goldencode.p2j.rest.ResponseArguments

com.goldencode.p2j.soap.SoapResponseArguments

public class SoapResponseArguments
extends ResponseArguments

Helper class to serialize a SOAP response.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	isField Flag indicating that we are not writing a table field.
private org.apache.axiom.om.OMNamespace	nsXSD The XSD namespace.
private org.apache.axiom.om.OMNamespace	nsXSI The XSI namespace.
private javax.wsdl.Output	output The output defined in this operation's WSDL.
private java.lang.String	requestID The request ID for the SOAP request to which these arguments belong.
private org.apache.axiom.soap.SOAPEnvelope	response The envelope holding the response.
private org.apache.axiom.soap.SOAPFactory	soapFactory SOAP factory to create new elements.
private java.util.Map<java.lang.String,WsdlConfig.BaseSchemaType>	soapParams The SOAP output parameters' schema, by their name.
private org.apache.axiom.om.OMElement	soapResponse The root element defining the response, in the SOAP body.
private WsdlConfig	wsdlConfig The WSDL configuration.

Constructor Summary

Constructors

Constructor and Description
SoapResponseArguments(javax.wsdl.Operation soapOperation, WsdlConfig wsdlConfig, boolean pasoe) Initialize this instance, to write output parameters for the SOAP operation.

Method Summary

Modifier and Type	Method and Description
protected void	flushArguments(java.io.OutputStream stream, javax.servlet.http.HttpServletResponse response) Flush the arguments to the response stream (i.e.
protected boolean	ignoreUnknown() Determine if unknown values must be ignored.
(package private) void	setRequestId(java.lang.String requestID) Set the request ID for the executed SOAP service, to which this response belongs.
protected java.lang.String	toString(BaseDataType bdt) Get the string representation of this instance.
protected void	writeArgumentInt(java.io.OutputStream stream, java.lang.String target, java.lang.String sval, java.lang.Object val, javax.servlet.http.HttpServletResponse response) Serialize this argument's value, considering the target format.
protected java.lang.Object	writeDataSet(java.lang.String target, DataSetContainer val) Serialize the specified dataset.
protected java.lang.Object	writeDataSet(java.lang.String target, DatasetWrapper val) Serialize the specified dataset.
java.lang.String	writeError(LegacyError err) Serialize the error, to be included in the response.
void	writeError(RequestArgumentError err, boolean pasoe) Serialize the error, to be included in the response.
void	writeError(java.lang.String msg, java.lang.String reason) Serialize the error, to be included in the response.
void	writeError(java.lang.String returnValue, java.lang.String reason, boolean server) Serialize the error, to be included in the response.
protected void	writeExtentArgument(java.io.OutputStream stream, java.lang.String target, java.lang.Object val, javax.servlet.http.HttpServletResponse response) Serialize this argument's values, considering the target format.
void	writeProcedureID(java.lang.String connectionID, java.lang.String resourceID, int agentId, javax.wsdl.BindingOperation binding) Write the persistent procedure ID to the SOAP header, as a response for a persistent procedure request.
protected java.lang.Object	writeTable(java.lang.String target, TableWrapper val) Serialize the specified table.

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

writeArgument, writeArguments, writeArguments, writeArguments

Methods inherited from class java.lang.Object

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

Field Detail

response

private final org.apache.axiom.soap.SOAPEnvelope response

The envelope holding the response.

soapResponse

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

The root element defining the response, in the SOAP body.

nsXSI

private final org.apache.axiom.om.OMNamespace nsXSI

The XSI namespace.

nsXSD

private final org.apache.axiom.om.OMNamespace nsXSD

The XSD namespace.

soapParams

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

The SOAP output parameters' schema, by their name.

soapFactory

private final org.apache.axiom.soap.SOAPFactory soapFactory

SOAP factory to create new elements.

output

private final javax.wsdl.Output output

The output defined in this operation's WSDL.

wsdlConfig

private final WsdlConfig wsdlConfig

The WSDL configuration.

requestID

private java.lang.String requestID

The request ID for the SOAP request to which these arguments belong.

isField

private boolean isField

Flag indicating that we are not writing a table field.

Constructor Detail

SoapResponseArguments

public SoapResponseArguments(javax.wsdl.Operation soapOperation,
                             WsdlConfig wsdlConfig,
                             boolean pasoe)

Initialize this instance, to write output parameters for the SOAP operation.

Parameters:

soapOperation - The SOAP operation as defined in the WSDL.

wsdlConfig - The WSDL configuration.

pasoe - Flag indicating that the remote appserver is in PASOE mode.

Method Detail

writeError

public void writeError(RequestArgumentError err,
                       boolean pasoe)

Serialize the error, to be included in the response.

Parameters:

err - The request argument error.

pasoe - Flag indicating that the remote appserver is in PASOE mode.

writeError

public java.lang.String writeError(LegacyError err)

Serialize the error, to be included in the response.

Specified by:

writeError in class ResponseArguments

Parameters:

err - The error.

Returns:

The serialized version of the error.

writeError

public void writeError(java.lang.String msg,
                       java.lang.String reason)

Serialize the error, to be included in the response.

Parameters:

msg - The message to be used as the SOAP fault code ('faultString').

reason - The message to be used as the SOAP fault detail.

writeError

public void writeError(java.lang.String returnValue,
                       java.lang.String reason,
                       boolean server)

Serialize the error, to be included in the response.

Parameters:

returnValue - The message to be used as the SOAP fault code ('faultString').

reason - The message to be used as the SOAP fault detail.

server - Flag indicating if this is a server error.

writeProcedureID

public void writeProcedureID(java.lang.String connectionID,
                             java.lang.String resourceID,
                             int agentId,
                             javax.wsdl.BindingOperation binding)

Write the persistent procedure ID to the SOAP header, as a response for a persistent procedure request.

Parameters:

connectionID - The connection ID used by this request.

resourceID - The persistent procedure ID.

agentId - The agent ID where this remote procedure was created.

binding - The operation definition in the WSDL binding, for the response.

toString

protected java.lang.String toString(BaseDataType bdt)

Get the string representation of this instance.

Overrides:

toString in class ResponseArguments

Parameters:

bdt - The instance.

Returns:

The string representation, using DatatypeConverter.

ignoreUnknown

protected boolean ignoreUnknown()

Determine if unknown values must be ignored.

Specified by:

ignoreUnknown in class ResponseArguments

Returns:

Always false.

writeExtentArgument

protected void writeExtentArgument(java.io.OutputStream stream,
                                   java.lang.String target,
                                   java.lang.Object val,
                                   javax.servlet.http.HttpServletResponse response)
                            throws java.io.IOException

Serialize this argument's values, considering the target format.

Specified by:

writeExtentArgument in class ResponseArguments

Parameters:

stream - The response stream.

target - The argument's encoded target.

val - The argument's value.

response - The HTTP response.

Throws:

java.io.IOException

writeArgumentInt

protected void writeArgumentInt(java.io.OutputStream stream,
                                java.lang.String target,
                                java.lang.String sval,
                                java.lang.Object val,
                                javax.servlet.http.HttpServletResponse response)
                         throws java.io.IOException

Serialize this argument's value, considering the target format.

Specified by:

writeArgumentInt in class ResponseArguments

Parameters:

stream - The response stream.

target - The argument's encoded target.

sval - The argument's string-converted value.

val - The argument's value.

response - The HTTP response.

Throws:

java.io.IOException

flushArguments

protected void flushArguments(java.io.OutputStream stream,
                              javax.servlet.http.HttpServletResponse response)
                       throws java.io.IOException

Flush the arguments to the response stream (i.e. HTTP body).

Specified by:

flushArguments in class ResponseArguments

Parameters:

stream - The stream to write the parameters.

response - The servlet response.

Throws:

java.io.IOException

writeTable

protected java.lang.Object writeTable(java.lang.String target,
                                      TableWrapper val)

Serialize the specified table.

Specified by:

writeTable in class ResponseArguments

Parameters:

target - The target OUTPUT parameter.

val - The table result set, as received from the remote side.

Returns:

The serialized version of this table.

writeDataSet

protected java.lang.Object writeDataSet(java.lang.String target,
                                        DatasetWrapper val)

Serialize the specified dataset.

Overrides:

writeDataSet in class ResponseArguments

Parameters:

target - The target OUTPUT parameter.

val - The dataset, as received from the remote side.

Returns:

The serialized version of this dataset.

writeDataSet

protected java.lang.Object writeDataSet(java.lang.String target,
                                        DataSetContainer val)

Serialize the specified dataset.

Specified by:

writeDataSet in class ResponseArguments

Parameters:

target - The target OUTPUT parameter.

val - The dataset, as received from the remote side.

Returns:

The serialized version of this dataset.

setRequestId

void setRequestId(java.lang.String requestID)

Set the request ID for the executed SOAP service, to which this response belongs.

Parameters:

requestID - The request ID.