com.goldencode.p2j.rest

Class ResponseArguments

java.lang.Object

com.goldencode.p2j.rest.ResponseArguments

Direct Known Subclasses:

JsonResponseArguments, SoapResponseArguments

public abstract class ResponseArguments
extends java.lang.Object

Helper class to serialize the return value and OUTPUT arguments for a REST or SOAP call.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.ThreadLocal<ArgumentsSerializer>	serializer The actual serializer to use for interpreting and writing the arguments.

Constructor Summary

Constructors

Constructor and Description
ResponseArguments()

Method Summary

Modifier and Type	Method and Description
protected abstract void	flushArguments(java.io.OutputStream stream, javax.servlet.http.HttpServletResponse response) Flush the arguments to the response stream (i.e.
protected abstract boolean	ignoreUnknown() Determine if unknown values must be ignored.
protected java.lang.String	toString(BaseDataType bdt) Get the string representation of this instance.
protected void	writeArgument(java.io.OutputStream stream, java.lang.String target, java.lang.Object val, javax.servlet.http.HttpServletResponse response) Serialize this argument's value, considering the target format.
protected abstract 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.
void	writeArguments(java.lang.Object retVal, java.lang.Object[] args, LegacyServiceParameter[] serviceParameters, ArgumentsSerializer serializer, java.io.OutputStream stream, javax.servlet.http.HttpServletResponse response) Serialize this arguments, considering each target's format.
void	writeArguments(java.lang.Object retVal, java.lang.Object[] args, LegacyServiceParameter[] serviceParameters, java.io.OutputStream stream, javax.servlet.http.HttpServletResponse response) Serialize this arguments, considering each target's format.
void	writeArguments(java.lang.Object retVal, java.lang.Object[] args, RestService service, java.io.OutputStream stream, javax.servlet.http.HttpServletResponse response) Serialize this arguments, considering each target's format.
protected abstract 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.
abstract java.lang.String	writeError(LegacyError err) Serialize the error, to be included in the response.
protected abstract 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.
protected abstract java.lang.Object	writeTable(java.lang.String target, TableWrapper val) Serialize the specified table.

Methods inherited from class java.lang.Object

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

Field Detail

serializer

private java.lang.ThreadLocal<ArgumentsSerializer> serializer

The actual serializer to use for interpreting and writing the arguments.

Constructor Detail

ResponseArguments

public ResponseArguments()

Method Detail

writeError

public abstract java.lang.String writeError(LegacyError err)

Serialize the error, to be included in the response.

Parameters:

err - The error.

Returns:

The serialized version of the error.

writeArgumentInt

protected abstract 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.

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 abstract 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).

Parameters:

stream - The stream to write the parameters.

response - The servlet response.

Throws:

java.io.IOException

writeTable

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

Serialize the specified table.

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 abstract java.lang.Object writeDataSet(java.lang.String target,
                                                 DataSetContainer val)

Serialize the specified dataset.

Parameters:

target - The target OUTPUT parameter.

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

Returns:

The serialized version of this dataset.

ignoreUnknown

protected abstract boolean ignoreUnknown()

Determine if unknown values must be ignored.

Returns:

See above.

writeDataSet

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

Serialize the specified dataset.

Parameters:

target - The target OUTPUT parameter.

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

Returns:

The serialized version of this dataset.

writeExtentArgument

protected abstract 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.

Parameters:

stream - The response stream.

target - The argument's encoded target.

val - The argument's value.

response - The HTTP response.

Throws:

java.io.IOException

writeArguments

public void writeArguments(java.lang.Object retVal,
                           java.lang.Object[] args,
                           RestService service,
                           java.io.OutputStream stream,
                           javax.servlet.http.HttpServletResponse response)
                    throws java.io.IOException

Serialize this arguments, considering each target's format.

Parameters:

retVal - The return value.

args - The arguments.

service - The service handler.

stream - The HTTP response stream.

response - The HTTP response.

Throws:

java.io.IOException

writeArguments

public void writeArguments(java.lang.Object retVal,
                           java.lang.Object[] args,
                           LegacyServiceParameter[] serviceParameters,
                           java.io.OutputStream stream,
                           javax.servlet.http.HttpServletResponse response)
                    throws java.io.IOException

Serialize this arguments, considering each target's format.

Parameters:

retVal - The return value.

args - The arguments.

serviceParameters - The legacy service parameters.

stream - The HTTP response stream.

response - The HTTP response.

Throws:

java.io.IOException

writeArguments

public void writeArguments(java.lang.Object retVal,
                           java.lang.Object[] args,
                           LegacyServiceParameter[] serviceParameters,
                           ArgumentsSerializer serializer,
                           java.io.OutputStream stream,
                           javax.servlet.http.HttpServletResponse response)
                    throws java.io.IOException

Serialize this arguments, considering each target's format.

Parameters:

retVal - The return value.

args - The arguments.

serviceParameters - The legacy service parameters.

serializer - The serializer to use for interpreting and writing the arguments.

stream - The HTTP response stream.

response - The HTTP response.

Throws:

java.io.IOException

toString

protected java.lang.String toString(BaseDataType bdt)

Get the string representation of this instance.

Parameters:

bdt - The instance.

Returns:

The string representation, using DatatypeConverter.

writeArgument

protected final void writeArgument(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 value, considering the target format.

Parameters:

stream - The response stream.

target - The argument's encoded target.

val - The argument's value.

response - The HTTP response.

Throws:

java.io.IOException