com.aspc.cms.rest.plugin.wrapper

Class RestClassNamedV8

java.lang.Object

com.aspc.cms.rest.plugin.v_class.RestClassV8

com.aspc.cms.rest.plugin.wrapper.RestClassNamedV8

All Implemented Interfaces:

RestPluginConvertResult, RestPluginProcess, SwaggerFullList, SwaggerIsApplicable, SwaggerListVariables, SwaggerResponses

public class RestClassNamedV8
extends RestClassV8
implements SwaggerListVariables, SwaggerIsApplicable

Since:

08 January 2014

Author:

Lei Gao

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.cms.rest.plugin.v_class.RestClassV8

RestClassV8.FieldInfo

Field Summary

Fields inherited from class com.aspc.cms.rest.plugin.v_class.RestClassV8

HEADER_MIN_CACHE_PERIOD, PARAMETER_CURSOR_ID, PARAMETER_FIELDS, PARAMETER_KEY, PARAMETER_QUERY, PARAMETER_TOUCH, PARAMETER_VALUES

Constructor Summary

Constructors

Constructor and Description
RestClassNamedV8()

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 RestDefinition	getClassRD(RestDefinition restDefinition)
boolean	isApplicable(Login login, RestDefinition rd, Method method)
DBResult<RestDefinitionVariable>	listSwaggerVariables(Login login, RestDefinition rd, Method method, int mandatoryPathVariableDepth)
protected java.lang.String	makeCachePeriod(WebClient client, RestDefinition rd)
protected java.lang.String[]	makeDefaultFields(WebClient client, RestDefinition rd, DBClassConcrete dbClass)
protected java.lang.String[]	makeFieldList(WebClient client, RestDefinition rd, DBClassConcrete dbClass)
protected java.lang.String	makeHref(RestDefinition rd, DBClassConcrete dbClass)
protected java.lang.String	makeKeyParameter(WebClient client, RestDefinition rd)
protected java.lang.String	makePath(RestDefinition rd, DBClassConcrete dbClass)
protected java.lang.String	makeQuery(WebClient client, RestDefinition rd)

Methods inherited from class com.aspc.cms.rest.plugin.v_class.RestClassV8

convertResult, getRawPath, makeJsonKey, makeValue, parseFields, parseValues, restCreate, restDelete, restRetrieve, 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

RestClassNamedV8

public RestClassNamedV8()

Method Detail

findClass

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

Overrides:

findClass in class RestClassV8

Throws:

ExceptionResponse

makePath

@CheckReturnValue
 @Nonnull
protected java.lang.String makePath(@Nonnull
                                                                RestDefinition rd,
                                                                @Nonnull
                                                                DBClassConcrete dbClass)

Overrides:

makePath in class RestClassV8

getClassRD

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

Overrides:

getClassRD in class RestClassV8

Throws:

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

Overrides:

listSwaggerVariables in class RestClassV8

Throws:

java.lang.Exception

makeFieldList

@CheckReturnValue
 @Nonnull
protected java.lang.String[] makeFieldList(@Nullable
                                                                       WebClient client,
                                                                       @Nonnull
                                                                       RestDefinition rd,
                                                                       @Nonnull
                                                                       DBClassConcrete dbClass)
                                                                throws java.lang.Exception

Overrides:

makeFieldList in class RestClassV8

Throws:

java.lang.Exception

makeDefaultFields

@CheckReturnValue
 @Nonnull
protected java.lang.String[] makeDefaultFields(@Nullable
                                                                           WebClient client,
                                                                           @Nonnull
                                                                           RestDefinition rd,
                                                                           @Nonnull
                                                                           DBClassConcrete dbClass)
                                                                    throws java.lang.Exception

Overrides:

makeDefaultFields in class RestClassV8

Throws:

java.lang.Exception

makeKeyParameter

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

Overrides:

makeKeyParameter in class RestClassV8

Throws:

java.lang.Exception

makeCachePeriod

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

Overrides:

makeCachePeriod in class RestClassV8

Throws:

java.lang.Exception

makeHref

@CheckReturnValue
 @Nonnull
protected java.lang.String makeHref(@Nonnull
                                                                RestDefinition rd,
                                                                @Nonnull
                                                                DBClassConcrete dbClass)

Overrides:

makeHref in class RestClassV8

makeQuery

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

Overrides:

makeQuery in class RestClassV8

Throws:

java.lang.Exception

isApplicable

@CheckReturnValue
public boolean isApplicable(@Nonnull
                                              Login login,
                                              @Nonnull
                                              RestDefinition rd,
                                              @Nonnull
                                              Method method)
                                       throws java.lang.Exception

Specified by:

isApplicable in interface SwaggerIsApplicable

Throws:

java.lang.Exception

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

Overrides:

describeResponse in class RestClassV8

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.