Class ManageSessionSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<ManageSessionInput,ManageSessionResponseV1,ManageSessionExecutor>

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

public class ManageSessionSpecV1
extends AbstractEndpointSpec<ManageSessionInput,ManageSessionResponseV1,ManageSessionExecutor>

Field Summary

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

qInstance

Constructor Summary

Constructors

Constructor	Description
ManageSessionSpecV1()

Method Summary

Modifier and Type	Method	Description
ManageSessionInput	buildInput(io.javalin.http.Context context)	build the endpoint's input object from a javalin context
List<BasicResponse>	defineAdditionalBasicResponses()
BasicOperation	defineBasicOperation()
BasicResponse	defineBasicSuccessResponse()
Map<String,Schema>	defineComponentSchemas()
RequestBody	defineRequestBody()
List<Parameter>	defineRequestParameters()
void	handleOutput(io.javalin.http.Context context, ManageSessionResponseV1 output)	Do not return the session token when its cookie is HttpOnly, whether signing in or resuming.
boolean	isSecured()
ManageSessionResponseV1	serveRequest(AbstractMiddlewareVersion abstractMiddlewareVersion, io.javalin.http.Context context)

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

ManageSessionSpecV1

public ManageSessionSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Overrides:

defineBasicOperation in class AbstractEndpointSpec<ManageSessionInput,ManageSessionResponseV1,ManageSessionExecutor>

isSecured

public boolean isSecured()

Overrides:

isSecured in class AbstractEndpointSpec<ManageSessionInput,ManageSessionResponseV1,ManageSessionExecutor>

serveRequest

public ManageSessionResponseV1 serveRequest(AbstractMiddlewareVersion abstractMiddlewareVersion,
 io.javalin.http.Context context)
                                     throws Exception

Overrides:

serveRequest in class AbstractEndpointSpec<ManageSessionInput,ManageSessionResponseV1,ManageSessionExecutor>

Throws:

Exception

handleOutput

public void handleOutput(io.javalin.http.Context context,
 ManageSessionResponseV1 output)
                  throws Exception

Do not return the session token when its cookie is HttpOnly, whether signing in or resuming. A cookie-based resume also omits it in the readable-cookie mode (QRun-IO/qqq#733).

Overrides:

handleOutput in class AbstractEndpointSpec<ManageSessionInput,ManageSessionResponseV1,ManageSessionExecutor>

Throws:

Exception

defineRequestBody

public RequestBody defineRequestBody()

Overrides:

defineRequestBody in class AbstractEndpointSpec<ManageSessionInput,ManageSessionResponseV1,ManageSessionExecutor>

defineRequestParameters

public List<Parameter> defineRequestParameters()

Overrides:

defineRequestParameters in class AbstractEndpointSpec<ManageSessionInput,ManageSessionResponseV1,ManageSessionExecutor>

buildInput

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

Description copied from class: AbstractEndpointSpec

build the endpoint's input object from a javalin context

Specified by:

buildInput in class AbstractEndpointSpec<ManageSessionInput,ManageSessionResponseV1,ManageSessionExecutor>

Throws:

Exception

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

Overrides:

defineBasicSuccessResponse in class AbstractEndpointSpec<ManageSessionInput,ManageSessionResponseV1,ManageSessionExecutor>

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<ManageSessionInput,ManageSessionResponseV1,ManageSessionExecutor>

defineAdditionalBasicResponses

public List<BasicResponse> defineAdditionalBasicResponses()

Overrides:

defineAdditionalBasicResponses in class AbstractEndpointSpec<ManageSessionInput,ManageSessionResponseV1,ManageSessionExecutor>