com.aspc.cms.rest.swagger

Class RestAPIDocs

java.lang.Object

com.aspc.cms.rest.swagger.RestAPIDocs

All Implemented Interfaces:

RestPluginProcess

public class RestAPIDocs
extends java.lang.Object
implements RestPluginProcess

Since:

29 April 2015

Author:

Lei Gao

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FIELD_DEFINITIONS_PREFX
static java.lang.String	FIELD_DESCRIPTION
static java.lang.String	FIELD_ENUM
static java.lang.String	FIELD_FORMAT
static java.lang.String	FIELD_NAME
static java.lang.String	FIELD_PARAMETERS
static java.lang.String	FIELD_REF
static java.lang.String	FIELD_REQUIRED
static java.lang.String	FIELD_SCHEMA
static java.lang.String	FIELD_TYPE

Constructor Summary

Constructors

Constructor and Description
RestAPIDocs()

Method Summary

Modifier and Type	Method and Description
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 restDefinition, 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.

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_DESCRIPTION

public static final java.lang.String FIELD_DESCRIPTION

See Also:

Constant Field Values

FIELD_PARAMETERS

public static final java.lang.String FIELD_PARAMETERS

See Also:

Constant Field Values

FIELD_ENUM

public static final java.lang.String FIELD_ENUM

See Also:

Constant Field Values

FIELD_NAME

public static final java.lang.String FIELD_NAME

See Also:

Constant Field Values

FIELD_REQUIRED

public static final java.lang.String FIELD_REQUIRED

See Also:

Constant Field Values

FIELD_SCHEMA

public static final java.lang.String FIELD_SCHEMA

See Also:

Constant Field Values

FIELD_TYPE

public static final java.lang.String FIELD_TYPE

See Also:

Constant Field Values

FIELD_FORMAT

public static final java.lang.String FIELD_FORMAT

See Also:

Constant Field Values

FIELD_REF

public static final java.lang.String FIELD_REF

See Also:

Constant Field Values

FIELD_DEFINITIONS_PREFX

public static final java.lang.String FIELD_DEFINITIONS_PREFX

See Also:

Constant Field Values

Constructor Detail

RestAPIDocs

public RestAPIDocs()

Method Detail

restRetrieve

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

restDefinition - 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.

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