com.aspc.cms.rest.plugin.proxy

Class RestSwaggerProxyV2

java.lang.Object

com.aspc.cms.rest.plugin.proxy.RestSwaggerProxyV2

All Implemented Interfaces:

RestPluginProcess, RestPluginSupportedMethods, SwaggerListVariables

Direct Known Subclasses:

PetProxyV2

public abstract class RestSwaggerProxyV2
extends java.lang.Object
implements RestPluginProcess, SwaggerListVariables, RestPluginSupportedMethods

Since:

21 March 2016

Version:

$Revision: 1.1 $

Author:

Lei Gao

Field Summary

Fields

Modifier and Type	Field and Description
protected static long	SYSTEM_START

Constructor Summary

Constructors

Constructor and Description
RestSwaggerProxyV2()

Method Summary

Modifier and Type	Method and Description
java.util.HashMap<java.lang.String,java.lang.String>	getMoreParameters(WebClient client)
protected abstract java.lang.String	getRestBaseURL()
protected abstract java.lang.String	getSwaggerCallName()
Method[]	listSupportedMethods() List of methods supported.
DBResult<RestDefinitionVariable>	listSwaggerVariables(Login login, RestDefinition rd, Method method, int mandatoryPathVariableDepth)
protected boolean	login(java.lang.String userId, java.lang.String password, WebClient client)
protected abstract JSONObject	makeSwaggerJSON()
void	onSuccess(WebClient client, RestDefinition rd, Response response)
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

Field Detail

SYSTEM_START

protected static final long SYSTEM_START

Constructor Detail

RestSwaggerProxyV2

public RestSwaggerProxyV2()

Method Detail

restRetrieve

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

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.

java.lang.IllegalArgumentException

getRestBaseURL

protected abstract java.lang.String getRestBaseURL()

restCreate

public java.lang.Object restCreate(WebClient client,
                                   RestDefinition rd,
                                   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

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

java.lang.IllegalArgumentException

restUpdate

public java.lang.Object restUpdate(WebClient client,
                                   RestDefinition rd,
                                   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

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

java.lang.IllegalArgumentException

restDelete

public java.lang.Object restDelete(WebClient client,
                                   RestDefinition rd,
                                   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

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

java.lang.IllegalArgumentException

getSwaggerCallName

protected abstract java.lang.String getSwaggerCallName()

makeSwaggerJSON

protected abstract JSONObject makeSwaggerJSON()
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getMoreParameters

public java.util.HashMap<java.lang.String,java.lang.String> getMoreParameters(WebClient client)

onSuccess

public void onSuccess(WebClient client,
                      @Nonnull
                      RestDefinition rd,
                      Response response)
               throws java.lang.Exception

Throws:

java.lang.Exception

listSwaggerVariables

public DBResult<RestDefinitionVariable> listSwaggerVariables(Login login,
                                                             RestDefinition rd,
                                                             Method method,
                                                             int mandatoryPathVariableDepth)
                                                      throws java.lang.Exception

Specified by:

listSwaggerVariables in interface SwaggerListVariables

Throws:

java.lang.Exception

listSupportedMethods

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

List of methods supported.

Specified by:

listSupportedMethods in interface RestPluginSupportedMethods

Returns:

the list of methods supported.

Throws:

java.lang.Exception

login

protected boolean login(java.lang.String userId,
                        java.lang.String password,
                        WebClient client)
                 throws java.lang.Exception

Throws:

java.lang.Exception