com.aspc.cms.rest.plugin.wrapper

Class RestSyncNamedV7

java.lang.Object

com.aspc.cms.rest.plugin.sync.RestSyncV7

com.aspc.cms.rest.plugin.wrapper.RestSyncNamedV7

All Implemented Interfaces:

RestPluginProcess, SwaggerFullList, SwaggerListVariables, SwaggerResponses

public class RestSyncNamedV7
extends RestSyncV7
implements SwaggerListVariables, SwaggerResponses

Since:

15 Oct 2018

Author:

Parminder Singh

Field Summary

Fields inherited from class com.aspc.cms.rest.plugin.sync.RestSyncV7

PARAMETER_CLASS, PARAMETER_NEXT_URL_WITHOUT_PATHS, PARAMETER_PATHS

Constructor Summary

Constructors

Constructor and Description
RestSyncNamedV7()

Method Summary

Modifier and Type	Method and Description
void	describeResponse(WebClient client, RestDefinition rd, Method method, JSONObject responses, JSONObject operationObj, java.lang.String restPath, JSONObject definitions) describe the response format.
protected DBClassConcrete	findClass(RestDefinition rd, WebClient client)
protected java.lang.String	getBaseURI(RestDefinition rd)
protected RestDefinition	getClassRD(RestDefinition restDefinition)
DBResult<RestDefinitionVariable>	listSwaggerVariables(Login login, RestDefinition rd, Method method, int mandatoryPathVariableDepth)
protected java.lang.String	makeClassNames(WebClient client, RestDefinition rd)
protected java.lang.String	makeNextUrlWithoutPaths(WebClient client, RestDefinition rd)
protected java.lang.String	makePaths(WebClient client, RestDefinition rd)
java.lang.Object	restRetrieve(WebClient client, RestDefinition rd, ReadOnlyDataSource rds) HTTP GET calls the the Retrieval ReST service.

Methods inherited from class com.aspc.cms.rest.plugin.sync.RestSyncV7

makeNext, restCreate, restDelete, restUpdate, swaggerFullList

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aspc.cms.rest.swagger.SwaggerResponses

createArrayProperty, createBooleanProperty, createIntegerProperty, createNumberProperty, createObjectProperty, createStringProperty, getStandardProperty

Constructor Detail

RestSyncNamedV7

public RestSyncNamedV7()

Method Detail

restRetrieve

@CheckReturnValue
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

Overrides:

restRetrieve in class RestSyncV7

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.

makePaths

@CheckReturnValue
 @Nonnull
protected java.lang.String makePaths(@Nonnull
                                                                 WebClient client,
                                                                 @Nonnull
                                                                 RestDefinition rd)
                                                          throws java.lang.Exception

Overrides:

makePaths in class RestSyncV7

Throws:

java.lang.Exception

makeClassNames

@CheckReturnValue
 @Nonnull
protected java.lang.String makeClassNames(@Nonnull
                                                                      WebClient client,
                                                                      @Nonnull
                                                                      RestDefinition rd)
                                                               throws java.lang.Exception

Overrides:

makeClassNames in class RestSyncV7

Throws:

java.lang.Exception

makeNextUrlWithoutPaths

@CheckReturnValue
 @Nonnull
protected java.lang.String makeNextUrlWithoutPaths(@Nonnull
                                                                               WebClient client,
                                                                               @Nonnull
                                                                               RestDefinition rd)
                                                                        throws java.lang.Exception

Overrides:

makeNextUrlWithoutPaths in class RestSyncV7

Throws:

java.lang.Exception

getBaseURI

protected java.lang.String getBaseURI(@Nonnull
                                      RestDefinition rd)

Overrides:

getBaseURI in class RestSyncV7

listSwaggerVariables

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

Specified by:

listSwaggerVariables in interface SwaggerListVariables

Overrides:

listSwaggerVariables in class RestSyncV7

Throws:

java.lang.Exception

getClassRD

protected RestDefinition getClassRD(@Nonnull
                                    RestDefinition restDefinition)
                             throws java.lang.Exception

Throws:

java.lang.Exception

findClass

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

Throws:

ExceptionResponse

describeResponse

public void describeResponse(@Nonnull
                             WebClient client,
                             @Nonnull
                             RestDefinition rd,
                             @Nonnull
                             Method method,
                             @Nonnull
                             JSONObject responses,
                             @Nonnull
                             JSONObject operationObj,
                             @Nonnull
                             java.lang.String restPath,
                             @Nonnull
                             JSONObject definitions)
                      throws java.lang.Exception

Description copied from interface: SwaggerResponses

describe the response format. Check https://swagger.io/docs/specification/describing-responses/ for details

sample:

  {
      "200": {
          "description": "successful operation",
          "schema": {
              "$ref": "#/definitions/class_v8_GET"
          }
      },
      "404": {
          "description": "Not found"
      }
  }
 

Specified by:

describeResponse in interface SwaggerResponses

Overrides:

describeResponse in class RestSyncV7

Parameters:

client - web client

rd - rest definition

method - method

responses - JSONObject that holds the responses

operationObj - the operation json for this service, such as GET /v8/class/Person/{_key} and GET /v8/class/Person are two different operation json

restPath - rest path such as /v8/class/{className}/{_key}

definitions - $ref definition JSONObject

Throws:

java.lang.Exception - a serious problem.