com.aspc.cms.rest.plugin.aggregate

Class RestAggregateV2

java.lang.Object

com.aspc.cms.rest.plugin.aggregate.RestAggregateV2

All Implemented Interfaces:

RestPluginProcess

public class RestAggregateV2
extends java.lang.Object
implements RestPluginProcess

ReST service definition.

Notes

http://en.wikipedia.org/wiki/Representational_state_transfer

data model
THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else MULTI-THREADED

Since:

08 January 2014

Author:

Lei Gao

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARAMETER_FIELDS
static java.lang.String	PARAMETER_QUERY
static int	VERSION

Constructor Summary

Constructors

Constructor and Description
RestAggregateV2()

Method Summary

Modifier and Type	Method and Description
protected DBClassConcrete	findClass(WebClient client, RestDefinition rd)
java.lang.Object	restCreate(WebClient client, RestDefinition restDefinition, MutableDataSource mds) HTTP POST calls the the Create ReST service.
java.lang.Object	restDelete(WebClient client, RestDefinition restDefinition, MutableDataSource mds) HTTP DELETE calls the the Delete ReST service.
java.lang.Object	restRetrieve(WebClient client, RestDefinition rd, ReadOnlyDataSource rds) HTTP GET calls the the Retrieval ReST service.
java.lang.Object	restUpdate(WebClient client, RestDefinition restDefinition, MutableDataSource mds) HTTP PUT calls the the Update ReST service.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final int VERSION

See Also:

Constant Field Values

PARAMETER_FIELDS

public static final java.lang.String PARAMETER_FIELDS

See Also:

Constant Field Values

PARAMETER_QUERY

public static final java.lang.String PARAMETER_QUERY

See Also:

Constant Field Values

Constructor Detail

RestAggregateV2

public RestAggregateV2()

Method Detail

findClass

protected DBClassConcrete findClass(WebClient client,
                                    RestDefinition rd)
                             throws ExceptionResponse

Throws:

ExceptionResponse

restRetrieve

public java.lang.Object restRetrieve(WebClient client,
                                     RestDefinition rd,
                                     ReadOnlyDataSource rds)
                              throws java.lang.Exception

Description copied from interface: RestPluginProcess

HTTP GET calls the the Retrieval ReST service.

Specified by:

restRetrieve in interface RestPluginProcess

Parameters:

client - the client. Null means check only of ops

rd - the definition

rds - the data source to use

Returns:

the JSON object/array if processed.

Throws:

java.lang.UnsupportedOperationException - if this method is NOT supported.

java.lang.Exception - an error has occurred.

restCreate

public java.lang.Object restCreate(WebClient client,
                                   RestDefinition restDefinition,
                                   MutableDataSource mds)
                            throws java.lang.UnsupportedOperationException,
                                   java.lang.Exception,
                                   java.lang.IllegalArgumentException

Description copied from interface: RestPluginProcess

HTTP POST calls the the Create ReST service.

Specified by:

restCreate in interface RestPluginProcess

Parameters:

client - the client. Null means check only of ops

restDefinition - the definition

mds - the data source to use

Returns:

the JSON object/array if processed.

Throws:

java.lang.UnsupportedOperationException - if this method is NOT supported.

ExceptionResponse - an error has occurred.

java.lang.Exception

java.lang.IllegalArgumentException

restUpdate

public java.lang.Object restUpdate(WebClient client,
                                   RestDefinition restDefinition,
                                   MutableDataSource mds)
                            throws java.lang.UnsupportedOperationException,
                                   java.lang.Exception,
                                   java.lang.IllegalArgumentException

Description copied from interface: RestPluginProcess

HTTP PUT calls the the Update ReST service.

Specified by:

restUpdate in interface RestPluginProcess

Parameters:

client - the client. Null means check only of ops

restDefinition - the definition

mds - the data source to use

Returns:

the JSON object/array if processed.

Throws:

java.lang.UnsupportedOperationException - if this method is NOT supported.

ExceptionResponse - an error has occurred.

java.lang.Exception

java.lang.IllegalArgumentException

restDelete

public java.lang.Object restDelete(WebClient client,
                                   RestDefinition restDefinition,
                                   MutableDataSource mds)
                            throws java.lang.UnsupportedOperationException,
                                   java.lang.Exception,
                                   java.lang.IllegalArgumentException

Description copied from interface: RestPluginProcess

HTTP DELETE calls the the Delete ReST service.

Specified by:

restDelete in interface RestPluginProcess

Parameters:

client - the client. Null means check only of ops

restDefinition - the definition

mds - the data source to use.

Returns:

the JSON object/array if processed.

Throws:

java.lang.UnsupportedOperationException - if this method is NOT supported.

ExceptionResponse - an error has occurred.

java.lang.Exception

java.lang.IllegalArgumentException