com.aspc.cms.rest.plugin.sync

Class RestSyncV7

java.lang.Object

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

All Implemented Interfaces:

RestPluginProcess, SwaggerFullList, SwaggerListVariables, SwaggerResponses

Direct Known Subclasses:

RestSyncNamedV7

public class RestSyncV7
extends java.lang.Object
implements RestPluginProcess, SwaggerListVariables, SwaggerFullList, SwaggerResponses

Allow synchronizing data to external systems.

Since:

17 December 2014

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	PARAMETER_CLASS
protected static java.lang.String	PARAMETER_NEXT_URL_WITHOUT_PATHS
protected static java.lang.String	PARAMETER_PATHS

Constructor Summary

Constructors

Constructor and Description
RestSyncV7()

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 java.lang.String	getBaseURI(RestDefinition rd)
DBResult<RestDefinitionVariable>	listSwaggerVariables(Login login, RestDefinition rd, Method method, int mandatoryPathVariableDepth)
protected java.lang.String	makeClassNames(WebClient client, RestDefinition rd)
java.lang.String	makeNext(RestDefinition rd, DBClass[] classList, java.util.Date from, VirtualDB layer, Path[] pathArray, boolean nextUrlWithoutPaths, boolean includeLayer, long untilTS, int offset, boolean truncated, java.util.Date since)
protected java.lang.String	makeNextUrlWithoutPaths(WebClient client, RestDefinition rd)
protected java.lang.String	makePaths(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.
java.lang.String[]	swaggerFullList(Login login, RestDefinition rd, Method method, RestDefinitionVariable v, java.lang.String[] list)

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

Field Detail

PARAMETER_CLASS

protected static final java.lang.String PARAMETER_CLASS

See Also:

Constant Field Values

PARAMETER_PATHS

protected static final java.lang.String PARAMETER_PATHS

See Also:

Constant Field Values

PARAMETER_NEXT_URL_WITHOUT_PATHS

protected static final java.lang.String PARAMETER_NEXT_URL_WITHOUT_PATHS

See Also:

Constant Field Values

Constructor Detail

RestSyncV7

public RestSyncV7()

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

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

Throws:

java.lang.Exception

makeClassNames

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

Throws:

java.lang.Exception

makeNextUrlWithoutPaths

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

Throws:

java.lang.Exception

makeNext

@CheckReturnValue
 @Nonnull
public java.lang.String makeNext(@Nonnull
                                                             RestDefinition rd,
                                                             @Nonnull
                                                             DBClass[] classList,
                                                             @Nonnull
                                                             java.util.Date from,
                                                             @Nonnull
                                                             VirtualDB layer,
                                                             @Nullable
                                                             Path[] pathArray,
                                                             boolean nextUrlWithoutPaths,
                                                             boolean includeLayer,
                                                             long untilTS,
                                                             int offset,
                                                             boolean truncated,
                                                             @Nonnull
                                                             java.util.Date since)

getBaseURI

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

describeResponse

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

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.

restCreate

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

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

restUpdate

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

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

restDelete

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

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

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

Throws:

java.lang.Exception

swaggerFullList

public java.lang.String[] swaggerFullList(@Nonnull
                                          Login login,
                                          @Nonnull
                                          RestDefinition rd,
                                          @Nonnull
                                          Method method,
                                          @Nonnull
                                          RestDefinitionVariable v,
                                          @Nonnull
                                          java.lang.String[] list)
                                   throws java.lang.Exception

Specified by:

swaggerFullList in interface SwaggerFullList

Throws:

java.lang.Exception