com.aspc.cms.rest

Interface RestPluginProcess

All Known Implementing Classes:

AnswersV1, AnswerV1, CallLogRestPlugin, ClientReportChartsV1, ClientReportV1, DavPlugin, DesignerRestPlugin, EchoV1, ExpressInterest, ExpressInterestV2, FullCalendarJsonPlugin, GoogleChart, JavaScriptErrorLogger, LoginKeyV1, LoginV1, MailCSS, PackageJSON, PayrollV1, PetProxyV2, ResetPasswordBegin, ResetPasswordConfirm, ResetPasswordFind, ResetPasswordSend, ResetPasswordSendV2, ResetPasswordUpdate, RestAggregateV2, RestAlert, RestAPIDocs, RestAPIDocsV3, RestArticle, RestArtwork, RestCharCount, RestClassIntervalCount, RestClassNamedV8, RestClassV8, RestCountV2, RestCountV3, RestCustomizedPrefColumn, RestDataDefinitionLanguageV1, RestDefinition, RestDefinitionSQL, RestDeleteMapping, RestEmailReportV1, RestEmailV1, RestEmailV2, RestFileCDN, RestFileDownload, RestFileUpload, RestFormV1, RestFullCalendarV2, RestGanttV1, RestGroupByV1, RestJIRAWebHooks, RestJQGrid, RestLegacyV1, RestMonitorHealthV1, RestMonitorListV1, RestOAuthApp, RestOAuthCallback, RestPreference, RestProductListV1, RestProductV1, RestPropertyMatcher, RestRowCountV1, RestScreenComponent, RestScreenV1, RestScript, RestSendReportToS3_v1, RestSession, RestSmegFullCalendar, RestSpell, RestSwaggerProxyV2, RestSyncNamedV7, RestSyncV7, RestSystemBeatV1, RestSystemDetailV1, RestSystemErrorV1, RestSystemLockV1, RestSystemNextV1, RestSystemV1, RestTest, RestTestTooManyCalls, RestTimeSheet, RestToken, RestTransaction, RestTransactionClassV1, RestTransactionDetails, RestTransactionHead, RestTransactionListV1, RestTransactionRecord, RestUnlinkCSS, SafeHtmlV1, SalesOPTimeLinePlugin, SessionV1, StateV1, TanRestEmailV2, TaskAnswersV1, TimeLineJsonPlugin, TimeMapJsonPlugin, ValidateDevice, ValidateOTP

public interface RestPluginProcess

A ReST plugin can be defined to override the default behaviour of the ReST service.

Since:

08 January 2014

Author:

Lei Gao

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.

Method Detail

restRetrieve

@CheckReturnValue
 @Nonnull
java.lang.Object restRetrieve(@Nonnull
                                                          WebClient client,
                                                          @Nonnull
                                                          RestDefinition restDefinition,
                                                          @Nonnull
                                                          ReadOnlyDataSource rds)
                                                   throws java.lang.UnsupportedOperationException,
                                                          java.lang.Exception,
                                                          java.lang.IllegalArgumentException

HTTP GET calls the the Retrieval ReST service.

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.

java.lang.IllegalArgumentException

restCreate

@CheckReturnValue
 @Nonnull
java.lang.Object restCreate(@Nonnull
                                                        WebClient client,
                                                        @Nonnull
                                                        RestDefinition restDefinition,
                                                        @Nonnull
                                                        MutableDataSource mds)
                                                 throws java.lang.UnsupportedOperationException,
                                                        java.lang.Exception,
                                                        java.lang.IllegalArgumentException

HTTP POST calls the the Create ReST service.

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

java.lang.IllegalArgumentException

restUpdate

@CheckReturnValue
 @Nonnull
java.lang.Object restUpdate(@Nonnull
                                                        WebClient client,
                                                        @Nonnull
                                                        RestDefinition restDefinition,
                                                        @Nonnull
                                                        MutableDataSource mds)
                                                 throws java.lang.UnsupportedOperationException,
                                                        java.lang.Exception,
                                                        java.lang.IllegalArgumentException

HTTP PUT calls the the Update ReST service.

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

java.lang.IllegalArgumentException

restDelete

@CheckReturnValue
 @Nonnull
java.lang.Object restDelete(@Nonnull
                                                        WebClient client,
                                                        @Nonnull
                                                        RestDefinition restDefinition,
                                                        @Nonnull
                                                        MutableDataSource mds)
                                                 throws java.lang.UnsupportedOperationException,
                                                        java.lang.Exception,
                                                        java.lang.IllegalArgumentException

HTTP DELETE calls the the Delete ReST service.

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

java.lang.IllegalArgumentException