Class PreferenceSectionActionSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<UserPreferencesMiddlewareInput,PreferenceActionResponseV1,UserPreferencesExecutor>

com.kingsrook.qqq.middleware.javalin.specs.v1.PreferenceSectionActionSpecV1

public class PreferenceSectionActionSpecV1
extends AbstractEndpointSpec<UserPreferencesMiddlewareInput,PreferenceActionResponseV1,UserPreferencesExecutor>

Run an action on the signed-in user's preferences.

Field Summary

Fields inherited from class com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec

qInstance

Constructor Summary

Constructors

Constructor	Description
PreferenceSectionActionSpecV1()

Method Summary

Modifier and Type	Method	Description
UserPreferencesMiddlewareInput	buildInput(io.javalin.http.Context context)	Build the typed operation input.
BasicOperation	defineBasicOperation()	Run an action on the signed-in user's preferences
BasicResponse	defineBasicSuccessResponse()	The typed success response.
Map<String,Schema>	defineComponentSchemas()	Publish all preference component schemas.
RequestBody	defineRequestBody()	Action request contract.
List<Parameter>	defineRequestParameters()	Path parameters; userId query parameters are never read.
void	handleOutput(io.javalin.http.Context context, PreferenceActionResponseV1 output)	Serialize null preferences explicitly so clients can distinguish cleared values.
PreferenceActionResponseV1	serveRequest(AbstractMiddlewareVersion version, io.javalin.http.Context context)	Never cache this operation, including authentication and validation failures.

Methods inherited from class com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec

checkCredentialScopeOperation, customizeMethod, defineAdditionalBasicResponses, defineCompleteOperation, defineMethod, defineResponses, defineRoute, getOperationId, getRequestBodyAsJsonObject, getRequestParam, getRequestParamInteger, getRequestParamMap, handleException, isSecured, newExecutor, newOutput, setQInstance

Methods inherited from class java.lang.Object

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

Constructor Details

PreferenceSectionActionSpecV1

public PreferenceSectionActionSpecV1()

Method Details

serveRequest

public PreferenceActionResponseV1 serveRequest(AbstractMiddlewareVersion version,
 io.javalin.http.Context context)
                                        throws Exception

Never cache this operation, including authentication and validation failures.

Overrides:

serveRequest in class AbstractEndpointSpec<UserPreferencesMiddlewareInput,PreferenceActionResponseV1,UserPreferencesExecutor>

Throws:

Exception

defineBasicOperation

public BasicOperation defineBasicOperation()

Run an action on the signed-in user's preferences

Overrides:

defineBasicOperation in class AbstractEndpointSpec<UserPreferencesMiddlewareInput,PreferenceActionResponseV1,UserPreferencesExecutor>

defineRequestParameters

public List<Parameter> defineRequestParameters()

Path parameters; userId query parameters are never read.

Overrides:

defineRequestParameters in class AbstractEndpointSpec<UserPreferencesMiddlewareInput,PreferenceActionResponseV1,UserPreferencesExecutor>

buildInput

public UserPreferencesMiddlewareInput buildInput(io.javalin.http.Context context)
                                          throws Exception

Build the typed operation input.

Specified by:

buildInput in class AbstractEndpointSpec<UserPreferencesMiddlewareInput,PreferenceActionResponseV1,UserPreferencesExecutor>

Throws:

Exception

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Publish all preference component schemas.

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<UserPreferencesMiddlewareInput,PreferenceActionResponseV1,UserPreferencesExecutor>

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

The typed success response.

Overrides:

defineBasicSuccessResponse in class AbstractEndpointSpec<UserPreferencesMiddlewareInput,PreferenceActionResponseV1,UserPreferencesExecutor>

handleOutput

public void handleOutput(io.javalin.http.Context context,
 PreferenceActionResponseV1 output)

Serialize null preferences explicitly so clients can distinguish cleared values.

Overrides:

handleOutput in class AbstractEndpointSpec<UserPreferencesMiddlewareInput,PreferenceActionResponseV1,UserPreferencesExecutor>

defineRequestBody

public RequestBody defineRequestBody()

Action request contract.

Overrides:

defineRequestBody in class AbstractEndpointSpec<UserPreferencesMiddlewareInput,PreferenceActionResponseV1,UserPreferencesExecutor>