Class PreferencesSpecV1

java.lang.Object

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

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

public class PreferencesSpecV1
extends AbstractEndpointSpec<UserPreferencesMiddlewareInput,PreferencesResponseV1,UserPreferencesExecutor>

List visible sections and 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
PreferencesSpecV1()

Method Summary

Modifier and Type	Method	Description
UserPreferencesMiddlewareInput	buildInput(io.javalin.http.Context context)	Build the typed operation input.
BasicOperation	defineBasicOperation()	List visible sections and the signed-in user's preferences
BasicResponse	defineBasicSuccessResponse()	The typed success response.
Map<String,Schema>	defineComponentSchemas()	Publish all preference component schemas.
List<Parameter>	defineRequestParameters()	Path parameters; userId query parameters are never read.
void	handleOutput(io.javalin.http.Context context, PreferencesResponseV1 output)	Serialize null preferences explicitly so clients can distinguish cleared values.

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

PreferencesSpecV1

public PreferencesSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

List visible sections and the signed-in user's preferences

Overrides:

defineBasicOperation in class AbstractEndpointSpec<UserPreferencesMiddlewareInput,PreferencesResponseV1,UserPreferencesExecutor>

defineRequestParameters

public List<Parameter> defineRequestParameters()

Path parameters; userId query parameters are never read.

Overrides:

defineRequestParameters in class AbstractEndpointSpec<UserPreferencesMiddlewareInput,PreferencesResponseV1,UserPreferencesExecutor>

buildInput

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

Build the typed operation input.

Specified by:

buildInput in class AbstractEndpointSpec<UserPreferencesMiddlewareInput,PreferencesResponseV1,UserPreferencesExecutor>

Throws:

Exception

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Publish all preference component schemas.

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<UserPreferencesMiddlewareInput,PreferencesResponseV1,UserPreferencesExecutor>

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

The typed success response.

Overrides:

defineBasicSuccessResponse in class AbstractEndpointSpec<UserPreferencesMiddlewareInput,PreferencesResponseV1,UserPreferencesExecutor>

handleOutput

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

Serialize null preferences explicitly so clients can distinguish cleared values.

Overrides:

handleOutput in class AbstractEndpointSpec<UserPreferencesMiddlewareInput,PreferencesResponseV1,UserPreferencesExecutor>