com.goldencode.p2j.rest

Class ServiceArgumentsParser

java.lang.Object

com.goldencode.p2j.rest.ServiceArgumentsParser

Direct Known Subclasses:

RequestArguments, SoapRequestParser

public abstract class ServiceArgumentsParser
extends java.lang.Object

Base class for parsing the input arguments for a web service call (REST or SOAP).

Constructor Summary

Constructors

Constructor and Description
ServiceArgumentsParser()

Method Summary

Modifier and Type	Method and Description
protected abstract void	assignArgument(int idx, BaseDataType bdt, java.lang.String sval) Assign the given argument to the specified value.
protected DatasetWrapper	createDataset(java.lang.String name, boolean input, boolean output, boolean asHandle) Create a new DatasetWrapper.
protected TableWrapper	createTable(java.lang.String name, boolean input, boolean output, boolean asHandle) Create a new TableWrapper.
protected abstract DatasetWrapper	loadDataSet(java.lang.String content) Load the specified dataset.
protected abstract 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 abstract java.lang.String	parseArgumentInt(java.lang.String body, java.lang.String source, javax.servlet.http.HttpServletRequest request) Parse the argument, by interpreting the request.
java.lang.Object[]	parseArguments(ArgumentsParser parser, LegacyServiceParameter[] serviceParameters, LegacyServiceParameter[] original, javax.servlet.http.HttpServletRequest request) Parse the arguments, by interpreting the request.
java.lang.Object[]	parseArguments(LegacyServiceParameter[] serviceParameters, LegacyServiceParameter[] original, javax.servlet.http.HttpServletRequest request) Parse the arguments, by interpreting the request.
java.lang.Object[]	parseArguments(RestService service, javax.servlet.http.HttpServletRequest request) Parse the arguments, by interpreting the request.
protected abstract 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.
(package private) BaseDataType	unknownInstance(java.lang.String type) Generate an unknown instance for the given type.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceArgumentsParser

public ServiceArgumentsParser()

Method Detail

parseExtentArgument

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

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 abstract void assignArgument(int idx,
                                       BaseDataType bdt,
                                       java.lang.String sval)
                                throws RequestArgumentError

Assign the given argument to the specified value.

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

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 abstract TableWrapper loadTable(java.lang.String content)
                                   throws java.io.IOException,
                                          RequestArgumentError

Load the specified table.

Parameters:

content - The table definition.

Returns:

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

Throws:

java.io.IOException

RequestArgumentError

loadDataSet

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

Load the specified dataset.

Parameters:

content - The dataset definition.

Returns:

A DatasetWrapper 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. This implementation by default returns null.

Parameters:

name - The dataset name.

input - The INPUT mode.

output - The OUTPUT mode.

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

Returns:

null by default.

createTable

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

Create a new TableWrapper. This implementation by default returns null.

Parameters:

name - The table name.

input - The INPUT mode.

output - The OUTPUT mode.

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

Returns:

null by default.

parseArguments

public final java.lang.Object[] parseArguments(RestService service,
                                               javax.servlet.http.HttpServletRequest request)
                                        throws java.io.IOException,
                                               RequestArgumentError

Parse the arguments, by interpreting the request.

For OUTPUT, they will be set to default value. For INPUT, they will be resolved from the request.

Parameters:

service - The service definition.

request - The request payload.

Returns:

The resolved arguments.

Throws:

java.io.IOException

RequestArgumentError

parseArguments

public final java.lang.Object[] parseArguments(LegacyServiceParameter[] serviceParameters,
                                               LegacyServiceParameter[] original,
                                               javax.servlet.http.HttpServletRequest request)
                                        throws java.io.IOException,
                                               RequestArgumentError

Parse the arguments, by interpreting the request.

For OUTPUT, they will be set to default value. For INPUT, they will be resolved from the request.

Parameters:

serviceParameters - The legacy service definition parameters.

original - The definition parameters.

request - The request payload.

Returns:

The resolved arguments.

Throws:

java.io.IOException

RequestArgumentError

parseArguments

public final java.lang.Object[] parseArguments(ArgumentsParser parser,
                                               LegacyServiceParameter[] serviceParameters,
                                               LegacyServiceParameter[] original,
                                               javax.servlet.http.HttpServletRequest request)
                                        throws java.io.IOException,
                                               RequestArgumentError

Parse the arguments, by interpreting the request.

For OUTPUT, they will be set to default value. For INPUT, they will be resolved from the request.

Parameters:

parser - The parser to be used for parsing the arguments

serviceParameters - The legacy service definition parameters.

original - The definition parameters.

request - The request payload.

Returns:

The resolved arguments.

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.

Parameters:

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

val - The attempted value to assign.

Throws:

RequestArgumentError

unknownInstance

BaseDataType unknownInstance(java.lang.String type)

Generate an unknown instance for the given type.

Parameters:

type - The parameter's type.

Returns:

The unknown instance.