com.aspc.cms.rest.plugin.v_class

Class RestClassV8

java.lang.Object

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

All Implemented Interfaces:

RestPluginConvertResult, RestPluginProcess, SwaggerFullList, SwaggerListVariables, SwaggerResponses

Direct Known Subclasses:

RestClassNamedV8

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

ReST service definition.

Notes

http://en.wikipedia.org/wiki/Representational_state_transfer

data model
THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else MULTI-THREADED

Since:

08 January 2014

Author:

Lei Gao

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	RestClassV8.FieldInfo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HEADER_MIN_CACHE_PERIOD
static java.lang.String	PARAMETER_CURSOR_ID
static java.lang.String	PARAMETER_FIELDS
static java.lang.String	PARAMETER_KEY
static java.lang.String	PARAMETER_QUERY
static java.lang.String	PARAMETER_TOUCH
static java.lang.String	PARAMETER_VALUES

Constructor Summary

Constructors

Constructor and Description
RestClassV8()

Method Summary

Modifier and Type	Method and Description
RestServerResponse	convertResult(RestDefinition rd, WebClient client, ContentType type, java.lang.Object value) Convert the result
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)
protected java.lang.String	getRawPath(java.lang.String param, RestDefinition rd)
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 static java.lang.String	makeJsonKey(java.lang.String key)
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)
static java.lang.Object	makeValue(DataSource ds, DBField field, java.lang.Object value) http://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC
protected static java.util.List<RestClassV8.FieldInfo>	parseFields(DBClass dbClass, java.lang.String[] fields)
static java.util.HashMap<java.lang.String,java.lang.String>	parseValues(java.lang.String values)
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.
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_KEY

public static final java.lang.String PARAMETER_KEY

See Also:

Constant Field Values

PARAMETER_FIELDS

public static final java.lang.String PARAMETER_FIELDS

See Also:

Constant Field Values

PARAMETER_VALUES

public static final java.lang.String PARAMETER_VALUES

See Also:

Constant Field Values

PARAMETER_QUERY

public static final java.lang.String PARAMETER_QUERY

See Also:

Constant Field Values

PARAMETER_CURSOR_ID

public static final java.lang.String PARAMETER_CURSOR_ID

See Also:

Constant Field Values

HEADER_MIN_CACHE_PERIOD

public static final java.lang.String HEADER_MIN_CACHE_PERIOD

See Also:

Constant Field Values

PARAMETER_TOUCH

public static final java.lang.String PARAMETER_TOUCH

See Also:

Constant Field Values

Constructor Detail

RestClassV8

public RestClassV8()

Method Detail

findClass

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

Throws:

ExceptionResponse

getClassRD

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

Throws:

java.lang.Exception

restRetrieve

public java.lang.Object restRetrieve(@Nullable
                                     WebClient client,
                                     @Nullable
                                     RestDefinition rd,
                                     @Nonnull
                                     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.

makeDefaultFields

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

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

Throws:

java.lang.Exception

makeKeyParameter

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

Throws:

java.lang.Exception

makeCachePeriod

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

Throws:

java.lang.Exception

makePath

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

makeHref

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

makeQuery

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

Throws:

java.lang.Exception

parseFields

@Nonnull
 @CheckReturnValue
protected static java.util.List<RestClassV8.FieldInfo> parseFields(@Nonnull
                                                                                               DBClass dbClass,
                                                                                               @Nonnull
                                                                                               java.lang.String[] fields)
                                                                                        throws InvalidPathException

Throws:

InvalidPathException

makeJsonKey

protected static java.lang.String makeJsonKey(java.lang.String key)

makeValue

@CheckReturnValue
 @Nullable
public static java.lang.Object makeValue(@Nonnull
                                                                      DataSource ds,
                                                                      @Nonnull
                                                                      DBField field,
                                                                      @Nullable
                                                                      java.lang.Object value)
                                                               throws java.lang.Exception

http://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC

Parameters:

ds - The datasource

field - The field

value - the value

Returns:

the value

Throws:

java.lang.Exception - a serious problem.

restCreate

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

getRawPath

protected java.lang.String getRawPath(@Nonnull
                                      java.lang.String param,
                                      @Nonnull
                                      RestDefinition rd)

parseValues

@Nonnull
 @CheckReturnValue
public static java.util.HashMap<java.lang.String,java.lang.String> parseValues(@Nullable
                                                                                                           java.lang.String values)
                                                                                                    throws java.lang.Exception

Throws:

java.lang.Exception

restUpdate

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

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

listSwaggerVariables

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

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

convertResult

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

describeResponse

public void describeResponse(WebClient client,
                             RestDefinition rd,
                             Method method,
                             JSONObject responses,
                             JSONObject operationObj,
                             java.lang.String restPath,
                             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.