com.aspc.cms.rest.plugin

Class RestSpell

java.lang.Object

com.aspc.cms.rest.plugin.RestSpell

All Implemented Interfaces:

RestPluginConvertResult, RestPluginProcess, RestPluginSupportedMethods

public class RestSpell
extends java.lang.Object
implements RestPluginProcess, RestPluginConvertResult, RestPluginSupportedMethods

Since:

27 February 2015

Author:

Lei Gao

Constructor Summary

Constructors

Constructor and Description
RestSpell()

Method Summary

Modifier and Type	Method and Description
RestServerResponse	convertResult(RestDefinition rd, WebClient client, ContentType type, java.lang.Object value) Convert the result
Method[]	listSupportedMethods() List of methods supported.
java.lang.Object	restCreate(WebClient client, RestDefinition rd, MutableDataSource mds) HTTP POST calls the the Create ReST service.
java.lang.Object	restDelete(WebClient client, RestDefinition rd, 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 rd, 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

Constructor Detail

RestSpell

public RestSpell()

Method Detail

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 rd,
                                   MutableDataSource mds)
                            throws java.lang.Exception

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

rd - 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

restUpdate

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

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

rd - 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

restDelete

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

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

rd - 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

convertResult

public RestServerResponse convertResult(RestDefinition rd,
                                        WebClient client,
                                        ContentType type,
                                        java.lang.Object value)
                                 throws java.lang.Exception

Description copied from interface: RestPluginConvertResult

Convert the result

Specified by:

convertResult in interface RestPluginConvertResult

Parameters:

rd - the definition

client - the client

type - the target type

value - the value to be converted.

Returns:

the result value.

Throws:

java.lang.Exception - a serious problem.

listSupportedMethods

public Method[] listSupportedMethods()
                              throws java.lang.Exception

Description copied from interface: RestPluginSupportedMethods

List of methods supported.

Specified by:

listSupportedMethods in interface RestPluginSupportedMethods

Returns:

the list of methods supported.

Throws:

java.lang.Exception