com.aspc.cms.rest

Class RestSwaggerUtil

java.lang.Object

com.aspc.cms.rest.RestSwaggerUtil

public class RestSwaggerUtil
extends java.lang.Object

ReST utilities.

Since:

16 October 2014

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	ASSERT
static int	MAX_LIMIT_PER_PAGE
static java.lang.String	PROPERTY_REST_GRACE_PERIOD Environment variable for the grace period.

Method Summary

Modifier and Type	Method and Description
static JSONObject	docToJson(org.w3c.dom.Document doc) convert the xml document to a json object
static java.lang.Object	findPluginForClassname(DBObject obj) Generate the plugin object from the supplied class name
static ReadOnlyDataSource	getStandardReadDS(WebClient client, RestDefinition restDefinition)
static org.w3c.dom.Document	jsonToXML(WebClient client, JSONArray array)
static org.w3c.dom.Document	jsonToXML(WebClient client, JSONObject json)
static ContentType[]	listProducedTypes(RestDefinition rd, Method method) list the produced Types.
static Method[]	listSupportedMethods(RestDefinition rd) list the supported methods.
static java.util.TimeZone	magicTZ(DBMagicNumber magic)
static java.util.Date	makeCheckDate() The date to use for checking if this service has expired.
static java.util.Date	makeCheckDateWithGracePeriod(VirtualDB layer) get grace period ms
static int	makeLimit(WebClient client)
static int	makeOffset(WebClient client)
static void	sendErrorMessageJSON(HttpServletResponse response, RestExceptionResponse e)
static void	sendErrorMessageJSON(HttpServletResponse response, Status status, java.lang.String message, int subCode)
static void	sendErrorMessageJSON(HttpServletResponse response, Status status, java.lang.String message, int subCode, java.util.ArrayList<ExceptionResponse> list, java.lang.String name)
static void	sendErrorMessageXML(HttpServletResponse response, Status status, java.lang.String message, int subCode)

Methods inherited from class java.lang.Object

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

Field Detail

ASSERT

public static final boolean ASSERT

MAX_LIMIT_PER_PAGE

public static final int MAX_LIMIT_PER_PAGE

See Also:

Constant Field Values

PROPERTY_REST_GRACE_PERIOD

public static final java.lang.String PROPERTY_REST_GRACE_PERIOD

Environment variable for the grace period.

See Also:

Constant Field Values

Method Detail

makeCheckDate

@Nonnull
 @CheckReturnValue
public static java.util.Date makeCheckDate()

The date to use for checking if this service has expired.

Returns:

now or a month from now if in ASSERT mode.

makeCheckDateWithGracePeriod

@Nonnull
 @CheckReturnValue
public static java.util.Date makeCheckDateWithGracePeriod(@Nonnull
                                                                                      VirtualDB layer)
                                                                               throws RestExceptionResponse

get grace period ms

Parameters:

layer - the layer to check.

Returns:

3 months of grace period in ms if assert is false and DBSysPrefs.isRestGracePeroid = true

Throws:

RestExceptionResponse - could not calculate grace period.

findPluginForClassname

@Nullable
 @CheckReturnValue
public static java.lang.Object findPluginForClassname(DBObject obj)
                                                                            throws ExceptionResponse

Generate the plugin object from the supplied class name

Parameters:

obj - the definition or transform

Returns:

the value

Throws:

ExceptionResponse - a serious problem

listSupportedMethods

@Nonnull
 @CheckReturnValue
public static Method[] listSupportedMethods(@Nonnull
                                                                        RestDefinition rd)
                                                                 throws java.lang.Exception

list the supported methods.

Parameters:

rd - the definition

Returns:

the list of methods supported.

Throws:

java.lang.Exception

listProducedTypes

@Nonnull
 @CheckReturnValue
public static ContentType[] listProducedTypes(@Nonnull
                                                                          RestDefinition rd,
                                                                          @Nullable
                                                                          Method method)
                                                                   throws ExceptionResponse

list the produced Types.

Parameters:

rd - the definition

method - the method to handle.

Returns:

the list of types produced.

Throws:

ExceptionResponse

makeOffset

@CheckReturnValue
 @Nonnegative
public static int makeOffset(@Nonnull
                                                             WebClient client)
                                                      throws ExceptionResponse

Throws:

ExceptionResponse

makeLimit

@CheckReturnValue
 @Nonnegative
public static int makeLimit(@Nonnull
                                                            WebClient client)
                                                     throws ExceptionResponse

Throws:

ExceptionResponse

jsonToXML

@Nonnull
 @CheckReturnValue
public static org.w3c.dom.Document jsonToXML(@Nonnull
                                                                         WebClient client,
                                                                         @Nonnull
                                                                         JSONObject json)
                                                                  throws java.lang.Exception

Throws:

java.lang.Exception

jsonToXML

@Nonnull
 @CheckReturnValue
public static org.w3c.dom.Document jsonToXML(@Nonnull
                                                                         WebClient client,
                                                                         @Nonnull
                                                                         JSONArray array)
                                                                  throws java.lang.Exception

Throws:

java.lang.Exception

sendErrorMessageJSON

public static void sendErrorMessageJSON(@Nonnull
                                        HttpServletResponse response,
                                        @Nonnull
                                        RestExceptionResponse e)
                                 throws java.io.IOException

Throws:

java.io.IOException

sendErrorMessageJSON

public static void sendErrorMessageJSON(@Nonnull
                                        HttpServletResponse response,
                                        @Nonnull
                                        Status status,
                                        @Nonnull
                                        java.lang.String message,
                                        int subCode)
                                 throws java.io.IOException

Throws:

java.io.IOException

sendErrorMessageJSON

public static void sendErrorMessageJSON(@Nonnull
                                        HttpServletResponse response,
                                        @Nonnull
                                        Status status,
                                        @Nonnull
                                        java.lang.String message,
                                        int subCode,
                                        @Nullable
                                        java.util.ArrayList<ExceptionResponse> list,
                                        @Nullable
                                        java.lang.String name)
                                 throws java.io.IOException

Throws:

java.io.IOException

sendErrorMessageXML

public static void sendErrorMessageXML(@Nonnull
                                       HttpServletResponse response,
                                       @Nonnull
                                       Status status,
                                       @Nonnull
                                       java.lang.String message,
                                       int subCode)
                                throws java.io.IOException

Parameters:

response -

status -

message -

subCode -

Throws:

java.io.IOException

getStandardReadDS

@Nonnull
 @CheckReturnValue
public static ReadOnlyDataSource getStandardReadDS(@Nonnull
                                                                               WebClient client,
                                                                               @Nonnull
                                                                               RestDefinition restDefinition)
                                                                        throws java.lang.Exception

Throws:

java.lang.Exception

magicTZ

@CheckReturnValue
 @Nonnull
public static java.util.TimeZone magicTZ(@Nonnull
                                                                     DBMagicNumber magic)

docToJson

public static JSONObject docToJson(org.w3c.dom.Document doc)

convert the xml document to a json object

Parameters:

doc - the document

Returns:

json